v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Counterparties

List counterparties

List and filter counterparties.

get/counterparties

Query parameters

limitinteger

starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the counterparty.

end_datestring date

The creation date of the counterparty.

namestring

The name of the counterparty.

disabledboolean

If true, only disabled counterparties will be fetched.

counterparty_account_idstring uuid

The ID of the related counterparty account.

virtual_account_idstring uuid

The ID of the related virtual account.

Response

200

Example response

{
  "records": [
    {
      "name": "MyCounterparty",
      "object": "counterparty",
      "counterparty_accounts": [
        {
          "holder_name": "Joe Black",
          "account_number": "FR1420041010050500013M02606",
          "bank_code": "BNPAFRPPXXX",
          "holder_address": {
            "line_1": "1, rue de la Bourse",
            "building_number": "1",
            "street_name": "rue de la Bourse",
            "postal_code": "59000",
            "city": "Lille",
            "country": "FR"
          }
        }
      ],
      "metadata": {
        "property_a": true,
        "property_b": "some text"
      }
    }
  ]
}