Downloading reports

Automate the process of downloading and parsing report data using a combination of our notifications service and HTTP GET requests.

Reports and time zones

Because time zones influence the start and end of your report, be aware of how we generate reports before you start downloading and using them:

• We generate reports at approximately 04:00 CET.

  If you find new reports by crawling (instead of automating report downloads), make sure the crawling time frame extends beyond 04:00 CET in case reports are generated later.

• Each report uses only one time zone and one currency.

• Charts and consolidated reports are always based on the CET time zone.

• For other reports, the time zone setting of your account determines the beginning and end of the reporting period, and thus the transactions that are included. It is possible to have various different time zone settings for your company account and merchant accounts, but keep in mind that the report uses the time zone setting of the account where you run the report.

  You'll find the time zone setting in your Customer Area under Account > Settings.

  Report	Time zone
  Account Updater results report	CET
  Aggregate settlement details report	Account time zone 1
  Daily finance report	CET
  Dispute transaction details report	Account time zone
  External settlement detail report	Account time zone
  MarketPay balance report	Account time zone
  MarketPay payments accounting report	Account time zone
  MarketPay payout report	Account time zone
  Monthly finance report	CET
  Monthly invoice	CET
  Payment accounting report	Account time zone
  Received payment details report	Account time zone
  Settlement details report	Account time zone 1

  ¹ The Settlement details report and the Aggregate settlement details report are generated approximately two hours after the payable closing time of your merchant account. An overview of all payable closing time settings per merchant account is available in your Customer Area on the company level, under Finance > Payout model.

Change the time zone

Changing the time zone for your account only has an effect for future reports, and might lead to an initial gap or overlap in reports. For these reasons, proceed as follows when you want to change your time zone setting:

1. Generate, download, and save your report(s).
2. Contact our Support Team and ask them to change the time zone setting for your account.
3. Generate and download the report(s) again.
4. Merge each old report with the corresponding new report and remove any duplicates.

Automate generating reports

You can choose Automatic generation to generate a report automatically and make it available in your Customer Area. You will also receive a notification with eventCode: REPORT_AVAILABLE. The reason field contains the URL where you can download the report, and the pspReference field contains the name of the report.

To automatically generate a report:

1. Log in to your Customer Area.
2. Go to Finance and under Downloadable reports select the report that you want to subscribe to.
3. Select Automatic generation.
4. Select a report format (such as .CSV or .XSLX).

If prompted, schedule when want you receive the report by selecting Add report schedule and do the following:

1. Select the Frequency of report generation:

   • Daily - The report is generated each day at 04:00 CET and contains the previous 24 hours of data.
   • Weekly - The report is generated 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 Wednesday - Tuesday.
   • Monthly - The report is generated on the selected day of the month and contains data for the previous calendar month.

2. Optionally enter your country code in The merchant country code(s) and also:

   • 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 Id.
3. Select Schedule to create a new schedule for automatic report generation.

Automate downloading reports

You can use downloaded reports for reconciliation by importing them into your accounting, ERP, or business intelligence systems. For more information, refer to Automate payment reconciliation. For additional security, you can also encrypt your reports with your PGP Key.

To automate report downloads:

1. Set up report notifications to inform your server that a new report has been generated.
2. Make a HTTP GET request to download the report. 

Step 1: Set up notifications

• Set up notifications HTTP callbacks (webhooks) sent to an endpoint on your server. For general information on notifications, refer to Set up notifications. After you set up notifications, you will receive a REPORT_AVAILABLE notification when a new report has been generated. This notification contains the following fields:

  • pspReference – the file name of the report.
  • reason – the URL used to download the report.

{
   "live":"false",
   "notificationItems":[
      {
         "NotificationRequestItem":{
            "amount":{
               "currency":"EUR",
               "value":0
            },
            "eventCode":"REPORT_AVAILABLE",
            "eventDate":"2018-04-18T10:03:08+02:00",
            "merchantAccountCode":"[merchantAccountCode]",
            "merchantReference":"",
            "pspReference":"settlement_detail_report_batch_12.csv",
            "reason":"https:\/\/ca-test.adyen.com\/reports\/download\/MerchantAccount\/[merchantAccountCode]\/settlement_detail_report_batch_12.csv",
            "success":"true"
         }
      }
   ]
}

<?xml version="1.0" encoding="UTF-16"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soap:Body>
        <sendNotification xmlns="http://notification.services.adyen.com">
            <notification>
                <live>true</live>
                <notificationItems>
                    <NotificationRequestItem>
                        <amount>
                            <currency xmlns="http://common.services.adyen.com">EUR</currency>
                            <value xmlns="http://common.services.adyen.com">0</value>
                        </amount>
                        <eventCode>REPORT_AVAILABLE</eventCode>
                        <eventDate>2018-04-18T10:03:08+02:00</eventDate>
                        <merchantAccountCode>[merchantAccountCode]</merchantAccountCode>
                        <merchantReference/>
                        <pspReference>settlement_detail_report_batch_12.csv</pspReference>
                        <reason>https://ca-test.adyen.com/reports/download/MerchantAccount/[merchantAccountCode]/settlement_detail_report_batch_12.csv</reason>
                        <success>true</success>
                    </NotificationRequestItem>
                </notificationItems>
            </notification>
        </sendNotification>
    </soap:Body>
</soap:Envelope>

Step 2: Download the report

1. Create an API credential. Make sure you select the User type of Report user, and that the Merchant Report Download role is assigned.
2. Download the report with an HTTP GET request. Include the URL of the report file name and your report API credentials, for example report@Company.[YourCompanyAccount].

Merchant Account Reports:

$ wget --http-user='[YourReportAPICredentials]@Company.[YourCompanyAccount]' --http-password='[YourUserPassword]' --quiet --no-check-certificate https://ca-test.adyen.com/reports/download/MerchantAccount/[YourMerchantAccount]/[ReportFileName]

Company Account Reports:

$ wget --http-user='[YourReportAPICredentials]@Company.[YourCompanyAccount]' --http-password='[YourUserPassword]' --quiet --no-check-certificate https://ca-test.adyen.com/reports/download/Company/[YourCompanyAccount]/[ReportFileName]

Determine reports to download by parsing file names

You may not want to download every report that is generated. Parse the file name of the report to determine this. The following file naming conventions are used for our commonly downloaded reports:

Encrypt report files (optional)

For additional security, you can optionally encrypt your report files with a PGP Key:

1. If you haven't already done so, generate a PGP key.
2. 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.

Manually download a report

To download reports from your Customer Area, you need to have the Merchant Report role assigned to your user account. For more information on how to set this up, refer to User roles.

To download a report:

1. Log in to your Customer Area with your merchant-level account.
2. Go to Finance > Downloadable reports.
3. Select the report you want to download.

4. On the report page, enter a time-period for the generated report.

   For the Settlement details report, enter a settlement batch number instead.

5. Click Generate.

6. After the report has generated, under Earlier generated reports, click the file name. The report will download.

   Reports can take some time to process and generate.