Adyen

This guide will help you generate Adyen API credentials to ingest transaction & settlement data from Adyen into your Payrails account.

Prerequisites

• An Adyen account.
• To be able to create API credentials, you must have one of the following user roles:
  • Merchant admin
  • Manage API credentials

Step-by-step instructions

Step 1: Log into your Adyen account to configure a set of automatic reports

1. Click the company name located in the top-left corner of the page, and choose the first merchant account from the dropdown menu. This step is crucial because these reports are configured per merchant account, allowing us to gather the most comprehensive details possible.
2. Click Reports in the left-side navigation panel.
3. Use the search bar to search for each of the following reports one at a time:
   1. 3D Secure authentication
   2. Aggregate settlement details
   3. Dispute transaction details
   4. Interchange and scheme fee report
   5. Payment accounting
   6. Received payment details
   7. Settlement details
4. Click Generate beside each report, then click Automated (generate on schedule). Turn Automatic generation on and select .CSV for the File type.

Step 2: Create a Report User in Your Adyen Account

1. 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.
2. Select Create new credential.
3. Under Credential type, select Report service user. You can add a description for the credential here.
   1. Make sure you have provided the API key with the BalancePlatform Report Download role.
4. Select Create credential.
5. To generate an API key select the API key tab under Server settings > Authentication. Select Generate API key, copy the API key using the copy icon and store your API key securely in your system.

Step 3: Add a new data integration on Payrails portal

1. Log in to Payrails portal and navigate to the workspace for which you want to configure the data sources.
2. Under Merchant configurations select Integrations.
3. Click on + Add instance.
4. Select Data as the integration type.
5. Select Adyen as provider.
6. Create a unique Integration instance name and add Company account and API key. You will need to create one integration per Adyen company account.
7. Select a Start Date to display data in dashboards. To include historical data, choose a date in the past. Data will be retrieved starting from your selected date. Please note only previously generated reports available in your account can be accessed by Payrails.
8. Add a list of Merchant accounts for which you want to retrieve data.
9. [Optional] Add Prefix