Skip to main content
POST
/
v1
/
account_number
Create an Account Number
curl --request POST \
  --url https://api.sandbox.lead.bank/v1/account_number \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "account_xyz123",
  "client_customer_id": "<your_customer_id>",
  "entity_id": "entity_xyz123",
  "ach_controls": {
    "originator_id": "originator_xyz123",
    "incoming": {
      "accept_credit": true,
      "accept_debit": true,
      "counterparty_filter": "accept_all",
      "counterparty_company_ids_allowlist": [
        1234567890
      ]
    },
    "outgoing": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": [
        {
          "type": "us_domestic",
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    }
  },
  "wire_controls": {
    "incoming": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": [
        {
          "type": "us_domestic",
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    },
    "outgoing": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": [
        {
          "type": "us_domestic",
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    },
    "outgoing_international": {
      "counterparty_filter": "accept_all",
      "counterparty_international_account_numbers_allowlist": [
        {
          "business_identifier_code": "CHASUS33",
          "account_identifier": {
            "type": "IBAN",
            "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",
      "counterparty_account_numbers_allowlist": [
        {
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    },
    "outgoing": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": [
        {
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    }
  },
  "metadata": {}
}
'
{
  "id": "account_number_xyz",
  "account_number": 123412341234,
  "routing_number": 123456789,
  "account_id": "account_xyz123",
  "client_customer_id": "<your_customer_id>",
  "entity_id": "entity_xyz123",
  "status": "active",
  "ach_controls": {
    "originator_id": "originator_xyz123",
    "incoming": {
      "accept_credit": true,
      "accept_debit": true,
      "counterparty_filter": "accept_all",
      "counterparty_company_ids_allowlist": [
        1234567890
      ]
    },
    "outgoing": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": [
        {
          "type": "us_domestic",
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    }
  },
  "wire_controls": {
    "incoming": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": [
        {
          "type": "us_domestic",
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    },
    "outgoing": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": [
        {
          "type": "us_domestic",
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    },
    "outgoing_international": {
      "counterparty_filter": "accept_all",
      "counterparty_international_account_numbers_allowlist": [
        {
          "business_identifier_code": "CHASUS33",
          "account_identifier": {
            "type": "IBAN",
            "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",
      "counterparty_account_numbers_allowlist": [
        {
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    },
    "outgoing": {
      "counterparty_filter": "accept_all",
      "counterparty_account_numbers_allowlist": [
        {
          "account_number": 123412341234,
          "routing_number": 123412341234
        }
      ]
    }
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Idempotency key

Maximum string length: 255

Body

application/json
​
account_id
string
required

The ID of the Account object.

Pattern: ^account_\w+$
Example:

"account_xyz123"

​
client_customer_id
string

The ID of your customer.

Maximum string length: 64
Example:

"<your_customer_id>"

​
entity_id
string

The ID of your entity.

Pattern: ^entity_[^\s]{1,33}$
Example:

"entity_xyz123"

​
ach_controls
object

ACH payment controls

​
wire_controls
object

Wire payment controls

​
internal_transfer_controls
object

Internal Transfer controls

​
instant_payment_controls
object

Instant Payment controls

​
metadata
object

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

Response

Successful response

​
id
string

The ID of the retrieved Account Number.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz"

​
account_number
string

The account number.

Example:

123412341234

​
routing_number
string

The routing number.

Example:

123456789

​
account_id
string

The ID of the Account object.

Pattern: ^account_\w+$
Example:

"account_xyz123"

​
client_customer_id
string

The ID of your customer.

Maximum string length: 64
Example:

"<your_customer_id>"

​
entity_id
string

The ID of your entity.

Pattern: ^entity_[^\s]{1,33}$
Example:

"entity_xyz123"

​
status
enum<string>

Account Number Status

Available options:
active,
inactive,
canceled,
unassigned
Example:

"active"

​
ach_controls
object

ACH payment controls

​
wire_controls
object

Wire payment controls

​
internal_transfer_controls
object

Internal Transfer controls

​
instant_payment_controls
object

Instant Payment controls

​
metadata
object

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

​
created_at
string<date-time>

The timestamp of creation in ISO-8601 format.

​
updated_at
string<date-time>

The timestamp of last update in ISO-8601 format.