Skip to main content
POST
/
api
/
payments
/
bank
/
bulk
Create bulk bank payment
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": "Bank Name",
  "companyName": "Company Name",
  "companyAddress": "Company Address",
  "status": "awaitingPayment",
  "CCI": null,
  "CLABE": "01212345678901",
  "RFC": "RBL123456789",
  "RUC": "<string>",
  "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

Example:

"6757546b4c5d19bf3cd7b09c"

Response

201 - application/json

Created

​
createdAt
string

The date and time the order was created

Example:

"2025-01-04T02:07:50.765Z"

​
userId
string

The unique identifier of the user

Example:

"6757546b4c5d19bf3cd7b09c"

​
orderIds
string[]

List of order IDs associated pending payment

Example:
[]
​
amount
number

The total amount of the orders

Example:

0

​
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

Example:
[]
​
bankName
string

The name of the bank

Example:

"Bank Name"

​
companyName
string

The name of the company

Example:

"Company Name"

​
companyAddress
string

The address of the company

Example:

"Company Address"

​
status
enum<string>

The current status of the bulk bank payment

Available options:
awaitingPayment,
complete,
failed,
cancelled,
insufficientAmountReceived,
excessAmountReceived
Example:

"awaitingPayment"

​
CCI
string

20-digit code used to identify bank accounts, only applies in Peru

Example:

null

​
CLABE
string

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

Example:

"01212345678901"

​
RFC
string

The tax identification number in Mexico

Example:

"RBL123456789"

​
RUC
string

Registry containing the identification data of economic activities in Peru

​
reference
string

The reference for the bulk payment

Example:

"BPaaf32e"

​
id
string

The unique identifier of the bulk bank payment

Example:

"677897f68f577610fcaaf32e"

⌘I