Create a new bank account

Creates a new bank account for the specified merchant. Supports both fiat and crypto accounts with appropriate validation.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

merchantIdstringRequired
Merchant ID
organizationIdstringRequired
Organization ID

Headers

x-admin-api-keystringRequired

Request

This endpoint expects an object.
namestringRequired
kindenumRequired
Allowed values:
addressstringRequired
networkenumRequired

Blockchain network. Required for crypto accounts (kind=CRYPTO).

accountNumberstringRequired
routingNumberstringRequired
isDefaultbooleanRequired
currencySymbolenumRequired
entitystringOptional

Bank entity code. Optional for AR, MX, PE, BO, BR, US (auto-deduced). Required for CL, CO.

isVirtualbooleanOptional
Whether this is a virtual account. Optional for all account types. Defaults to false if not provided.
typeenumOptional

Account type (SAVINGS, CHECKING, VIRTUAL). Optional for all account types. Defaults to VIRTUAL if not provided.

Allowed values:
isTrackedbooleanOptional
Whether this account is tracked for balance monitoring. Optional for all account types. Defaults to false if not provided.
countrySymbolenumOptional

Country code. Required for fiat accounts (kind=BANK), optional/ignored for crypto accounts (kind=CRYPTO).

Response

idstring
namestring
entitystring
kindenum
Allowed values:
isVirtualboolean
addressstring
networkstring
typeenum
Allowed values:
accountNumberstring
routingNumberstring
countryIdstring
currencyIdstring
currencyCodestring
Currency symbol
createdAtdatetime
updatedAtdatetime
isDefaultboolean
isTrackedboolean
merchantIdstring
contactIdstring
countryCodestring or null

Two-letter ISO country code

Errors