v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB

Account Number

List all Account Numbers

List all Account Numbers.

get/v1/account_number

Query parameters

account_idstring

The ID of the account.

account_numberstring

The account number.

limitinteger

Maximum number of objects to be returned.

starting_afterstring

The ID of the account number to start the list after.

ending_beforestring

The ID of the account number to end the list before.

Response

List of Account Numbers

has_moreboolean required

Indicates if there are more account numbers to retrieve.

Example response

{
  "objects": [
    {
      "id": "account_number_xyz",
      "account_id": "account_xyz123",
      "client_customer_id": "<your_customer_id>",
      "entity_id": "entity_xyz123",
      "status": "active",
      "ach_controls": {
        "originator_id": "originator_xyz123",
        "incoming": {
          "counterparty_filter": "accept_all"
        },
        "outgoing": {
          "counterparty_filter": "accept_all"
        }
      },
      "wire_controls": {
        "incoming": {
          "counterparty_filter": "accept_all"
        },
        "outgoing": {
          "counterparty_filter": "accept_all"
        },
        "outgoing_international": {
          "counterparty_filter": "accept_all",
          "counterparty_international_account_numbers_allowlist": [
            {
              "business_identifier_code": "CHASUS33",
              "account_identifier": {
                "value": "GB29NWBK60161331926819"
              }
            }
          ]
        }
      },
      "internal_transfer_controls": {
        "incoming": {
          "counterparty_filter": "accept_all",
          "counterparty_account_number_ids_allowlist": [
            "account_number_xyz123"
          ]
        },
        "outgoing": {
          "counterparty_filter": "accept_all",
          "counterparty_account_number_ids_allowlist": [
            "account_number_xyz123"
          ]
        }
      },
      "instant_payment_controls": {
        "incoming": {
          "counterparty_filter": "accept_all"
        },
        "outgoing": {
          "counterparty_filter": "accept_all"
        }
      }
    }
  ]
}