POST
/
api
/
bank
/
accounts

Requirements to consume the endpoint.

Create and modify role

The user must have the role to create and modify.

User approved

The user must be approved in at least one country.

Authorizations

x-api-key
string
header
required

Body

application/json
accountHolderName
string
required

Name of the account holder.

bankName
string
required

Name of the bank.

country
enum<string>
required

Country in which the bank account is to be created.

Available options:
MX,
PE,
US
fiat
enum<string>
required

Fiat currency of the bank account.

Available options:
USD,
MXN,
PEN
accountNumber
string

Number of the bank account.

address
object

Only required for US bank accounts. Address of the bank account.

CCI
string

The CCI (Interbank Account Code) is a unique 20-digit number used to identify a specific bank account in the Peruvian financial system.

CLABE
string

Which is a 18-digit code used to identify specific bank accounts in the Mexican banking system.

notes
string

Notes related to the bank account.

routingNumber
string

Only for US bank accounts. The routing number of the account.

userId
string

Id of the user to whom the bank account is to be assigned.

Response

201 - application/json
accountHolderName
string

Name of the account holder.

accountNumber
string

Number of the bank account.

approved
boolean

Indicates if the bank account has been approved.

bankName
string

Name of the bank.

CLABE
string

The Standardized Bank Code (CLABE) associated with the bank account, used in Mexico.

country
enum<string>

Country of the bank.

Available options:
MX,
PE,
US
createdAt
string

Creation date and time of the bank account.

fiat
enum<string>

Fiat currency of the bank account.

Available options:
USD,
MXN,
PEN
id
string

Id of the created bank account.

notes
string

Notes about the bank account.

swiftCode
string

The SWIFT/BIC code associated with the bank account, used for international wire transfers.

userId
string

Id of the user who created the bank account.