Generate and download Balance Platform Reports

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

Step 1: Generate reports

Generate reports automatically

To automatically generate reports:

1. Log in to your Balance Platform Customer Area.
2. Go to Reports.
3. Next to the name of the report you want to generate, select Automatic generation.
4. Turn on the Automatic generation toggle.

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

Generate reports manually

You can manually generate reports anytime in the Balance Platform Customer Area. Some reports, such as the Balance Report or Received Payments Report, can also be generated in bulk.

1. Log in to your Balance Platform Customer Area.
2. Go to Reports.
3. Next to the name of the report you want to generate, select Generate.
4. (Optional) Depending on the report type, select:
   1. Bulk to generate multiple reports.
   2. The appropriate date or time period.
   3. The preferred timezone.
5. Select Generate report.

Generating a report may take up to a few minutes.

Step 2: 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 notification contains the URL at which you can download the report.

{
  "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"
}

Step 3: Download reports

All reports are generated in CSV 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.

$ wget --http-user='report_[123456]@BalancePlatform.YOUR_BALANCE_PLATFORM' \
--http-password='YOUR_PASSWORD' \
https:\/\/balanceplatform-test.adyen.com\/balanceplatform\/reportDownload\/v1\/YOUR_BALANCE_PLATFORM\/balanceplatform_balance_report_2022_01_31.csv