Downloading reports

Download reports either in your Customer Area, or automate the downloading process.


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.

There are two ways to download reports: 

  • Download reports manually from your Customer Area
  • Automate the downloading process using a combination of our notifications service and HTTP GET requests. 

For additional security, you can also encrypt your reports with your PGP Key.

Download reports from your Customer Area

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 Account > See all charts and exports.
  3. Browse to the report that you want to download.
  4. Click Download below the name of the report.
  5. Under Earlier generated reports, click the file name.

Some reports are queued for processing, and can take a while to generate. When a queued report has been generated, you can find it by clicking Download below the name of the report. To download the report, go to Earlier generated reports, and click the file name.

Automate the downloading process

You can automate the downloading process using a combination of:

Receive report notifications

Notifications are HTTP callbacks (webhooks) that are sent to an endpoint on your server. For more information on how to set up notifications, refer to Set up notifications.

Once you've set up notifications, your server will receive a REPORT_AVAILABLE notification whenever a new report has been generated. This notification contains the following fields:

  • pspReference – the file name of the report
  • reason – the URL that you can use 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>
originalReference=&reason=https%3A%2F%2Fca-test.adyen.com%2Freports%2Fdownload%2FMerchantAccount%2F[merchantAccountCode]%2Fsettlement_detail_report_batch_12.csv&merchantAccountCode=[merchantAccountCode]&eventCode=REPORT_AVAILABLE&operations=&success=true&paymentMethod=&currency=EUR&pspReference=settlement_detail_report_batch_12.csv&merchantReference=&value=0&live=true&eventDate=2018-01-08T09%3A08%3A47.17Z

Download report

When you receive a REPORT_AVAILABLE notification, you can download the report with an HTTP GET request. In the request, include the URL of the report file name and your credentials:

Merchant Account Reports:

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

Company Account Reports:

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

You may not want to download every report that is generated. To determine whether you want to download the report, you can parse the filename of the report. The following file naming conventions are used for our commonly downloaded reports:

Report type File name format
Settlement detail report

settlement_detail_report_batch_[Batch Number].csv

Parameters:

  • [Batch Number] – sequential number of the settlement batch
Aggregate settlement report

settlement_report_aggregate_[yourAccountname]_[countrycode]_[additionalData]_[fromdate]_[untildate].csv

Parameters:

  • [yourMerchantAccount] – Adyen company or merchant account name
  • [countryCode] First country code in case the report is limited to one or more merchant countries
  • [additionalData] Indicates whether aggregation by Store, Terminal, or both is enabled. Possible values: empty, "S", "T", or "ST".
  • [fromdate] The start date of report. Format: yyyy-mm-dd
  • [untildate] The end date of report. Format: yyyy-mm-dd
Payment accounting report

payments_accounting_report_[date].csv

Parameters:

  • [date] – the date for which the report is generated. Format: yyyy-mm-dd
Dispute report

dispute_report_[date].csv

Parameters:

  • [date] – the date for which the report is generated. Format: yyyy-mm-dd

Receive encrypted report files

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 AccountSettings > 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.

When you do this, all future generated reports will be encrypted with this PGP key.