post https://api.sandbox.international.pagseguro.com/payouts/
Batch usage
Batch usage is deprecated in API version 1.0
Item status testing
In Sandbox, it is possible to use specific destination to receive specific statuses for payouts.
Please refer to the table below to test the different FAILED or REVERSED scenarios, which vary depending on the payout transfer method:
PAGBANK
| Destination email | result[].status.code | result[].status.reason |
|---|---|---|
| [email protected] | FAILED | PROCESSING_ERROR |
| [email protected] | FAILED | INVALID_DESTINATION |
| [email protected] | FAILED | INSUFFICIENT_FUNDS |
| [email protected] | FAILED | PAYEE_IRREGULAR_REGISTER |
| [email protected] | FAILED | PAYOUT_DENIED |
| [email protected] | FAILED | PAYEE_NAME_DOES_NOT_MATCH |
| [email protected] | FAILED | PAYEE_LEGAL_CONSTRAINTS |
| [email protected] | FAILED | PAYEE_DECEASED |
| [email protected] | FAILED | PAYEE_UNDERAGED |
| [email protected] | FAILED | PAYEE_EXCEEDED_FINANCIAL_LIMIT |
| [email protected] | FAILED | DESTINATION_ACCOUNT_BLOCKED |
| [email protected] | FAILED | PAYEE_NATIONAL_ID_CANCELLED |
| [email protected] | FAILED | PAYEE_NATIONAL_ID_INACTIVE |
PIX
| Destination key | result[].status.code | result[].status.reason |
|---|---|---|
| [email protected] | FAILED | PROCESSING_ERROR |
| [email protected] | FAILED | INVALID_DESTINATION |
| [email protected] | FAILED | DESTINATION_NOT_MATCH_DOCUMENT |
| [email protected] | FAILED | INSUFFICIENT_FUNDS |
| [email protected] | FAILED | PAYEE_IRREGULAR_REGISTER |
| [email protected] | FAILED | PAYOUT_DENIED |
| [email protected] | FAILED | PAYEE_NAME_DOES_NOT_MATCH |
| [email protected] | FAILED | PAYEE_LEGAL_CONSTRAINTS |
| [email protected] | FAILED | PAYEE_DECEASED |
| [email protected] | FAILED | PAYEE_UNDERAGED |
| [email protected] | FAILED | PAYEE_EXCEEDED_FINANCIAL_LIMIT |
| [email protected] | FAILED | REJECTED_BY_RECEIVER |
| [email protected] | FAILED | PROCESSING_TIMEOUT |
| [email protected] | FAILED | PAYEE_NATIONAL_ID_CANCELLED |
| [email protected] | FAILED | PAYEE_NATIONAL_ID_INACTIVE |
| [email protected] | FAILED | SALARY_ACCOUNT_TYPE_UNSUPPORTED |
| [email protected] | FAILED | PAYEE_TYPE_NOT_ACCEPTED |
| [email protected] | REVERSED | REJECTED_BY_PAYEE |
| [email protected] | REVERSED | REJECTED_BY_PAYEE |
| [email protected] | REVERSED | REJECTED_BY_PAYEE_BANK |
| [email protected] | REVERSED | REJECTED_BY_PAYEE_BANK |
BANK_TRANSFER
In the BANK_TRANSFER transfer method, sending a payout requires the recipient's bank account details. During tests in the Sandbox environment:
- The account number must follow the test account table provided below.
- The other bank details (account type, bank code, and branch number), when applicable, can be filled with random values chosen by the developer.
These fields are validated for simulation purposes only and do not affect the real processing of transactions.
| Destination account number | result[].status.code | result[].status.reason |
|---|---|---|
| Brazil: 12345678-9 Colombia: 3112987654 | FAILED | PROCESSING_ERROR |
| Brazil: 1122003344-5 Colombia: 3011245678 | FAILED | INVALID_DESTINATION |
| Brazil: 2233445566-5 Colombia: 3314567234 | FAILED | INSUFFICIENT_FUNDS |
| Brazil: 10293847-6 Colombia: 3516789432 | FAILED | PAYEE_IRREGULAR_REGISTER |
| Brazil: 778899001122 Colombia: 3112345678 | FAILED | PAYOUT_DENIED |
| Brazil: 990011223344 Colombia: 3213456123 | FAILED | PAYEE_NAME_DOES_NOT_MATCH |
| Brazil: 8822110099 Colombia: 3617890567 | FAILED | PAYEE_LEGAL_CONSTRAINTS |
| Brazil: 5566778899 Colombia: 3415678901 | FAILED | PAYEE_DECEASED |
| Brazil: 6677889900 Colombia: 3617890123 | FAILED | PAYEE_UNDERAGED |
| Brazil: 445566778899 Colombia: 3910123456 | FAILED | PAYEE_EXCEEDED_FINANCIAL_LIMIT |
| Brazil: 8899001122 Colombia: 3819012345 | FAILED | REJECTED_BY_RECEIVER |
| Brazil: 3344556677-8 Colombia: 3718901234 | FAILED | PROCESSING_TIMEOUT |
| Brazil: 6655443322 Colombia: 3415678345 | FAILED | PAYEE_NATIONAL_ID_CANCELLED |
| Brazil: 7766554433-1 Colombia: 3516789456 | FAILED | PAYEE_NATIONAL_ID_INACTIVE |
| Brazil: 3311223344-2 Colombia: 3718901678 | FAILED | SALARY_ACCOUNT_TYPE_UNSUPPORTED |
| Brazil: 1122334455-7 Colombia: 3011234567 | FAILED | PAYEE_TYPE_NOT_ACCEPTED |
| Brazil: 556677889900 | REVERSED | REJECTED_BY_PAYEE |
| Brazil: 99001122-7 | REVERSED (Partial) | REJECTED_BY_PAYEE |
| Brazil: 778855443322 | REVERSED | REJECTED_BY_PAYEE_BANK |
| Brazil: 66778899-0 | REVERSED (Partial) | REJECTED_BY_PAYEE_BANK |