> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Adyen

> Generate Adyen API credentials and a report user, then connect Adyen as a data source for transaction and settlement data.

This guide will help you generate Adyen API credentials and connect Adyen as a data source in Payrails to ingest transaction & settlement data. With the self-serve flow you configure the integration yourself in the Payrails portal.

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

### Step 3: Add the Adyen integration in the Payrails portal (self-serve)

1. Log in to the Payrails dashboard and open **Settings → Integrations → Data**.
2. Click **Add instance** (top-right).
3. In New instance, select provider: **Adyen** and click **Continue**.
4. On **Configure Adyen account**, fill in:
   * **Integration instance name** — a unique label that helps you identify this account.
   * **Start Date** — the date of today or tomorrow (currently we can not backfill over the self-serve capability. In the need of backfilling, please reach out to your Payrails account manager).
   * **Is Live** — enable for a production (live) account; leave off for test.
   * Input required for (at least) one of the below items:
     * **Company account** — your Adyen company account name.
     * **Merchant accounts** — add each merchant account you want to ingest data for (use **+** to add more).
   * **API key** — the report service user API key from Step 2. (If you use Adyen for Platforms, also provide the Balance Platform report API key as instructed by the form.)
   * *(Optional)* **Additional data**.
5. Click **Save account**. The instance appears in the Data integrations list and Payrails begins ingesting data.


## Related topics

- [Adyen](/docs/orchestration/integrations/adyen.md)
- [Self-served migration of card data from PSPs](/docs/token-vault/token-migration/self-serve-migration.md)
- [Integrations](/docs/orchestration/integrations/index.md)