Transaction files

Transaction files contain balance changes to accounts.

❗️

Please name your file as: YYYYMMDD-transaction.csv e.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 ↓

YYYYMMDD-transaction.csv

Data format

HeaderRequiredData TypeFormat/ExampleDescription (if required)
account_numberYesstringabc12345client account reference number
transaction_atYestimestampYYYY-MM-DDThh:mm:ss.sss
e.g. 2021-12-31T06:10:15.123timestamp of the transaction
amountYesdecimal-98.23Amount to change balance by. Positive values where the balance is increasing and negative values where the balance is decreasing (e.g. payments).
transaction_typeYesstringPaymentOne of the below allowable transaction types
transaction_refYesstringabc12345A unique identifier per transaction
notesNostringAny accompanying information for this transaction

transaction_type

TypeDescription
PaymentPayments made direct to the client
UsageBalance changes due to ongoing usage
CreditGood will gestures, removing fees
Refund
Fee
Interest