> ## 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
> Connect an Adyen account to Payrails: create the integration, configure API credentials and webhooks, and enable raw card data processing.
**Who should use this guide**
This guide is intended for merchants who:
* Use **Payrails** as a payment orchestrator
* Use **Adyen Payments**
* Are approved to process **raw card data**
We use a server-to-server integration with Adyen, so your account must be enabled to process raw card data. If this isn't enabled, payments won't work in production. Please contact your Adyen account manager or support team to activate it.\_
1. Email [support@adyen.com](mailto:support@adyen.com) and copy
[pcisupport@adyen.com](mailto:pcisupport@adyen.com). 2. Optionally copy
the Payrails Support team. 3. In your request, confirm that **Payrails will
act as the payment orchestrator and handle card data processing**. 4. Include:
* The **WS user** associated with your Adyen account \* The **Payrails PCI
compliance document**
***
## Create and configure an Adyen integration in Payrails
1. Log in to the **Payrails** portal.
2. Go to **Settings** → **Integrations**.
3. Select **Add instance** to create a new Adyen integration configuration.
4. Select the **Workspaces** where this integration should be available.
**About Workspaces**
Workspaces determine where this integration is available. They let you isolate provider setups by region or business line, or share the same configuration across multiple Workspaces.
***
## Step 1: Choose the integration type
* Select **Payment** and continue to the next step.
***
## Step 2: Choose the provider
* Select **Adyen** and continue to the next step.
***
## Step 3: Configure your Adyen integration
**What you'll need from Adyen**
Before you begin, make sure you have access to:
* Adyen merchant account name
* Adyen API key (Web Service User)
* Prefix (production only)
* Webhook HMAC key
[Log in](https://ca-live.adyen.com/ca/ca/login.shtml) to your Adyen merchant dashboard to complete this step.
***
### Integration instance name
> An integration instance is a specific payment provider setup in Payrails. You can create multiple instances for each provider based on region, currency, or business needs. Choose a clear, consistent name, as it is used in routing.
**In Payrails**
* Enter an **Instance name** for your integration.
***
### Merchant account name
**In Adyen**
1. [Log in](https://ca-live.adyen.com/ca/ca/login.shtml) to your Adyen dashboard.
2. Click the company logo or name in the top-left corner.
3. From the list of merchant accounts, copy the **Merchant account name**\
(not the company account).
**In Payrails**
* Paste the value into the **Merchant account name** field.
***
### Prefix (production only)
The prefix is required in **production** but not in **staging**. You can leave
this field blank in staging environments.
**In Adyen**
1. Go to **Developers** → **API URLs**.
2. Copy the **Prefix** value.
**In Payrails**
* Paste the value into the **Prefix** field.
***
### API key
Use a dedicated Web Service User API key and store it securely.
**In Adyen**
1. Go to **Developers** → **API credentials**.
2. Select **Create new credential**.
3. Choose **Web Service User**.
4. Create the credential and copy the **API key**.
**In Payrails**
* Paste the value into the **API key** field.
***
### HMAC key (webhook signing key)
Payrails uses Adyen webhooks to receive asynchronous payment status updates.
Create the webhook in the same environment (test or live) as your Payrails
integration.
**In Payrails**
* Copy the **Notification URL** from the webhook section.
**In Adyen**
1. Go to **Developers** → **Webhooks**.
2. Create a new **Standard webhook**.
3. Select **only** the merchant account you are configuring.
4. Paste the Payrails notification URL into the **URL** field.
5. In **Security**, generate a new **HMAC key** and copy it.
6. In **Events**, enable all standard events.
7. Save the webhook configuration.
**In Payrails**
* Paste the HMAC key into the **HMAC key** field.
* Return to the integration overview after your changes are saved.
***
### Payment methods
**In Payrails**
* Select the payment methods that should be enabled for this integration.
### Checkout API version (v69 or v72)
**About this setting**
Payrails supports two Adyen Checkout API versions: **v69** (default) and **v72**. The version is set per provider instance, so you can control exactly which integration uses which version.
**In Payrails**
* Under your Adyen integration instance, locate the **Checkout API version** field.
* Choose **v69** (default) or **v72**.
**v72 is not backward compatible with v69**
Requests that succeed on v69 can fail on v72 if your integration doesn't send the fields v72 requires. Review the table below and confirm your integration meets these requirements **before** switching a live instance to v72.
| # | Requirement on v72 | Who this affects | What happens if not met |
| - | - | - | - |
| 1 | A processing type (`CardOnFile`, `Subscription`, or `UnscheduledCardOnFile`) is **required** on any payment that stores a card or charges a stored card | Saved cards, one-click checkout, subscriptions, MOTO | Payment is declined |
| 2 | The CVC is **required** when charging an already-saved card as `CardOnFile` | One-click / "pay with saved card" flows that don't collect the security code | Payment is declined |
| 3 | The `state` field is limited to **3 characters** | Merchants sending a full state/province name rather than an ISO code (common for US, CA, BR, AU) | Payment is declined — send the ISO-3166-2 code (e.g. `CA`, not `California`) |
| 4 | The `postalCode` field is limited to **10 characters** | Merchants with postal codes longer than 10 characters | Payment is declined |
Saving a brand-new card as `CardOnFile` does **not** require a CVC — this only applies when charging a card that was previously saved. `Subscription` and `UnscheduledCardOnFile` payments never require a CVC.
**Recommended rollout**
1. Enable **v72** on a **staging** provider instance first and run your full payment flows end to end (new card, saved card, subscriptions, refunds, MOTO/wallet if used).
2. In production, create a **new** Adyen provider instance on v72 rather than switching your existing v69 instance, and route a small share of traffic to it.
3. Gradually increase traffic to the v72 instance over a few days while monitoring authorization rates and error codes.
**Rollback**
Switching a provider instance's Checkout API version back to v69 takes effect on the next payment immediately — no deployment or code change required.
***
## Enable the integration
**In Payrails**
* Select **Save account** Save the configuration to enable the integration.
The **Enabled** status confirms that the Adyen integration is active.
Your Adyen integration is now ready to process payments
***
## Next steps
1. Run a test payment using an Adyen [test card](https://docs.adyen.com/development-resources/test-cards-and-credentials/test-card-numbers).
2. Verify that:
* The payment appears in Adyen.
* The payment status updates correctly in Payrails.
3. Once verified in test mode, repeat the setup in live mode.
→ Continue to: [Test a payment](/docs/orchestration/payment-acceptance/test-payments)
## Related topics
- [Adyen](/docs/chargebacks/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)