Sign in

v3

latestOpenAPI 3.1.02026-08-0439139122.1 KB
off-ramp

Add Bank Account

post/off-ramp/bank-accounts

Headers

Authorization-Signaturestring required

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

Request body

account_namestring
account_owner_namestring required
bank_namestring required
account_owner_type'individual' | 'business'

Whether the bank account owner is an individual or business

first_namestring
last_namestring
business_namestring
currency'usd' | 'eur' | 'mxn' | 'brl' | 'gbp' required

Currency used by the external bank account

account_type'us' | 'iban' | 'swift' | 'clabe' | 'pix' | 'gb' required

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

Response

Bank account created

idstring required
account_namestring nullable
bank_namestring nullable
account_type'us' | 'iban' | 'swift' | 'clabe' | 'pix' | 'gb' required

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

account_owner_type'individual' | 'business'

Whether the bank account owner is an individual or business

currency'usd' | 'eur' | 'mxn' | 'brl' | 'gbp' required

Currency used by the external bank account

activeboolean required
beneficiary_address_validboolean nullable
deactivation_reasonstring nullable
deactivation_detailsstring nullable