API Reference

Create batch of Payouts in Sandbox

post
https://api.sandbox.boacompra.com/payouts/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Item status testing

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:

result[].destination.emailresult[].status.coderesult[].status.reason
[email protected]FAILEDINVALID_DESTINATION
[email protected]FAILEDPROCESSING_ERROR
Any common email like [email protected]SUCCESS
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 1000

items*
Headers
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
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 10 days ago

What’s Next

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

Updated 10 days ago

What’s Next

Did this page help you?