COcoinvoyage
off-ramp

Add Bank Account

Changed on
post/off-ramp/bank-accounts

Request

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
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' | 'cop' required

Fiat currency used by Bridge bank accounts and durable bank-onramp sessions

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

Bank account type: us (ACH), iban, swift, clabe, pix, gb (Faster Payments), bre_b, or co_bank_transfer

Response

Bank account created

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

Bank account type: us (ACH), iban, swift, clabe, pix, gb (Faster Payments), bre_b, or co_bank_transfer

account_owner_type'individual' | 'business'

Whether the bank account owner is an individual or business

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

Fiat currency used by Bridge bank accounts and durable bank-onramp sessions

activeboolean required
beneficiary_address_validboolean nullable
deactivation_reasonstring nullable
deactivation_detailsstring nullable

Changes

  • 48d7266715ffRevision changes
    • warning

      added the new bre_b enum value to the response property for the response status

    • warning

      added the new co_bank_transfer enum value to the response property for the response status

    • warning

      added the new cop enum value to the response property for the response status

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      the request property ///// became optional

    • info

      the request property became optional

    • info

      added the new bre_b enum value to the request property

    • info

      added the new co_bank_transfer enum value to the request property

    • info

      added the new cop enum value to the request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status