Transaction files
Transaction files contain balance changes to accounts.
Please name your file as:YYYYMMDD-transaction.csve.g.20210811-transaction.csv
- Examples of balance changes which should appear in the file: payments direct to client, compensation, fees, interest, usage
- Balance changes from payments made to Ophelos should not appear in this file
- The file should contain the amount to change the balance by, not the new balance
Download the template here ↓
Data format
| Header | Required | Data Type | Format/Example | Description (if required) |
|---|---|---|---|---|
| account_number | Yes | string | abc12345 | client account reference number |
| transaction_at | Yes | timestamp | YYYY-MM-DDThh:mm:ss.sss | |
| e.g. 2021-12-31T06:10:15.123 | timestamp of the transaction | |||
| amount | Yes | decimal | -98.23 | Amount to change balance by. Positive values where the balance is increasing and negative values where the balance is decreasing (e.g. payments). |
| transaction_type | Yes | string | Payment | One of the below allowable transaction types |
| transaction_ref | Yes | string | abc12345 | A unique identifier per transaction |
| notes | No | string | Any accompanying information for this transaction |
transaction_type
| Type | Description |
|---|---|
| Payment | Payments made direct to the client |
| Usage | Balance changes due to ongoing usage |
| Credit | Good will gestures, removing fees |
| Refund | |
| Fee | |
| Interest |
Updated 5 months ago