Retrieve Bank Balances
GET {{base_url}}/banking/v2/balances
Cash balances are returned for all the bank accounts that have been connected to the company.
Balances can be queried by bankId and accountId
Query Parameters
| Field | Type | Description |
|---|
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| pageId | string | Page offset of results |
| from | dateTime | Returns balances posted on or after from date |
| to | dateTime | Returns balances posted on or before to date |
| status | string | Balance status {CLOSINGAVAILABLE, CLOSINGBOOKED, EXPECTED, FORWARDAVAILABLE, INFORMATION, INTERIMAVAILABLE, NTERIMBOOKED, OPENINGAVAILABLE, OPENINGBOOKED, PREVIOUSLYCLOSEDBOOKED} |
Attributes
| Field | Type | Description |
|---|
| id | string | Balance Id |
| accountId | string | Unique identifier for the account |
| bankId | integer | Unique identifier for the bank |
| currency | string | Account currency |
| date | datetime | Balance date |
| amount | integer | Balance amount |
| type | string | Transaction type {DEBIT,CREDIT} |
| status | string | Balance status {CLOSINGAVAILABLE, CLOSINGBOOKED, EXPECTED, FORWARDAVAILABLE, INFORMATION, INTERIMAVAILABLE, NTERIMBOOKED, OPENINGAVAILABLE, OPENINGBOOKED, PREVIOUSLYCLOSEDBOOKED} |
| externalId | string | An Id linked to an external source |
| source | string | Source of data import {MANUALIMPORT, OPENBANKING} |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid accountId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset of results |
| | | |
from | null | | Returns balances posted on or after "from" date |
to | null | | Returns balances posted on or before "to" date |
bankId | null | | Unique identifier for the bank |
accountId | null | | Unique identifier for the bank account |
status | null | | Status of the balance |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"results":[{"id":"balanceId1234","bankId":6,"accountId":"accountId1357","date":"2020-10-05T00:00Z","amount":"11477.35","currency":"GBP","type":"CREDIT","status":"INTERIMBOOKED","externalId":"","source":"OPENBANKING"},{"id":"balanceId3456","bankId":7,"accountId":"accountId3579","date":"2020-10-04T00:00Z","amount":"15647.35","currency":"GBP","type":"CREDIT","status":"CLOSINGBOOKED","externalId":"","source":"OPENBANKING"},{"id":"balanceId9876","bankId":809,"accountId":"accountId0087","date":"2020-10-03T00:00Z","amount":"1477.35","currency":"GBP","type":"CREDIT","status":"CLOSINGBOOKED","externalId":"","source":"MANUALIMPORT"}],"links":{}}