Adyen

A step-by-step guide for setting up your Adyen dispute integration in the Payrails portal.

📘

Who should use this guide

This guide is intended for merchants who:

  • Use Payrails as chargeback
  • Use Adyen Disputes

We use a server-to-server integration with Adyen, so your account must be enabled to process dispute. If this isn’t enabled, chargebacks won’t work in production. Please contact your Adyen account manager or support team to activate it.

How to request permission for Disputes API management
  1. Locate the credential used for the integration with Payrails (eg "WS_XXXXXX").

    1. On the section "Permissions > UNCATEGORIZED"
    2. locate and check the checkbox: "[X] API dispute management"
    3. Click "Save changes"
  2. Email [email protected]. Optionally copy the Payrails Support team. In your request, confirm that Payrails will act as the chargeback orchestrator:

Dear Adyen team, Please enable "Permissions > UNCATEGORIZED > API dispute management" on WS user "WS_XXXXX" for "MERCHANT_NAME" to be used with Payrails Integration.


Create and configure an Adyen integration in Payrails

  1. Log in to the Payrails portal.
  2. Go to SettingsIntegrations.
  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 Dispute and continue to the next step.
A screenshot showing Dispute selected as the integration type.

Step 2: Choose the provider

  • Select Adyen and continue to the next step.
A screenshot showing the Adyen integration selected.

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 to your Adyen merchant dashboard to complete this step.


Integration instance name

In Payrails

  • Enter an Instance name for your integration.
A screenshot showing the Payrails integration instance name field.

Merchant account name

In Adyen

  1. Log in to your Adyen dasboard.
  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).
A screenshot showing the Adyen dashboard menu.

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 DevelopersAPI URLs.
  2. Copy the Prefix value.
A screenshot showing the Adyen API URLs.

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 DevelopersAPI credentials.
  2. Select Create new credential.
  3. Choose Web Service User.
  4. Create the credential and copy the API key.
A screenshot showing the create a new API credential form.

In Payrails

  • Paste the value into the API key field.

HMAC key (webhook signing key)

🔔

Payrails uses Adyen webhooks to receive asynchronous chargeback 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.
A screenshot showing the Payrails integration instance name field.

In Adyen

  1. Go to DevelopersWebhooks.

  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.

A screeshot showing the Adyen webhook HMAC field..

In Payrails

  • Paste the HMAC key into the HMAC key field.
  • Return to the integration overview after your changes are saved.


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 chargebacks


Next steps

  1. Run a test payment triggering a chargeback using a Adyen test card.
  2. Verify that:
    • The dispute appears in Adyen.
    • The chargeback status updates correctly in Payrails.
  3. Once verified in test mode, repeat the setup in live mode.