API Reference

Downloading payout CSV reports in Sandbox

get
https://api.sandbox.boacompra.com/payouts/reports/bases/
Recipes
💻
Generating the Authorization header for Payout
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

Sandbox date

In order to get a report example in sandbox, it is necessary to use this specific date: 20200511. Otherwise, the API will return a 404.

This endpoint search for a CSV Report of all payouts on FAILED and SUCCESS statuses for an exact date.
Also, it contains columns for invoice data.
All date-time columns are UTC+0.

📘

To use this feature it is necessary to enable "follow redirect" on the HTTP client being used.

Path Params
string
required
Defaults to 20200511

Selected date for a report. It has the following format: YYYYMMDD. | min 8 | max 8

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

Generated from available response content types

Allowed:
Responses

Updated almost 4 years ago

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

Updated almost 4 years ago

What’s Next