ATatlar
Accounts

List accounts

Changed on

Returns a list of accounts. For further details on Pagination, see general section above.

get/financial-data/v2/accounts

Request

Query parameters

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

statusAccountStatus[]

Include only accounts with a given status.

[
  "OPEN"
]

Response

List of accounts.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "thirdPartyId": "0a951c88-3313-472a-b312-ca2e47769670",
      "affiliationId": "b9a931ce-9606-495d-95b0-8da8251c008a",
      "entityId": "b130e3d7-f67c-4a10-b359-25ad88c4999b",
      "market": "DE",
      "currency": "EUR",
      "name": "My Business Account",
      "alias": "My Business Account",
      "identifiers": [
        {
          "type": "IBAN",
          "market": "DE",
          "number": "DE75512108001245126199"
        }
      ],
      "routing": [
        {
          "type": "BIC",
          "number": "BUKBGB22"
        }
      ],
      "status": "OPEN",
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "paymentOptions": {
        "instruments": [
          {
            "type": "CITI_WORLDLINK",
            "citiWorldlinkId": "123456789"
          }
        ]
      },
      "version": 1,
      "etag": "version:3",
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}

Changes

  • b49df1e4b3e9Revision changes
    • warning

      added the new BD_BRN enum value to the ///// response property for the response status

    • warning

      added the new CZ_NBC enum value to the ///// response property for the response status

    • warning

      added the new MY_JOMPAY_BILLER_CODE enum value to the ///// response property for the response status

    • warning

      added the new MY_JOMPAY_BILLER_CODE enum value to the ////// response property for the response status

    • warning

      added the new PH_BRSTN enum value to the ///// response property for the response status

    • warning

      added the new WALLET_AIRWALLEX_NUMBER enum value to the ///// response property for the response status

    • warning

      added the new WALLET_AIRWALLEX_NUMBER enum value to the ////// response property for the response status

    • warning

      added the new WALLET_UNIT enum value to the ///// response property for the response status

    • warning

      added the new WALLET_UNIT enum value to the ////// response property for the response status

    • info

      added the optional property // to the response with the status