Sign in

v1

latestSwagger 2.02026-08-047766481.4 KB
accounts

Retrieve all accounts for a user without additional data

Requires accounts:read scope. Optional scope accounts_details:read is needed for some extra fields such as account number and sort code. By default this endpoint does not return transaction data (when this isn't returned response times are quicker than the GET /accounts endpoint). Please note: field additionalBalances is currently in beta

get/accounts-list

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

showTransactionDataboolean

Return transaction data for the account when available

showPerformanceScoreboolean

Return performance score for the account when available

connectionIdstring

Filter accounts by their connectionId

Response

Successful Accounts Response

metaobject

Example response

{
  "data": [
    {
      "id": "d372d09b-f50a-4114-9c83-687828fa8ac2",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "Joint Account",
      "type": "cash:current",
      "providerName": "Lloyds",
      "providerId": "DEMO",
      "providerReference": "demo",
      "connectionId": "1ffe704d39629a929c8e293880fb449a:c1ef4ce6-c1d6-4900-9288-228fb21f5dc4",
      "accountHolderName": "Robert Cantu",
      "balance": {
        "date": "2020-07-27",
        "amount": {
          "value": 802323,
          "currency": "GBP"
        }
      },
      "currency": "GBP",
      "details": {
        "AER": 0,
        "overdraftLimit": 0,
        "sortCodeAccountNumber": "30949301273345"
      },
      "additionalBalances": [
        {
          "date": "2020-07-27",
          "amount": {
            "value": 1000,
            "currency": "GBP"
          },
          "type": "InterimAvailable"
        }
      ]
    },
    {
      "id": "3cc555e4-d954-4eb1-a1df-90df15b132a9",
      "dateAdded": "2020-07-27T14:33:44+00:00",
      "dateModified": "2020-07-27T14:33:44+00:00",
      "accountName": "Current Account",
      "type": "cash:current",
      "providerName": "Lloyds",
      "providerId": "DEMO",
      "providerReference": "demo",
      "connectionId": "1ffe704d39629a929c8e293880fb449a:c1ef4ce6-c1d6-4900-9288-228fb21f5dc4",
      "accountHolderName": "Robert Cantu",
      "balance": {
        "date": "2020-07-11",
        "amount": {
          "value": 216258,
          "currency": "GBP"
        }
      },
      "currency": "GBP",
      "details": {
        "AER": 0,
        "overdraftLimit": 0,
        "sortCodeAccountNumber": "30949301273801"
      },
      "additionalBalances": [
        {
          "date": "2020-07-27",
          "amount": {
            "value": 1000,
            "currency": "GBP"
          },
          "type": "InterimAvailable"
        }
      ]
    }
  ]
}