Retrieve Bank Balance (by id)
GET {{base_url}}/banking/v2/balances/:balanceId
This endpoint can be used to retrieve a particular bank balance by providing a balance id.
Path variables
| Field | Type | Description |
|---|
| balanceId | string | Unique identifier for balance |
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, INTERIMBOOKED, 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 balanceId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"id":"balanceId3456","bankId":7,"accountId":"accountId3579","date":"2020-10-04T00:00Z","amount":"15647.35","currency":"GBP","type":"CREDIT","status":"CLOSINGBOOKED","externalId":"","source":"OPENBANKING"}