POST
/
api
/
payments
/
bank
/
bulk
curl --request POST \
  --url https://app.sandbox.rio.trade/api/payments/bank/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "fiat": "USD",
  "country": "MX",
  "userId": "6757546b4c5d19bf3cd7b09c"
}'
{
  "createdAt": "2025-01-04T02:07:50.765Z",
  "userId": "6757546b4c5d19bf3cd7b09c",
  "orderIds": [],
  "amount": 0,
  "fiat": "USD",
  "orderIdsPaid": [],
  "bankName": "NVIO",
  "companyName": "RAMPA BLOCKCHAIN SAPI DE CV",
  "companyAddress": "Ave. Lázaro Cardenas 2400, Residencial San Agustin 1 Sector, San Pedro Garza Garcia, CP 66260, Mexico",
  "status": "awaitingPayment",
  "CLABE": "710969000021237966",
  "RFC": "RBL2206107N8",
  "reference": "BPaaf32e",
  "id": "677897f68f577610fcaaf32e"
}

​
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
​
fiat
enum<string>

The type of fiat currency involved in the order

Available options:
USD,
MXN,
PEN
​
country
enum<string>

The country of the user

Available options:
MX,
PE,
US
​
userId
string

The unique identifier of the user

Response

201 - application/json
Created
​
createdAt
string

The date and time the order was created

​
userId
string

The unique identifier of the user

​
orderIds
string[]

List of order IDs associated pending payment

​
amount
number

The total amount of the orders

​
fiat
enum<string>

The type of fiat currency involved in the order

Available options:
USD,
MXN,
PEN
​
orderIdsPaid
string[]

List of order IDs that have been paid

​
bankName
string

The name of the bank

​
companyName
string

The name of the company

​
companyAddress
string

The address of the company

​
status
enum<string>

The current status of the bulk bank payment

Available options:
awaitingPayment,
complete,
failed,
cancelled,
insufficientAmountReceived,
excessAmountReceived
​
CLABE
string

The 18-digit code used to identify bank accounts in Mexico

​
RFC
string

The tax identification number in Mexico

​
reference
string

The reference for the bulk payment

​
id
string

The unique identifier of the bulk bank payment

Confirm bank paymentGet bulk bank payment