v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

External Accounts

List external accounts

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

get/payments/v2/external-accounts

Query parameters

querystring

Free text search of external account identifiers.

counterpartyIdstring

The ID of a counterparty.

entityIdsInstring[]

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.

Response

List of external 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",
      "counterpartyId": "c151b61e-33cc-4f89-ac8d-328f9efa59e9",
      "entityIds": [
        "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
      ],
      "market": "DE",
      "name": "My Business Account",
      "alias": "My Business Account",
      "identifiers": [
        {
          "type": "IBAN",
          "market": "DE",
          "number": "DE75512108001245126199"
        }
      ],
      "routing": [
        {
          "type": "BIC",
          "number": "BUKBGB22"
        }
      ],
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z",
      "version": 1,
      "etag": "version:3"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}