Learn more about the different environments available.
Sandbox
The sandbox environment allows you to test your integration with the Payouts API. It simulates API requests and transaction types, so you can validate your implementation before going live.
Sandbox base URL
Sandbox transactions are simulated and not actually processed.
Simulate payout statuses in sandbox
In Sandbox, you can control the payout result by passing a status code in the request body's description field.
- Input. Set the desired mock scenario using the
description
field in your payout request. - Output. The mock server responds with the mapped
status
,status_code
, andstatus_detail
.
Example
- Successful payout. If you provide
description: DELIVERED:PAID
in the request, you'll subsequently receive a notification withstatus: PAID
,status_code: 200
, andstatus_detail: The payout was paid
. - Fail payout. If you provide
description: DELIVERED:5011
, you'll subsequently receive a notification withstatus: BAD_REQUEST
,status_code: 5011
, andstatus_detail: External ID already used
.
{
"external_id": "your_external_id",
"payment_method_id": "INSTANT_PAYMENT",
"flow_type": "B2C",
"country": "BR",
"currency": "BRL",
"purpose": "DIGITAL_GOODS",
"amount": 129.19,
"notification_url": "https://yoururl.com/notification",
"beneficiary": {
"first_name": "John",
"last_name": "Doe",
"document": {
"id": "39446691001"
},
"instant_payment": {
"id": "39446691001"
}
},
"description": "DELIVERED:3001"
}
Sample description values to simulate card responses
description (input) | Simulated status (output) | status_code (output) | status_detail (output) |
---|---|---|---|
DELIVERED:3000 | BAD_REQUEST | 3000 | Invalid params |
DELIVERED:3001 | BAD_REQUEST | 3001 | Empty params |
DELIVERED:3003 | BAD_REQUEST | 3003 | Invalid bank code |
DELIVERED:4001 | FORBIDDEN | 4001 | Invalid credentials |
DELIVERED:4002 | FORBIDDEN | 4002 | Unregistered IP address (register in Dashboard) |
DELIVERED:5007 | BAD_REQUEST | 5007 | Country not found for payouts |
DELIVERED:5008 | BAD_REQUEST | 5008 | Limit exceeded |
DELIVERED:5009 | BAD_REQUEST | 5009 | Payout not found with this ID |
DELIVERED:5010 | BAD_REQUEST | 5010 | Invalid status: payout is not pending |
DELIVERED:5011 | BAD_REQUEST | 5011 | External ID already used |
DELIVERED:5012 | BAD_REQUEST | 5012 | Rejected compliance limits |
DELIVERED:5013 | BAD_REQUEST | 5013 | End beneficiary blacklisted |
DELIVERED:5014 | BAD_REQUEST | 5014 | Insufficient funds |
DELIVERED:5015 | BAD_REQUEST | 5015 | Rejected due to compliance |
DELIVERED:7002 | BAD_REQUEST | 7002 | Could not cancel the payout |
DELIVERED:7004 | BAD_REQUEST | 7004 | Could not release the payout due to compliance |
DELIVERED:ON_HOLD | ON_HOLD | 600 | The payout is on hold by the merchant |
DELIVERED:ON_HOLD_BY_COMPLIANCE | ON_HOLD_BY_COMPLIANCE | 700 | The payout is pending from compliance checks |
DELIVERED:PAID | PAID | 200 | The payout was paid |
Production
After successful testing, you can switch to the production environment.