You can generate platform reports automatically according to a specific schedule, or manually on-demand.
Step 1: Generate reports
To automatically generate reports:
Log in to your Balance Platform Customer Area.
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.
The schedule depends on the report type and your platform configuration. When a report is generated, Adyen sends a balancePlatform.report.created webhook.
Step 2: Get updates when a report is available
To get updates when a 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.
Step 3: 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 programmatically by making an HTTP GET request, or manually from your Balance Platform Customer Area.
To download reports programmatically:
- Ask your Adyen contact for your report credentials. You must use your report credentials to authenticate your GET request.
- Download the report with an HTTP GET request. Include:
- The name of your report API credential.
- The basic authentication password for your report API credential.
- The URL from the
downloadUrlfield in the balancePlatform.report.created webhook.
Here is how to download a Balance Platform Balance Report for the API credential