ATatlar
Counterparties

List counterparties

Changed on

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

get/payments/v2/counterparties

Request

Query parameters

querystring

Free text search query term for counterparty name, account identifiers and external metadata. Must be at least 3 characters.

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 counterparties.

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",
      "legalName": "Example Company GmbH",
      "partyType": "INDIVIDUAL",
      "alias": "Customer #123",
      "address": {
        "country": "DE",
        "countrySubdivision": "US-CA",
        "city": "Stockholm",
        "postalCode": "11111",
        "streetName": "Example street",
        "streetNumber": "47"
      },
      "accounts": [
        {
          "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"
        }
      ],
      "email": "john.smith@example.com",
      "phone": "+46123456789",
      "nationalIdentifier": {
        "type": "CIVIC",
        "market": "DE",
        "number": "2012121212"
      },
      "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",
      "entityIds": [
        "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
      ]
    }
  ],
  "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