Add Bank Balances
POST {{base_url}}/banking/v2/balances
The 'Add bank balances' endpoint can be used to add balances to accounts that were 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 |
| currency | string | Account currency |
| date | datetime | Balance data |
| amount | integer | Balance amount |
| type | string | Transaction type {DEBIT,CREDIT} |
| status | string | Balance status {CLOSINGAVAILABLE, CLOSINGBOOKED, EXPECTED, FORWARDAVAILABLE, INFORMATION, INTERIMAVAILABLE, INTERIMBOOKED, OPENINGAVAILABLE, OPENINGBOOKED, PREVIOUSLYCLOSEDBOOKED} |
| 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 } |
| Missing/Invalid currency | 400 Bad Request | {error : Missing/Invalid currency } |
| Missing/Invalid amount | 400 Bad Request | {error : Missing/Invalid amount } |
| Missing/Invalid status | 400 Bad Request | {error : Missing/Invalid status } |
| Missing/Invalid type (DEBIT/CREDIT) | 400 Bad Request | {error : Missing/Invalid type } |
| Missing/Invalid date (ISO 8601 format) | 400 Bad Request | {error : Missing/Invalid bookingDate } |
| Adding more than 500 balances | 413 Payload too large | |
Request Body
{"values"=>[{"bankId"=>6, "accountId"=>"accountId1234", "date"=>"2020-08-31", "amount"=>"100.00", "currency"=>"GBP", "type"=>"DEBIT", "status"=>"INTERIMAVAILABLE"}]}
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |