Payouts
Brazil
PIX payouts in BRL
Before you start
Authorization
How to sign your requests with the API token.
Payouts overview
Common request format, response fields and statuses.
This payout destination is not enabled for all merchants. Check availability with your manager, and make sure your merchant balance is sufficient before creating a payout.
Overview
| Currency | Destination | Payment types |
|---|---|---|
BRL | PIX | RANDOM, SIM, EMAIL, CPF, CNPJ |
Payment types
paymentType | Description | account.requisites example |
|---|---|---|
RANDOM | Random PIX key | super-uuid-secret |
SIM | Phone number | +551113434354545 |
EMAIL | email@example.com | |
CPF | CPF (individual tax ID) | 12345678900 |
CNPJ | CNPJ (company tax ID) | 12345678000200 |
account fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | ✅ Yes | Recipient name |
requisites | string | ✅ Yes | Recipient requisites: card number, phone number, PIX key, etc., depending on paymentType |
userId | string | ✅ Yes | User ID in your system |
requisites holds the PIX key of the type selected by paymentType.
Request example
curl -X POST "https://api.riopay.online/v1/payouts" \
-H "Content-Type: application/json" \
-H "X-Api-Token: YOUR_API_TOKEN" \
-d '{
"amount": 1000.50,
"currency": "BRL",
"paymentType": "EMAIL",
"externalId": "payout-123",
"account": {
"name": "John Doe",
"requisites": "john.doe@example.com",
"userId": "user_12345"
},
"note": "Payout for order #1234"
}'Response
The response is a standard payout object with the CREATED status. Store the id to track the payout.