post https://api.sandbox.boacompra.com/payouts/
Recipes
💻
Generating the Authorization header for Payout
Open Recipe
Batch usage
Batch usage is deprecated in API version 1.0
Item status testing
PagBank
In Sandbox, it is possible to use specific emails to receive specific statuses for payouts.
Please refer to the table below to test the different FAILED scenarios for PagBank payouts:
| result[].destination.email | result[].status.code | result[].status.reason |
|---|---|---|
| payouts-invalid-destination@pagseguro.com | FAILED | INVALID_DESTINATION |
| payouts-processing-error@pagseguro.com | FAILED | PROCESSING_ERROR |
| Any common email like lara.neves@pagseguro.com | SUCCESS |
PIX
You can also use a specific PIX key to test a FAILED scenario.
Please refer to the table below for PIX payouts:
| result[].destination.key | result[].status.code | result[].status.reason |
|---|---|---|
| payouts-destination-account-blocked@pagseguro.com | FAILED | DESTINATION_ACCOUNT_BLOCKED |
| payouts-destination-not-match-document@pagseguro.com | FAILED | DESTINATION_NOT_MATCH_DOCUMENT |
Scenario for Insufficient Funds
| destination.email or destination.key | result[].status.code | message |
|---|---|---|
| payouts-insufficient-funds@pagseguro.com | FAILED | INSUFFICIENT_FUNDS |