Get platform reports

Learn how to generate and download reports for your balance platform automatically or manually.

You can generate balance platform reports automatically according to a specific schedule, or manually on-demand.

Requirements

Requirement	Description
API credential roles	To Download reports make sure that you have the following role: Report service user API key with the BalancePlatform Report Download role
Customer Area roles	Make sure that you have the following roles: Download Balance Platform reports Generate Balance Platform reports
Webhooks	Subscribe to the following webhook(s): balancePlatform.report.created

Generate reports

To automatically generate reports:

Log in to your Customer Area and make sure you are on the correct merchant account.
Go to Reports.
Select the name of the report you want to generate.
Select Manage report.
Select Automatic (schedule based).

Keep the Automatic generation toggle selected. If you deselect this option, the schedule for generating reports is deleted.
Select Close.

The schedule depends on the report type and your balance platform configuration. When a report is generated, Adyen sends a balancePlatform.report.created webhook.

Get updates when a report is available

To get updates when a balance platform report is generated and available for download, listen to the balancePlatform.report.created webhook. The webhook contains the URL at which you can download the report.

Example webhook

 {
  "data": {
    "balancePlatform": "YourBalancePlatform",
    "creationDate": "2022-01-02T02:01:08+02:00",
    "id": "balanceplatform_balance_report_2022_01_01.csv",
    "downloadUrl": "https://balanceplatform-test.adyen.com/balanceplatform/reportDownload/v1/YourBalancePLatform/balanceplatform_balance_report_2022_01_01.csv",
    "reportType": "balanceplatform_balance_report",
    "fileName": "balanceplatform_balance_report_2022_01_01.csv"
  },
  "environment": "test",
  "type": "balancePlatform.report.created"
}

Download reports

All reports are generated in CSV format. You can also generate the Accounting report in TSV format. We recommend that you create a script to load the reports and reconcile into your systems. Alternatively, you can use any spreadsheet software to open the file and reconcile manually.

You can download reports manually from your Customer Area, or programmatically by making an HTTP GET request.

You can download all generated balance platform reports from the Reports page of your Customer Area.

To download reports manually:

Log in to your Customer Area and make sure you are on the correct merchant account.
Go to Reports.
Select the name of the report type you want to download.
In the Generated reports table, select the arrow in the Download column of the specific report you want to download.