Retrieve Banks
GET {{base_url}}/banking/v2/banks
Retrieve a list of all available banks with their corresponding bank ids and logos. Bank id is required to create an auth for a bank, or to retrieve accounts, balances, and transactions for a particular bank.
Attributes
| Field | Type | Description |
|---|
| id | integer | Unique identifier for the bank |
| name | string | Name of the bank |
| logo | string (link for logo in svg format) | Link with bank's logo |
| pngLogo | string | Bank logo URL |
| rdfName | string | Bank name |
| aisStatus | object | Status of Account information services (i.e. downloading accounts, balances, transactions etc.) consent |
| aisStatus->status | string | status {Up, Down} |
| aisStatus->lastTested | DateTime | Last time when AIS connection was tested |
| aisStatus->lastSuccessful | DateTime | Last time when AIS connection was successful |
| pisStatus | object | Status of Payment information services consent |
| pisStatus->status | string | status {Up, Down} |
| pisStatus->lastTested | DateTime | Last time when PIS connection was tested |
| pisStatus->lastSuccessful | DateTime | Last time when PIS connection was successful |
Query Parameters
| Field | Type | Description |
|---|
| pageId | string | Page offset of results |
| type | string | {Account, Payment} |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset of results |
| | | |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
RESPONSES
status: OK
{"results":[{"id":31,"name":"Monzo","logo":"bank logo","pnglogo":"https://bank-logos.tomatopay.co.uk/icon_Monzo.png","rdfName":"MONZO","aisStatus":{"status":"Up","lastTested":"2021-04-12T08:39:15.590Z","lastSuccessful":"2021-04-12T08:39:15.590Z"},"pisStatus":{"status":"Up","lastTested":"2021-04-12T09:06:10.868Z","lastSuccessful":"2021-04-12T09:06:13.983Z"}},{"id":7,"name":"Natwest","logo":"bank logo","pnglogo":"https://bank-logos.tomatopay.co.uk/icon_Natwest.png","rdfName":"Natwest","aisStatus":{"status":"Up","lastTested":"2021-04-12T08:39:15.590Z","lastSuccessful":"2021-04-12T08:39:15.590Z"},"pisStatus":{"status":"Up","lastTested":"2021-04-12T09:06:10.868Z","lastSuccessful":"2021-04-12T09:06:13.983Z"}}],"links":{}}