Use our webhooks to automatically download the reports generated in your Customer Area.
Important changes
We have migrated to a new technology platform to make report generation faster.
This migration has an effect on the Received payment details, Interactive payment accounting, and Settlement details reports. You may have to update your report data ingestion logic if you automatically generate, download, and ingest reports or ingest manually downloaded reports into your system. To determine if you have to take action, check the migration overview.
Step 1: Automate generating reports
Configure reports to generate automatically
You need the Merchant Report user role.
- In your Customer Area, go to Reports in the left navigation.
- Under Report overview, you can select a report category from the drop-down menu or enter the name of a specific report in the Search bar. By default, All reports is selected.
- From the list of reports, select the report you want to configure under the Name column.
- Select Manage report. This gives you the option to generate the report automatically or manually. Select Automatic (generate on a schedule).
- Select On. You will see a pop-up message that says Automatic report generation has been enabled at the top of your screen.
For some reports, you need to configure additional report settings such as the frequency. - Select a report format, for example, .CSV. If you change the file format, select Change format to confirm.
Schedule when you receive reports
For some reports, like the Aggregate settlement details report, you need to choose how often to generate them. Your time zone setting affects how your reports are generated.
Select Add report schedule and do the following:
-
Select the Frequency of report generation:
- Daily: each day between 02:00 and 10:00 CET and contains the previous 24 hours of data.
- Weekly: each week on the selected day and contains the previous 7 days of data. For example, if scheduled on Wednesday, the report will contain data for the previous Wednesday to Tuesday.
- Monthly: on the selected day of the month and contains data for the previous calendar month.
- Quarterly: on the selected day of the month and contains data for the previous quarter.
-
Optionally configure:
- The merchant country code(s): enter your country code.
- Also display the store: select Yes to display and No to not display the store.
- Also display the terminal Id: select Yes to display and No to not display the terminal identifier.
-
Select Schedule to create a new schedule for automatic report generation.
Step 2: Get webhooks when reports are available
Follow the instructions on our Webhooks page to expose an endpoint, set up webhooks in your Customer Area, and accept webhooks.
When a new report has been generated, you will receive a REPORT_AVAILABLE webhook. It contains the following fields that you need to download the report:
pspReference: the file name of the report.reason: the URL used to download the report.
Step 3: Create a Report service user API credential
You need a Report Service user API credential to download reports using HTTP GET requests. To be able to create new API credentials, you need to have one of the following user roles:
- Merchant admin
- Manage API credentials
To create a new credential:
-
Log in to your Customer Area, and go to Developers > API credentials.
This opens a list with all API credentials linked to your company account. -
Select Create new credential.
-
Under User type, select Report user.
-
Go to the end of the page and select Save.
-
Under Authentication, create a password in Basic Auth section.
- If creating a new credential, copy the suggested password.
- If changing the password of an existing credential, select Generate password, and copy the generated password.
- Copy and securely store the API key in your system — you won't be able to restore it later.
-
Under Authentication, select Generate New API Key. This will generate an API key for the new API credential.
- Copy and securely store the API key in your system — you won't be able to restore it later.
-
Under Roles and Associated Accounts,
-
Select Roles, and make sure the toggle for Merchant Report Download role is assigned.
-
If you only want to use this API credential for specific merchant accounts, select Account, and use the toggles to limit access to specific merchant accounts. When you toggle the company account, you toggle all merchant accounts under that company account.
-
-
Select Save at the bottom of the page.
Step 4 (Optional): Encrypt report files
For additional security, you can optionally encrypt your report files with a PGP Key:
- If you haven't already done so, generate a PGP key.
- Register your PGP public key with Adyen, specifying Reports as the Purpose of the key.
All future generated reports will be encrypted with this PGP key.
Step 5: Download reports
You download a report with an HTTP GET request. To authenticate the request, you can use an API key or Basic auth.
To authenticate an HTTP GET request, replace the following in the example Download report below:
YOUR_API_KEYwith the API key for your Report service user API credential.- The example URL with the URL from the
reasonfield in the REPORT_AVAILABLE webhook.
Parsing file names
Parse the file names of reports to choose which ones you want to download. Here are the file names of some commonly downloaded reports:
| Report type | File name format |
|---|---|
|
settlement_detail_report_batch_[Batch Number].[file format]
Parameters single day report:
Parameters multiple day report (scheduled reports only):
| |
|
settlement_report_aggregate_[yourAccountName]_[countrycode]_[additionalData]_[fromdate]_[untildate].csv Parameters:
| |
|
payments_accounting_report_[date].csv Parameters:
| |
|
account_updater_results__[additionalData]_[dateformat]_[fromdate]-[untildate].csv Parameters:
| |
|
dispute_report_[date].csv Parameters:
|