Downloading reports

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

Report schedule

Reports are generated at 04:00 CET. This setting cannot be changed.

The report time for the Received payment detail report and Payment accounting report corresponds to the time zone information for each transaction included in the report end balances.

Subscribe to a report

When you subscribe to a report, we automatically generate this report, 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 subscribe to a report:

1. In your Customer Area, go to Finance > Downloadable reports.
2. Select the report to which you want to subscribe.

3. Click Subscribe.

   If a report can be scheduled, this button will say "Schedule". If you are scheduling a report, you also need to select how often you want to receive the specified report.

   • Daily - This report will be generated daily at 4AM CEST and contains the previous 24 hours of data.
   • Weekly - This report will be generated weekly on a specified weekday and contains the previous 7 days of data, e.g. if scheduled on Wednesday report will contain data Wednesday - Tuesday.
   • Monthly - This report will be generated on the first of the month and contains payment data for the previous calendar month.
4. In the pop-up window, select a format (XLS, PDF, CSV or XML).
5. After selecting your download format, click the Save button to store your settings.

You are now subscribed to the selected scheduled report.

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. Download the report with an HTTP GET request.
2. Include the URL of the report file name and your Report User credentials:

Merchant Account Reports:

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

Company Account Reports:

$ wget --http-user=[YourReportUser]@Company.[YourCompanyAccount] --http-password=[YourReportUserPassword] --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. Log in to your Customer Area with your company-level account.
2. Navigate to Account > Settings > Company Settings, and click Manage PGP Keys.

3. Under Upload a new PGP Key:

   1. Next to Purpose, check the Reports checkbox.
   2. Next to PGP Key, paste your public key.

4. Click Upload 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 detail 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.