Skip to main content
POST
Add Bank Account

Authorizations

Authorization
string
header
required

HMAC-SHA256 signature. See the Authorization-Signature header parameter on signed operations.

Headers

Authorization-Signature
string
required

HMAC-SHA256 signature header: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'. The signature is computed over METHOD + path (with the /v3 prefix stripped) + timestamp.

Body

application/json
account_owner_name
string
required
address
object
required
bank_name
string
required
currency
enum<string>
required

Currency used by the external bank account

Available options:
usd,
eur,
mxn,
brl,
gbp
account_type
enum<string>
required

Bank account rail: us (ACH), iban, swift, clabe, pix, or gb (FPS)

Available options:
us,
iban,
swift,
clabe,
pix,
gb
account_name
string
account_owner_type
enum<string>

Whether the bank account owner is an individual or business

Available options:
individual,
business
first_name
string
last_name
string
business_name
string
account
object | null
iban
object | null
swift
object | null
clabe
object | null
pix
object | null

Response

Bank account created

id
string
required
account_type
enum<string>
required

Bank account rail: us (ACH), iban, swift, clabe, pix, or gb (FPS)

Available options:
us,
iban,
swift,
clabe,
pix,
gb
account_details
object
required
currency
enum<string>
required

Currency used by the external bank account

Available options:
usd,
eur,
mxn,
brl,
gbp
active
boolean
required
account_name
string | null
bank_name
string | null
account_owner_type
enum<string> | null

Whether the bank account owner is an individual or business

Available options:
individual,
business
beneficiary_address_valid
boolean | null
deactivation_reason
string | null
deactivation_details
string | null