Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Account Number

Activate an Account Number

Activate an Account Number.

post/v1/account_number/{account_number_id}/activate

Path parameters

account_number_idstring required

The ID of the Account Number to be activated.

Request body

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Response

Successful response

idstring

The ID of the retrieved Account Number.

account_numberstring

The account number.

routing_numberstring

The routing number.

account_idstring

The ID of the Account object.

client_customer_idstring

The ID of your customer.

entity_idstring

The ID of your entity.

status'active' | 'inactive' | 'canceled' | 'unassigned'

Account Number Status

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

created_atstring date-time

The timestamp of creation in ISO-8601 format.

updated_atstring date-time

The timestamp of last update in ISO-8601 format.

Example response

{
  "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"
    }
  }
}
All 106 operations