Retrieve Bank Accounts
GET {{base_url}}/banking/v2/accounts
This endpoint can be used to retrieve bank accounts for a business (using the bank id). The endpoint will return all the banks that a business has connected.
Bank Accounts can be filtered by providing a bankId
April 2021: Updated this endpoint and added consentId to the response
Query Parameters
| Field | Type | Description |
|---|---|---|
| bankId | integer | Unique identifier for the bank |
| pageId | string | Page offset of results |
Attributes
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the account |
| bankId | integer | Unique identifier for the bank |
| consentId | string | Unique identifier for the consent |
| currency | string | Account currency |
| nickname | string | Nickname |
| account | JSON object | Account information |
| account -> schemename | string | IBAN or Account and sort code |
| account -> identification | string | Unique id per bank account |
| account -> name | string | Account name |
| account -> secondaryIdentification | string | Any optional extra information about account |
| 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 partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | { error: "Missing/Invalid pageId” } |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageId | null | Page offset of results | |
bankId | null | Unique identifier for the bank |
HEADERS
| 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":"accountId1234","consentId":"consentId5324","bankId":6,"currency":"GBP","nickname":"Business Account","account":[{"schemeName":"IBAN","identification":"GBBANKIDEN1234","name":"Debit Account","secondaryIdentification":"Merrchant"}],"externalId":"extenalid123","source":"MANUALIMPORT"},{"id":"accountId5678","consentId":"consentId1324","currency":"GBP","nickname":"Debit Account - NatWest - Demo","account":[{"schemeName":"UK.OBIE.SortCodeAccountNumber","identification":"5000004001234","name":"Debit Account - NatWest - Demo","secondaryIdentification":""}],"externalId":"","source":"OPENBANKING"}],"links":{}}