Sign in

v1

latestOpenAPI 3.1.02026-07-24130244.8 KB

Create new report

post/reports

Headers

Content-Typestring required

Always send this header as application/json.

Hoststring required

The host declared in the signature.

Datestring required

The date declared in the signature.

Digeststring required

The digest declared in the signature.

Authorizationstring required

The request signature.

Idempotency-Keystring

The idempotent request key. <br> <br> You can read more here.

Request body

typestring required

The type of report that you want to extract. <br> <br> PAYMENT_FEE <br> Generates a report that includes collected fees and group id for each transaction.

format'CSV' | 'XLS' required

The type report format required. <br> <br> CSV <br> Generates an CSV file format. <br> <br> XLS <br> Generates an XLS file format.

query_type'PAYMENT_DATE_INTERVAL' required

The query type that you wish to use in the query_payload parameter. <br> <br> PAYMENT_DATE_INTERVAL <br> The only query type supported.

Response

200

idstring

The unique report id. <br> <br> This can be used to retrieve the generated report.

typestring

The report type generated. <br> <br> PAYMENT_FEE <br> A report that includes collected fees and group id for each transaction.

statusstring

The current report status. <br> <br> PENDING <br> The report will be generated soon. <br> <br> SUCCESS <br> The report has been successfully generated.

query_typestring

The query type that you used in the query_payload parameter. <br> <br> PAYMENT_DATE_INTERVAL <br> The only query type supported.