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:
   • 3D Secure authentication
   • Aggregate settlement details
   • Dispute transaction details
   • Interchange and scheme fee report
   • Payment accounting (please select to generate ALL fields in the report)
   • Received payment details (please select to generate ALL fields in the report)
   • 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.
4. Important: Make sure you have provided the API key with the Merchant Report Download role.
5. Select Create credential.
6. 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.

Adyen for Platforms (Balance Platform)

If you are using Adyen for Platforms, you must configure three additional balance reports and ensure your API credential has the specific platform reporting role.

Step 3: Configure Adyen for Platforms Reports

1. Log in to your Balance Platform Customer Area (or ensure you are viewing the relevant Company account).
2. Click Reports in the navigation panel.
3. Search for and configure the following three reports:
   • Balance Platform Accounting Report
   • Balance Platform Balance Report
   • Balance Platform Payout Report
4. For each report, click Generate, then select Automated (generate on schedule).
5. Turn Automatic generation on and select .CSV for the File type.

Step 4: Get the Balance Platform Report API Key

You can generally use the same Report service user credential created in Step 2. However, to access Balance Platform reports, you must explicitly add the platform-specific role to that user.

If you prefer to create a dedicated API key for these reports, follow the "Create a Report User" instructions in Step 2, then proceed below.

1. Log in to your Customer Area and go to Developers > API credentials.
2. Select the Report service user credential (e.g., the one created in Step 2).
3. Under Roles, search for BalancePlatform Report Download.
4. Enable this role.
   • Note: Without the "BalancePlatform Report Download" role, the API key will not have permission to fetch the platform-level balance reports, even if it works for standard transaction reports.
5. Click Save changes.
6. If you haven't already saved the API key for this user:
   • Go to Server settings > Authentication.
   • Select the API key tab.
   • Click Generate API key (or use the existing one if you have it stored).
   • Copy the key securely. This is your Adyen for Platform Balance Report API key.

Step 5: Share credentials with Payrails

Share your API credentials in a secured way with Payrails.

• You can use your preferred secrets manager or vault tool like 1Password Shared Vaults, AWS Secrets Manager, or GCP Secrets Manager.
• If a shared vault is not possible, you can also share credentials over PGP-encrypted file.