Motivation

The purpose of this document is to detail the steps and approaches for automating the process of downloading settlement reports from Adyen and uploading them to Google Drive

User Benefit

Reducing manual effort

Pre Automation Steps

• Enable Adyen Report Automation(Not required, Already configured)

  • As a merchant role click on the Report menu in the left navigation
  • Under Report overview search by “settlement details”
  • The Settlement details will appear, which needed to be configured for automatic generation and for selecting the format of the report i.e CSV
  • https://docs.adyen.com/reporting/automatically-get-reports - Follow this link for more detail

  

• Configure Webhook

  • Adyen uses notification webhooks for sending data back to the consumer platform(i.e Love, Bonito), this can happen for
    • Requests that were processed asynchronously like capturing a payment
    • Events that were not triggered by a request from the consumer i.e availability of a report, here we will discuss configuring webhook for report
  • Notifications are sent as HTTP callbacks to an endpoint on the consumer’s server
  • Adyen requires HTTPS endpoints with TLSv1.2, an endpoint that can receive, JSON, SOAP, or an HTTP POST
  • For live environments: An open TCP port for HTTPS traffic (443, 8443, or 8843) with TLSv1.2.
  • For testing environments: An open TCP port for HTTP traffic (80, 8080, or 8888) or HTTPS traffic (443, 8443, or 8843) with TLSv1.2.
  • Adyen also provides a basic authentication to secure the callback URL which the consumer need to provide while configuring it
  • For detailed configuration, go to Step 3 of this link - https://docs.adyen.com/development-resources/webhooks#set-up-notifications-in-your-customer-area
  • This video has detailed instructions https://vimeo.com/659248031
  • For report webhook configuration, the “Report Details” webhook needs to be chosen

  

Data - Frequency & Volume

• While configuring the Automatic Generation of reports the report schedule needs to be set, for which the frequency(Daily/Weekly/Monthly) of the report can be mentioned

  Currently, the frequency is set as daily, so every day Adyen will post the Report Available notification JSON data to the callback URL

• In the last 100 days, the maximum size of the report data generated for SG is 5.7 KB & the minimum is less than 1 KB. Attached is a report file for sample

settlement_detail_report_batch_445.csv

Solution Proposal

The report automation includes below tasks

1. Expose an endpoint from the consumer server - This is after building the API

2. Setting up a webhook - Manual

3. Accept Notification

   • Verify the HMAC signature included in the notification.

   <aside> 💡 This is to confirm that the notification was sent by Adyen, and was not modified during transmission. For more information, refer to Verify HMAC signatures. If the HMAC signature is not valid, Adyen does not recommend acknowledging the notification.

   </aside>

   • Store the notification in your database - We will use SQS

   • Acknowledge the notification with an HTTP 200 OK  and the following response body:

     [accepted]
     

   • Apply the business logic

   <aside> 💡 Need to make sure that acknowledgment of the notification happens before applying any business logic because a breakage in business logic could otherwise prevent important updates from reaching the system. The business logic explained in the next steps

   </aside>