Skip to main content
POST
/
api
/
payouts
/
crypto
/
bulk
Create bulk crypto payout
curl --request POST \
  --url https://app.sandbox.rio.trade/api/payouts/crypto/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "payoutAddressId": "65ba521a4b3e1bd9eb6a5107",
  "country": "MX"
}
'
{
  "createdAt": "2025-01-04T00:24:28.658Z",
  "userId": "6757546b4c5d19bf3cd7b09c",
  "orderIds": [],
  "amount": 0,
  "crypto": "USDC",
  "payoutAddressId": "65ba521a4b3e1bd9eb6a5107",
  "blockchainAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "country": "MX",
  "status": "awaitingOrders",
  "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
​
payoutAddressId
string
required

The ID of the crypto address where the payout will be sent.

Example:

"65ba521a4b3e1bd9eb6a5107"

​
country
enum<string>
required

The country of the operation.

Available options:
MX,
PE

Response

Created

​
createdAt
string

The date and time the bulk payout was created.

Example:

"2025-01-04T00:24:28.658Z"

​
userId
string

The unique identifier of the user.

Example:

"6757546b4c5d19bf3cd7b09c"

​
orderIds
string[]

List of order IDs associated with this bulk payout.

Example:
[]
​
amount
number

The total payout amount across all orders.

Example:

0

​
crypto
enum<string>

The cryptocurrency of the payout.

Available options:
USDC,
USDC_POLYGON,
USDC_POLYGON_NXTB,
SOL_USDC_PTHX,
XLM_USDC_5F3T,
USDT_POLYGON,
USDT_ERC20,
TRX_USDT_S2UZ
​
payoutAddressId
string

The ID of the destination crypto address.

Example:

"65ba521a4b3e1bd9eb6a5107"

​
blockchainAddress
string

The blockchain address where funds will be sent.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
country
enum<string>

The country of the operation.

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

The current status of the bulk crypto payout.

Available options:
awaitingOrders,
awaitingPaymentForOrders,
awaitingPayoutRequest,
awaitingPayout,
awaitingAsyncPayout,
awaitingAsyncPayoutRequest,
checkingLiquidity,
sourcingLiquidity,
liquiditySourced,
complete,
failed,
cancelled
Example:

"awaitingOrders"

​
id
string

The unique identifier of the bulk crypto payout.

Example:

"677890d5d520f9ecb10e9c33"