Create Payouts in Sandbox (Old)

Recipes
💻
Generating the Authorization header for Payout
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

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.emailresult[].status.coderesult[].status.reason
[email protected]FAILEDINVALID_DESTINATION
[email protected]FAILEDPROCESSING_ERROR
Any common email like [email protected]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.keyresult[].status.coderesult[].status.reason
[email protected]FAILEDDESTINATION_ACCOUNT_BLOCKED
[email protected]FAILEDDESTINATION_NOT_MATCH_DOCUMENT

Scenario for Insufficient Funds

destination.email or destination.keyresult[].status.codemessage
[email protected]FAILEDINSUFFICIENT_FUNDS
Body Params
string
required

Unique Reference for a Batch. It must be generated and informed by the Merchant. Accepts alphanumeric and hyphen. | max 64

string
required

URL for further notifications. | max 200

items
array of objects
required

Array of items containing every payout of one batch. | max 1

items*
string
Headers
string
required
Defaults to application/json
string
required

Your Authorization header, calculated with your api-key and your secret-key. Please refer to the recipe above on how to generate it.

string
required
Defaults to v1
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json