Sign in

v1

latestOpenAPI 3.0.32026-07-2484569553.1 KB
Accounts

Get account

Get a specific account

get/accounts/{account_id}

Path parameters

account_idstring required
Example:f1234560abf9f57287637624def390871

unique ID for an account or card

Query parameters

async'true'

When set to true, data is fetched asynchronously. Expect 202 status code

webhook_uristring uri

When async is set to true, a webhook will be POSTed to the URI provided

Headers

X-Client-Correlation-Idstring

Client-specified ID used to debug requests

X-PSU-IPstring

IP address of the end user requesting data. Necessary to overcome 4 calls per day rate limits

Response

OK

status'Succeeded' | 'Queued' | 'Running' | 'Failed'

Indicates whether the request was successful. 'Queued', 'Running' and 'Failed' can be returned for async requests

Example response

{
  "results": [
    {
      "id": "56c7b029e0f8ec5a2334fb0ffc2fface",
      "currency": "GBP",
      "account_type": "current",
      "customer_segment": "retail",
      "account_identifiers": [
        {
          "iban": "GB32CLRB04066800012315"
        }
      ],
      "bic": "MONZGB2LXXX",
      "account_holder_names": [
        "John Smith"
      ]
    }
  ],
  "status": "Succeeded"
}