Plugins-2 icon

Set up Adyen Customer Area

To use Adyen's plugin for Adobe Commerce, you need to set up your Customer Area with Adyen.

There are two ways to set up the plugin. You select your preferred way when you configure the plugin in Adobe Commerce later. However, the configuration steps you have to complete in your Adyen Customer Area prior depends on the way you want to set up the plugin.

  • Automated: available for Adobe Commerce plugin version 8.4.0 or later.

    • We recommend this option if you are new to using the Adobe Commerce plugin.
    • The required settings are configured automatically for you by using your API key.
    • You can also reconfigure your integration using this option, but in that case the older configuration will be lost.
  • Manual: available for all Adobe Commerce plugin versions.

    • We recommend this option if you have used the Adobe Commerce (formerly Magento 2) plugin before.
    • You manually generate credentials and configure your integration.

Choose the way you want to set up your integration:

Step 1: Generate your API and client keys

  1. Log in to your Customer Area.
  2. Go to Developers > API credentials, and select the API credential username for your integration, for example ws@Company.[YourCompanyAccount], or create a new one by selecting Create new credential.
  3. Under Server settings > Authentication select the API key tab.
  4. Select Generate API key.
  5. Select the copy icon and store your API key securely in your system.
    You will need it when configuring the Adobe Commerce 2 plugin.
  6. Under Client settings > Authentication select the Client key tab.
  7. Select Generate client key.
  8. Under Add allowed origins, enter your domains and select Add.
  9. Select Save changes.

Step 2: Set up webhooks

Adyen uses webhooks to inform your Adobe Commerce platform of payment status changes. You need to configure standard webhooks in the Customer Area and enable the OFFER_CLOSED event code. This event code ensures that expired payments are automatically closed, for example if the shopper abandons the payment session.

The default setting for an order expiration date depends on the payment method:

  • Card payments: 12 hours
  • Other payment methods: up to 28 days

If you want to change the default setting, contact our Support Team to configure a custom expiry date and specify the merchant accounts, schemes and timeframe in hours or days.

Check that Adobe Commerce's Content Security Policy (CSP) is disabled in your webhook response. Otherwise, Adobe Commerce can add a CSP header into the webhook response that causes it to fail, because it exceeds Adyen's 8192 byte response header limit.

To set up webhooks: 

  1. In your Customer Area, go to Developers >  Webhooks.

    We recommend to configure webhooks for your company account. This ensures that you do not have duplicate webhook configurations, and improves performance.

  2. Select Webhook.

  3. From the list of webhooks, next to Standard webhook, select Add.
    Under General, configure the following:

    Setting Description
    Enabled Select the toggle to enable or disable the webhook.
    Version The webhook version.
    Description Your description of the webhook.
    Merchant accounts You can apply the webhook to all merchant accounts for a company account, include only specific merchant accounts, or exclude specific merchant accounts for your company account.
  4. Under Server configuration, configure the following:

    Setting Description
    URL Depends on your plugin version:
    • v9 or later: Your website URL followed by /adyen/webhook.
    • v8: Your website URL followed /adyen/process/json.
    Method JSON
    Encryption protocol TLSv1.2
  5. Under Security, configure the following:

    Setting Description
    Basic authentication Enter your server's username and password. You need to enter these credentials in the Adobe Commerce admin panel later.
    HMAC Key Generate the HMAC Key, copy it, and store it securely in your system. You need to enter the HMAC key in the Adobe Commerce admin panel later.
  6. Under Events settings, select the checkbox for the OFFER_CLOSED event code.

  7. If the Additional settings section is available, optionally select the additional information you want to receive in this webhook. Some webhook types do not support more than one event code, so this section does not appear.

  8. Select Save configuration.

Step 3: Set up capture delay

For credit cards, the payment is completed in two steps: 

  1. Authorisation – The payment details of the shopper are verified, and the funds are reserved.
  2. Capture – The reserved funds are transferred from the shopper to your account. 

You can either perform the capture manually in Adobe Commerce, or have it happen automatically after the payment has been authorized. 

To change the capture delay: 

  1. Log in to your Customer Area with your merchant account.
  2. Go to Settings > Account settings.
  3. In the Capture Delay drop-down menu, select one of the following: 
    • manual if you want to capture all payments manually in Adobe Commerce.
    • immediate if you want payments to be captured immediately after authorisation (this is the default setting).
  4. Select Save.

Next steps