v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Faster Payments

List all accounts

Use the GET accounts endpoint to retrieve all accounts associated with my organisation.

get/accounts

Query parameters

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

Response

List of accounts.

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "mid": "4ebc5489-7b9f-4324-983e-07d4b2b00035",
      "account_reference": "Main Account",
      "account_detail": {
        "account_name": "Mr E Johnson",
        "sort_code": "123456",
        "account_number": "87654321",
        "iban": "GB29 NWBK 6016 1331 9268 19",
        "bic": "HBUKGB4B",
        "currency": "gbp"
      },
      "account_status": "active"
    }
  ]
}