Create a Report
Requests generation of a payment, transaction, or settlement report and returns its ID and status.
start_date must be before end_date; otherwise the API answers 400 REPORT_RANGE_ERROR. start_date must also be before the current time, except for AGENDA and CASHFLOW reports, which accept future dates. For report types other than TRANSACTIONS, PAYMENTS, FRAUD_TRANSACTIONS, PAYOUTS, AGENDA and CASHFLOW, the range between start_date and end_date is at most 62 days, and a longer range is rejected with 400. The response from this endpoint provides an object containing:
- The
statusof the report generation. - A report
id.
Authorizations
Body
Starting timestamp of data to be included in the report run (MAX 24; MIN 24; ISO 8601). Must be before end_date; otherwise the API answers 400 REPORT_RANGE_ERROR. Must also be before the current time, except for AGENDA and CASHFLOW reports, which accept future dates. For report types other than TRANSACTIONS, PAYMENTS, FRAUD_TRANSACTIONS, PAYOUTS, AGENDA and CASHFLOW, the range between start_date and end_date is at most 62 days; a longer range is rejected with 400.
Ending timestamp of data to be included in the report run (MAX 24; MIN 24; ISO 8601). Must be after start_date; otherwise the API answers 400 REPORT_RANGE_ERROR.
Account identifier(s). Omit to include all accounts. For multiple accounts, send a comma-separated list. For the Settlement Payouts report, this is matched against the provider account name and, for merchants on Yuno's new reconciliation engine, also against the Yuno account through the settlement batch. Providers whose payouts arrive through a separate endpoint (for example Pagar.me) return no rows when filtered this way.
Example: 19d28762-c714-4fb0-9ef6-4e1953ed334b, 91d82267-c714-4fb0-9ef6-4e1953ed334b
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
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
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
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. For the Settlement Payouts report, filters by settlement currency (comma-separated list).
Example: ARS,BRL,COP
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
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
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
Starting timestamp of data to be included in the report run by updated date of operation (MAX 27; MIN 27; ISO 8601).
Ending timestamp of data to be included in the report run by updated date of operation (MAX 27; MIN 27; ISO 8601).
Columns to include (only for Payment, Transaction, or Settlement Payouts reports). See available fields in Report Fields. For the Settlement Payouts report, this parameter replaces the default column selection instead of extending it: to add an optional column you must also list every default column you want to keep.
Example: account_id,amount_value,card_category. A name that is not a column of the chosen report type returns 400 INVALID_COLUMNS.
Response
201