Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Data v2.Account
REGION.US

List Accounts

Returns a list of accounts for a user.

get/data/v2/accounts

Query parameters

pageSizestring int64

The maximum number of items to return. This endpoint will not return more than 100 accounts per page.

pageTokenstring

The next_page_token value returned from a previous List request, if any.

idInstring[]

If set, only the account with the given id will be returned. This parameter may be repeated to specify multiple account ids.

typesInstring[]

If set, only accounts with the given account types will be returned. This parameter may be repeated to specify multiple account types.

  • UNDEFINED: Not used.
  • CHECKING: Checking account.
  • SAVINGS: Savings account.
  • CREDIT_CARD: Credit card account.

Response

A successful response.

nextPageTokenstring

Token to retrieve the next page of results, or empty if there are no more results in the list.

Example response

{
  "accounts": [
    {
      "balances": {
        "booked": {
          "amount": {
            "currencyCode": "EUR",
            "value": {
              "scale": "-3",
              "unscaledValue": "19"
            }
          }
        }
      },
      "dates": {
        "lastRefreshed": "2020-12-15T12:16:58Z"
      },
      "financialInstitutionId": "6e68cc6287704273984567b3300c5822",
      "id": "ee7ddbd178494220bb184791783f4f63",
      "identifiers": {
        "financialInstitution": {
          "accountNumber": "SE6930000000011273547693"
        },
        "iban": {
          "bban": "0000011273547693",
          "iban": "SE6930000000011273547693"
        },
        "pan": {
          "masked": "4000 12** **** 9010"
        }
      },
      "name": "PERSONKONTO",
      "type": "CHECKING"
    }
  ]
}