v3

latestOpenAPI 3.1.02026-08-0439139122.1 KB
off-ramp

Get Bank Account

get/off-ramp/bank-accounts/{bank_account_id}

Path parameters

bank_account_idstring required

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.

Response

Bank account details

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