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
Field | Type | Description |
---|
accountId | string | Unique identifier for the account |
bankId | integer | Unique identifier for the bank |
bookingDate | datetime | Booking date for the transaction |
valueDate | datetime | Value date for the transaction |
transactionCode | string | Specifies the transaction family within a domain |
transactionSubCode | string | Sub code of the transaction |
proprietaryCode | string | Proprietary bank transaction code to identify the underlying transaction |
proprietarySubCode | string | Proprietary sub code of the transaction |
reference | string | Transaction reference |
description | string | Description provided in the transaction |
currency | string | Transaction currency |
amount | integer | Transaction amount |
type | string | Transaction type {DEBIT,CREDIT} |
status | string | Transaction status {BOOKED,PENDING} |
merchant->name | string | Name of the merchant |
externalId | string | An Id linked to an external source |
Error Messages
Condition | Response Status | Response Body |
---|
Missing/Invalid bankId | 400 Bad Request | {error : Missing/Invalid bankId } |
Missing/Invalid accountId | 400 Bad Request | {error : Missing/Invalid accountId } |
Invalid currency | 400 Bad Request | {error : Missing/Invalid currency } |
Invalid amount | 400 Bad Request | {error : Missing/Invalid amount } |
Invalid status | 400 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 transactions | 413 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"}}]}
Key | Datatype | Required | Description |
---|
Content-Type | string | | |
Authorization | string | | |
X-Partner-Id | string | | |
X-Api-Key | string | | |
X-Company-Id | string | | |