Skip to main content
POST
/
api
/
payments
/
crypto
/
bulk
Create bulk crypto payment
curl --request POST \
  --url https://app.sandbox.rio.trade/api/payments/crypto/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "orderIds": [
    "6757546b4c5d19bf3cd7b09c",
    "6757546b4c5d19bf3cd7b09d"
  ],
  "userId": "6757546b4c5d19bf3cd7b09c"
}
'
{
  "createdAt": "2025-01-04T01:37:25.259Z",
  "userId": "6757546b4c5d19bf3cd7b09c",
  "orderIds": [],
  "amount": 0,
  "orderIdsPaid": [],
  "status": "awaitingPayment",
  "depositAddress": "5BZDQjWad45rT1vYT5KdJHgSU4rWXL1Y5nDoTwSrT8Pr",
  "id": "677890d5d520f9ecb10e9c33"
}

​
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
​
orderIds
string[]

Optional list of order IDs to include in the bulk crypto payment. When omitted, crypto, country and userId must be provided

Example:
[
  "6757546b4c5d19bf3cd7b09c",
  "6757546b4c5d19bf3cd7b09d"
]
​
crypto
enum<string>

The type of cryptocurrency involved in the order

Available options:
USDC,
USDC_POLYGON,
USDC_POLYGON_NXTB,
SOL_USDC_PTHX,
XLM_USDC_5F3T,
USDT_POLYGON,
USDT_ERC20,
TRX_USDT_S2UZ,
USDT_BSC
​
country
enum<string>

The country of the user

Available options:
MX,
PE,
CO,
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-04T01:37:25.259Z"

​
userId
string

The unique identifier of the user

Example:

"6757546b4c5d19bf3cd7b09c"

​
orderIds
string[]

List of order IDs associated with the user

Example:
[]
​
amount
number

The total amount of the orders

Example:

0

​
orderIdsPaid
string[]

List of order IDs that have been paid

Example:
[]
​
crypto
enum<string>

The type of cryptocurrency involved in the order

Available options:
USDC,
USDC_POLYGON,
USDC_POLYGON_NXTB,
SOL_USDC_PTHX,
XLM_USDC_5F3T,
USDT_POLYGON,
USDT_ERC20,
TRX_USDT_S2UZ,
USDT_BSC
​
country
enum<string>

The country of the operation

Available options:
MX,
PE,
CO,
US
​
status
enum<string>

The current status of the bulk crypto payment.

Available options:
awaitingDepositAddress,
awaitingOrders,
awaitingPayment,
awaitingAsyncPayment,
awaitingAsyncPayoutForOrders,
complete,
failed,
cancelled,
insufficientAmountReceived,
excessAmountReceived
Example:

"awaitingPayment"

​
depositAddress
string

The deposit address for the order

Example:

"5BZDQjWad45rT1vYT5KdJHgSU4rWXL1Y5nDoTwSrT8Pr"

​
id
string

The unique identifier of the bulk crypto payment

Example:

"677890d5d520f9ecb10e9c33"