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. You can read more here.

typestring required

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

format'CSV' | 'XLS' required

The type report format required. CSV Generates an CSV file format. XLS Generates an XLS file format.

query_type'PAYMENT_DATE_INTERVAL' required

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

200

idstring

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

typestring

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

statusstring

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

query_typestring

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

No recorded changes to this endpoint across all 1 revision of this API.