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

The ID of the bank account where the payout will be sent.

Example:

"65ba521a4b3e1bd9eb6a5107"

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

​
fiat
enum<string>

The fiat currency of the payout.

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

The country of the payout.

Available options:
MX,
PE,
US
​
bankName
string

The name of the destination bank.

Example:

"BBVA"

​
CLABE
string

The CLABE number for Mexican bank accounts.

Example:

"012180015000000001"

​
status
enum<string>

The current status of the bulk bank payout.

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

"awaitingOrders"

​
payoutBankAccountId
string

The ID of the destination bank account.

Example:

"65ba521a4b3e1bd9eb6a5107"

​
id
string

The unique identifier of the bulk bank payout.

Example:

"677890d5d520f9ecb10e9c33"