Add Bank Transactions

POST {{base_url}}/banking/v2/transactions

The ‘Add bank transactions’ endpoint can be used to add transactions to accounts that are added using the ‘Add bank accounts’ endpoint.

Attributes

FieldTypeDescription
accountIdstringUnique identifier for the account
bankIdintegerUnique identifier for the bank
bookingDatedatetimeBooking date for the transaction
valueDatedatetimeValue date for the transaction
transactionCodestringSpecifies the transaction family within a domain
transactionSubCodestringSub code of the transaction
proprietaryCodestringProprietary bank transaction code to identify the underlying transaction
proprietarySubCodestringProprietary sub code of the transaction
referencestringTransaction reference
descriptionstringDescription provided in the transaction
currencystringTransaction currency
amountintegerTransaction amount
typestringTransaction type {DEBIT,CREDIT}
statusstringTransaction status {BOOKED,PENDING}
merchant->namestringName of the merchant
externalIdstringAn Id linked to an external source

Error Messages

ConditionResponse StatusResponse Body
Missing/Invalid bankId400 Bad Request{error: Missing/Invalid bankId}
Missing/Invalid accountId400 Bad Request{error: Missing/Invalid accountId}
Invalid currency400 Bad Request{error: Missing/Invalid currency}
Invalid amount400 Bad Request{error: Missing/Invalid amount}
Invalid status400 Bad Request{error: Missing/Invalid status}
Invalid type (DEBIT/CREDIT)400 Bad Request{error: Missing/Invalid type}
Invalid bookingDate (ISO 8601 format)400 Bad Request{error: Missing/Invalid bookingDate}
Invalid valueDate (ISO 8601 format)400 Bad Request{error: Missing/Invalid valueDate}
Adding more than 500 transactions413 Payload too large

Request Body

{"values"=>[{"bankId"=>6, "accountId"=>"accountId1234", "bookingDate"=>"2020-09-01", "valueDate"=>"2020-09-01", "amount"=>1400, "currency"=>"GBP", "type"=>"DEBIT", "status"=>"BOOKED", "merchant"=>{"name"=>"Big suppliers Ltd.", "categoryCode"=>"12345", "addressLine"=>"12345"}}, {"bankId"=>7, "accountId"=>"accountId3456", "bookingDate"=>"2020-01-01", "valueDate"=>"2020-01-01", "amount"=>100.5, "currency"=>"GBP", "type"=>"CREDIT", "status"=>"BOOKED", "merchant"=>{"name"=>"Invoice - Customer 102", "categoryCode"=>"", "addressLine"=>"2345"}}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring
X-Partner-Idstring
X-Api-Keystring
X-Company-Idstring