Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Counterparty Accounts

List counterparty accounts

List and filter counterparty accounts.

get/counterparty_accounts

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

end_datestring date

The creation date of the counterparty account.

holder_namestring

The holder name of the counterparty account.

account_numberstring

The account number of the counterparty account.

countrystring

The country of the counterparty account.

status'pending_approval' | 'approved' | 'denied' | 'disabled'

The status of this counterparty account.

The status of the counterparty account.

Response

200

Example response

{
  "records": [
    {
      "object": "counterparty_account",
      "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"
      },
      "account_verification": {
        "result": "valid",
        "valid_account_number": {
          "result": "valid",
          "details": {
            "reason": "unauthorized_characters",
            "expected_value": "SOMEBIC0XXX",
            "message": "IBAN contains unauthorized characters"
          }
        },
        "matching_account_number_and_bank_code": {
          "result": "valid",
          "details": {
            "reason": "unauthorized_characters",
            "expected_value": "SOMEBIC0XXX",
            "message": "IBAN contains unauthorized characters"
          }
        },
        "matching_account_holder": {
          "result": "valid",
          "details": {
            "reason": "unauthorized_characters",
            "expected_value": "SOMEBIC0XXX",
            "message": "IBAN contains unauthorized characters"
          }
        },
        "active_account": {
          "result": "valid",
          "details": {
            "reason": "unauthorized_characters",
            "expected_value": "SOMEBIC0XXX",
            "message": "IBAN contains unauthorized characters"
          }
        }
      },
      "metadata": {
        "property_a": true,
        "property_b": "some text"
      }
    }
  ]
}