Sign in

v1

latestOpenAPI 3.1.02026-07-1325128129.5 KB
off-ramping

Add Bank Account

Create an external bank account for the authenticated organization's verified Bridge customer

post/bank-accounts

Headers

Authorization-Signaturestring required

Authorization header format: 'APIKey=<api_key>,signature=<signature>,timestamp=<unix_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 successfully

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