PATCH
/
api
/
bank
/
accounts
/
{id}
curl --request PATCH \
  --url https://app.sandbox.rio.trade/api/bank/accounts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "notes": "Notes",
  "email": "<string>"
}'
{
  "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>",
  "advancedVerificationStatus": "initiated",
  "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

Path Parameters

​
id
string
required

Body

application/json
​
notes
string

Notes related to the bank account.

Example:

"Notes"

​
email
string

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

Response

200
application/json
OK
​
userId
string

Id of the user who updated 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.

​
advancedVerificationStatus
enum<string>

Advanced verification status of the bank account.

Available options:
initiated,
sent,
passed,
cancelled
​
id
string

Id of the bank account.

Example:

"6659d6bfd78151f639e74d53"