Create a customer's bank account

Time	Status	User Agent
Retrieving recent requests…

Path Params

customer_uuid

string

required

The ID of the customer.

Body Params

account_number

string

required

The account number of the bank account. Must not be greater than 34 characters.

account_type

string

enum

required

The account type of the bank type.

Allowed:

routing_number

string

required

The routing number of the bank account. Must not be greater than 9 characters.

bank_name

string

required

The name of the bank.

bank_address

string

required

The address of the bank.

bank_city

string

required

The city of the bank.

bank_state

string

required

The state of the bank.

bank_postal_code

string

required

The postal code of the bank.

bank_country

string

required

The country of the bank. Must be 2 characters.

account_holder_name

string

required

The name of the account holder.

residential_country_code

string

enum

required

The country code of the residential address. Must be 2 characters.

Allowed:

residential_state

string

enum

required

The state of the residential address. Must be 2 characters.

residential_city

string

required

The city of the residential address.

residential_address_1

string

required

The first line of the residential address.

residential_address_2

string | null

The second line of the residential address (optional).

residential_postal_code

string

required

The postal code of the residential address.

iban

string | null

The SWIFT/BIC code of the destination bank. If the bank country (destination.bank_country) is outside of the United States, this field is required. It is used for identifying the destination bank in international wire transfers. Must not be greater than 34 characters.

swift_code

string | null

The SWIFT code of the destination bank account. Must not be greater than 11 characters.

bank_code

string | null

(off-ramp) The bank code used in countries like JP, HK, KR ..etc. Usually a 3–5 digit code identifying the bank. Must not be greater than 10 characters.

branch_code

string | null

(off-ramp) The branch code of the bank, used in conjunction with bank_code in countries like Japan. Must not be greater than 10 characters.

account_holder_kana_name

string

(off-ramp) The full name of the account holder written in full-width katakana. Required for Japan. This field is required when bank_country is JP.

Headers

X-API-KEY

string

201