Create a Report

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint allows you to request the generation of specific report types. The response from this endpoint provides an object containing:

  • The status of the report generation.
  • A report id.

Use the report id to download the report using the Download a Report endpoint after it is generated.

Body Params
string
enum
required

The type of the report to run (MAX 255; MIN 3).

Allowed:
string

The user identifier to associate with the report request.

date-time
required

Starting timestamp of data to be included in the report run (MAX 24; MIN 24; ISO 8601).

date-time
required

Ending timestamp of data to be included in the report run (MAX 24; MIN 24; ISO 8601).

string

The unique identifier of the report at the merchant side (MAX 255; MIN 3).

string

Account identifier(s). Omit to include all accounts. For multiple accounts, send a comma-separated list.
Example: 19d28762-c714-4fb0-9ef6-4e1953ed33tf, 91d82267-c714-4fb0-9ef6-4e1953ed33tf.

string

The status of the payment (MAX 255; MIN 3; Payment status). Don't send this parameter to request the creation of a report for all payment status. Otherwise, indicate all the status you want to include.
Example: CREATED,READY_TO_PAY,DECLINED

string

The substatus of the payment (MAX 255; MIN 3; Payment substatus). Don't send this parameter to request the creation of a report for all payment sub status. Otherwise, indicate all the sub status you want to include.
Example: READY_TO_PAY,PENDING_FRAUD_REVIEW,EXPIRED

string

The type of payment method selected by the customer (MAX 255; MIN 3; Payment methods). Don't send this parameter to request the creation of a report for all payment methods. Otherwise, indicate all the methods you want to include.
Example: ADDI,ACUOTAZ,PIX

string

The currency used to make the payment (MAX 3; MIN 3; ISO 4217). Don't send this parameter to request the creation of a report for all currencies. Otherwise, indicate all currencies you want to include.
Example: ARS,BRL,COP

string

The country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1). Don't send this parameter to request the creation of a report for all countries. Otherwise, indicate all countries you want to include.
Example: AR,BR,CO

string

The transaction type (MAX 255; MIN 3; Transaction types). Don't send this parameter to request the creation of a report for all transaction types. Otherwise, indicate all transaction types you want to include.
Example: PURCHASE,REFUND,VERIFY

string

The status of the transaction (MAX 255; MIN 3; Transaction status). Don't send this parameter to request the creation of a report for all transaction status. Otherwise, indicate all transaction status you want to include.
Example: SUCCEEDED,CREATED,EXPIRED

date-time

Starting timestamp of data to be included in the report run by updated date of operation (MAX 27; MIN 27; ISO 8601).

date-time

Ending timestamp of data to be included in the report run by updated date of operation (MAX 27; MIN 27; ISO 8601).

string

Columns to include (only for Payment or Transaction reports). See available fields in Report Fields.
Example: account_code,amount_value,card_category

string

Columns to include (only if the merchant is exporting metadata fields). This option is exclusive to Transaction and Settlement reports.

Headers
string
required

Organization code associated to the request.

Responses

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