v1
latestOpenAPI 3.1.02026-07-24102785.8 KBGet Payouts
📘 Authorization
Make sure your requests are properly authenticated, check the Payout API Authorization before executing your first request.
📘 Understanding Responses
Learn how to interpret the status of your requests and individual payout items:
get/payouts/{reference}/items
Path parameters
referencestring required
Unique Reference for a payout. It was generated and informed by the Merchant on creation. Accepts alphanumeric and especial characters.
Headers
Content-Typestring required
Authorizationstring required
Your Authorization header, calculated with your api-key and your secret-key.
X-Api-Versionstring required
Response
200
Example response
{
"result": [
{
"reference": "29cfcb4b-4570-4ac3-bbdd-a3b6e5843ed6",
"amount": {
"value": 10,
"currency": "BRL"
},
"country": "BR",
"method": "PIX",
"destination": {
"key": "laraneves@uolinc.com",
"amount": {
"value": 10,
"currency": "BRL"
}
},
"status": {
"code": "SUCCESS"
},
"exchange": {
"base": "BRL",
"rate": 1
},
"created_at": "2025-06-23T14:01:04.000000Z",
"updated_at": "2025-06-23T14:01:07.000000Z"
}
],
"pagination": {
"total_items": 1,
"total_pages": 1
}
}