Are you looking for test card numbers?

Would you like to contact support?

Plugin icon

Set up the plugin in Adobe Commerce

Install Adyen's plugin for Adobe Commerce, and configure it in your Adobe Commerce admin panel. 

This page describes the plugin setup for versions earlier than 9.0.1. If you are using version 9.0.1 or later, see Set up the plugin in Adobe Commerce.

Step 1: Install the plugin

Adyen's plugin for Adobe Commerce (formerly Magento 2) is open-source and available on GitHub. The GitHub repository is connected to Packagist, so you can easily include it in your project through Composer.

Before you begin, make sure that you have installed Composer. In your command-line tool, go to the Adobe Commerce folder and run the following commands:

  1. Install the plugin:

    composer require adyen/module-payment
  2. Enable the plugin: 

    bin/magento module:enable Adyen_Payment
  3. Execute the update scripts:

    bin/magento setup:upgrade
  4. Flush cache storage:

    bin/magento cache:flush

    If you are using a caching layer such as Varnish, you need to exclude the following URL pattern from being cached: /adyen/process/*.

(Optional) Use Express Checkout flows

Only possible with the Adobe Commerce plugin version 8.8.0 or later.

Express Checkout is available for Apple Pay and Google Pay. To activate the Express Checkout Module, go to the Adobe Commerce (formerly Magento 2) folder and run the following commands in your command-line tool:

  1. Install the plugin:

    composer require adyen/adyen-magento2-expresscheckout
  2. Enable the plugin: 

    bin/magento module:enable Adyen_ExpressCheckout
  3. Execute the update scripts:

    bin/magento setup:upgrade
  4. Flush cache storage:

    bin/magento cache:flush

Step 2: Run cron

To process webhooks, update the cache, and close unfinished orders, you need to have cron running on your server. For instructions on how to set up cron in Adobe Commerce, refer to Configure and run cron.

The cron job generation time interval for the adyen_payment group is set to one minute. 

Step 3: Configure the plugin in Adobe Commerce

Before you begin, make sure that you have set up your Adyen Customer Area.

There are two ways 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.

Configure the Adyen plugin in your Adobe Commerce admin panel: 

  1. Log in to your Adobe Commerce admin panel. 
  2. In the left navigation bar, go to Stores > Configuration
  3. In the menu, go to Sales > Payment Methods and select Adyen Payments.
  4. Select Required settings and fill out the following fields: 
Field Description
Configuration Mode Select Automated.
Environment Select whether you want to use test or live environment.
Test/Live API Key The API key you generated in the Adyen test or live Customer Area.
Client key for Live/Test Automatically fetched from your Customer Area.
Merchant Account Name of your Adyen merchant account for which the payments will be processed.
Webhook Username Automatically generated when the webhook configuration is automatically created in the Customer Area. This is the username for basic authentication that webhooks from Adyen will be using.
Webhook Password Automatically generated. This is the password for basic authentication that webhooks from Adyen will be using.

Watch how to configure the plugin in Adobe Commerce:

See also

Next steps