Create a Report
Requests generation of a payment, transaction, or settlement report and returns its ID and status.
- The
statusof the report generation. - A report
id.
Authorizations
Headers
Organization code associated to the request.
Body
The type of the report to run (MAX 255; MIN 3). SETTLEMENT_PAYOUTS is available for merchants on Yuno's new reconciliation engine.
PAYOUTS, PAYMENTS, TRANSACTIONS, SETTLEMENTS_FEES, RECONCILIATION_OVERVIEW, COMMUNICATIONS, SETTLEMENT_PAYOUTS The user identifier to associate with the report request.
The unique identifier of the report at the merchant side (MAX 255; MIN 3).
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
Filters the Settlements report by acquirer. Accepts a single value (case-insensitive; conventionally uppercase). For the Settlement Payouts report, this filter accepts a comma-separated list of values, in uppercase.
Example: BAC_CREDOMATIC
For the Settlement Payouts report, filters the rows by provider. Comma-separated list, values in uppercase.
Example: ADYEN,CIELO
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
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_code,amount_value,card_category
Columns to include (only if the merchant is exporting metadata fields). This option is exclusive to Transaction and Settlement reports.
Response
201
"6d905149-b388-4522-8c0a-759fed1f39da"
"PAYMENTS"
"2023-07-01 00:00:00 +0000 UTC"
"2023-07-12 00:00:00 +0000 UTC"
"payments_1"
"2023-07-12 20:10:30.311048496 +0000 UTC"
"2023-07-12 20:10:30.311048496 +0000 UTC"
""
"IN_PROCESS"