Build Reports

Yuno reports provides a practical way to acquire information regarding different stages of payments. You can effortlessly request and download various reports associated with your Yuno operations. Yuno provides four types of reports:

Payment
Transaction
Transaction Reconciliation
Settlement

You can check the detailed description for each one by accessing the Reports page. The Transaction Reconciliation and Settlement reports provide information related to reconciliation. To examine all fields available on each report and their description, access the Reports Fields page.

Requirements

To request a report, you will need to:

Access your API credentials on the Yuno Dashboard, which consist of:
- public-api-key
- private-secrete-key

Explore Yuno Postman Collections

Yuno provides Postman Collections that you can use to replicate the use cases locally.

Steps summary

The process to receive a report when using Yuno is composed of two steps:

Access a report

As shown in the summary of the steps, you need to complete two steps before accessing your report.

Step 1: Create a report

To initiate the report generation process, request Yuno to create the report using the Create a Report endpoint. First, select the desired report type (type), which will determine the content of the generated report. Secondly, define the date range you wish to incorporate data into the report by setting the parameters start_date and end_date.

When creating the report, you can filter the added data by specifying the values for some fields. For example, you may want to receive data only related to transactions performed in Argentina and Brazil. In this case, you would provide the AR,BR content for the parameter country.

You have the option to filter the following fields when creating the report:

payment_status
payment_sub_status
payment_method
currency
country
transaction_type
transaction_status
updated_at_start
updated_at_end

Filter values format

When defining the filter values, provide them in a string value list, such as in the example below:
"payment_status": "CREATED,READY_TO_PAY,DECLINED"

For Payment or Transaction reports, you also have the option to select the fields included in the final report using the parameter columns.

When you use the Create a Report endpoint to request a report creation, on the response, you will receive the report id and status. You will use the id when requesting the report download on Step 3. The status informs if it is ready to download.

Step 2: Check if the report is ready

After requesting the report creation, you can use endpoints Retrieve a Report or List All Reports to check if it is ready for download. When using the Retrieve a Report endpoint, you need to provide the report id. On the other hand, with the List All Reports endpoint, you need to inform your account_id to receive a list of all existing reports and their status.

When the report has the status SUCCEEDED, you can request its download. Access the Report status page to check all possible report status.

Step 3: Download your report

Use the Download a Report to receive your report providing its id. You will receive the report in a .zip file. However, for Settlement reports, the API will return a .csv file.