POST
/
api
/
bank
/
accounts
curl --request POST \
  --url https://app.sandbox.rio.trade/api/bank/accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "userId": "66290ac8bd3903485989f82e",
  "country": "MX",
  "fiat": "USD",
  "bankName": "Bank Name",
  "accountHolderName": "Account Holder Name",
  "accountNumber": "0123456789",
  "routingNumber": "123456789",
  "notes": "Notes",
  "CCI": "00111233001112345678",
  "CLABE": "012345678901234567",
  "email": "<string>",
  "address": {
    "street1": "Street Name",
    "street2": "Street Name",
    "city": "City Name",
    "state": "State Name",
    "postalCode": "12345",
    "country": "MX"
  }
}'
{
  "userId": "66562bc04fe8bf83c577c178",
  "createdAt": "2024-05-31T13:55:11.452Z",
  "bankName": "BANAMEX",
  "country": "MX",
  "accountHolderName": "Account holder name",
  "fiat": "USD",
  "accountNumber": "0123456789",
  "CLABE": "0023764000000012345",
  "CCI": "00111233001112345678",
  "approved": true,
  "notes": "Bank Account",
  "email": "<string>",
  "id": "6659d6bfd78151f639e74d53"
}

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
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
bankName
string
required

Name of the bank.

Example:

"Bank Name"

accountHolderName
string
required

Name of the account holder.

Example:

"Account Holder Name"

userId
string

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

Example:

"66290ac8bd3903485989f82e"

accountNumber
string

Number of the bank account.

Example:

"0123456789"

routingNumber
string

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

Example:

"123456789"

notes
string

Notes related to the bank account.

Example:

"Notes"

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.

Example:

"00111233001112345678"

CLABE
string

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

Example:

"012345678901234567"

email
string

Only necessary if the bank account is NVIO bank account for Bitso transfer.

address
object

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

Response

201 - application/json
Created
userId
string

Id of the user who created the bank account.

Example:

"66562bc04fe8bf83c577c178"

createdAt
string

Creation date and time of the bank account.

Example:

"2024-05-31T13:55:11.452Z"

bankName
string

Name of the bank.

Example:

"BANAMEX"

country
enum<string>

Country of the bank.

Available options:
MX,
PE,
US
accountHolderName
string

Name of the account holder.

Example:

"Account holder name"

fiat
enum<string>

Fiat currency of the bank account.

Available options:
USD,
MXN,
PEN
accountNumber
string

Number of the bank account.

Example:

"0123456789"

CLABE
string

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

Example:

"0023764000000012345"

CCI
string

Only for bank accounts in Peru.

Example:

"00111233001112345678"

approved
boolean

Indicates if the bank account has been approved.

Example:

true

notes
string

Notes about the bank account.

Example:

"Bank Account"

email
string

Only if the bank account is NVIO bank account.

id
string

Id of the bank account.

Example:

"6659d6bfd78151f639e74d53"