Retrieve Bank Account (by id)
GET {{base_url}}/banking/v2/accounts/:accountId
This endpoint can be used to retrieve a particular bank account using an account id.
Path variables
| Field | Type | Description |
|---|
| accountId | string | Unique identifier for the account |
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 accountId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
Authorization | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"id":"accountId1234","bankId":6,"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"}