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 v8 of the plugin. If you are using v9.0.1 or later, see the newer documentation.

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:

Install the plugin:
```
composer require adyen/module-payment
```
Enable the plugin:
```
bin/magento module:enable Adyen_Payment
```
Execute the update scripts:
```
bin/magento setup:upgrade
```
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 v8.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:

Install the plugin:

composer require adyen/adyen-magento2-expresscheckout:1.*

Enable the plugin:

bin/magento module:enable Adyen_ExpressCheckout

Execute the update scripts:
```
bin/magento setup:upgrade
```
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:

Log in to your Adobe Commerce admin panel.
In the left navigation bar, go to Stores > Configuration.
In the menu, go to Sales > Payment Methods and select Adyen Payments.
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.

Field	Description
Merchant Account	Name of your Adyen merchant account for which the payments will be processed.
Test/Production Mode	Select whether you want to use test or production mode.
Notification User Name	The username for basic authentication that you entered in your Adyen Customer Area. This is used for webhook authentication.
Notification Password	The password for basic authentication that you entered in your Adyen Customer Area. This is used for webhook authentication.
API key for Test	Your API key from the Adyen test Customer Area.
API key for Live	Your API key from the Adyen live Customer Area.
Client key for Test	Your client key from the Adyen test Customer Area.
Client key for Live	Your client key from the Adyen live Customer Area.
Live endpoint prefix	The prefix for your live URL. Get it from your Adyen live Customer Area > Developers > API URLs > Prefix.
Checkout frontend region	The region from which to load your frontend resources, for example, secured field iframes. Must match the region of your live endpoint.
Charged currency	Currency used for Adyen payment processing. To make sure that payments are processed in the expected currency, you can only change this setting outside of the user interface. Possible values: - Display currency (default) – The store view or display currency is used. - Global/Website currency – The base currency is used. Depending on how Adobe Commerce is configured, this will be either the Global or the Website currency.
Enable debug logging	Select Yes to enable debug logging on the Adobe Commerce server.

Field	Description
Merchant Account	Name of your Adyen merchant account for which the payments will be processed.
Test/Production Mode	Select whether you want to use test or production mode.
Notification User Name	The username for basic authentication that you entered in your Adyen Customer Area. This is used for webhook authentication.
Notification Password	The password for basic authentication that you entered in your Adyen Customer Area. This is used for webhook authentication.
API key for Test	Your API key from the Adyen test Customer Area.
API key for Live	Your API key from the Adyen live Customer Area.
Client key for Test	Your client key from the Adyen test Customer Area.
Client key for Live	Your client key from the Adyen live Customer Area.
Live endpoint prefix	The prefix for your live URL. Get it from your Adyen live Customer Area > Developers > API URLs > Prefix.
Charged currency	Currency used for Adyen payment processing. To make sure that payments are processed in the expected currency, you can only change this setting outside of the user interface.Possible values: - Display currency (default) – The store view or display currency is used. - Global/Website currency – The base currency is used. Depending on how Adobe Commerce is configured, this will be either the Global or the Website currency.
Enable debug logging	Select Yes to enable debug logging on the Adobe Commerce server.

Watch how to configure the plugin in Adobe Commerce:

Step 4 (optional): Configure order management settings

Log in to your Adobe Commerce admin panel.
In the left navigation bar, go to Stores > Configuration.
In the menu, go to Sales > Payment Methods.
Select Advanced settings. Here you can find sections for configuring several advanced settings, explained below.

Field	Description
Use manual capture for PayPal	Select Yes if you want to use manual capture for your PayPal integration. To change this setting, you first need to contact our Support Team.
Capture on shipment for open invoice methods (Klarna, Afterpay, and RatePAY)	Select Yes to automatically capture buy now, pay later (open invoice) payments such as Klarna, Afterpay, and Ratepay when a new shipment is created in Adobe Commerce. You can not use this functionality if you have enabled auto-capture for buy now pay later payment methods.
Use auto-capture for OpenInvoice payments	Select Yes if you want to use automatic capture for your Buy Now Pay Later payment methods (Klarna, Afterpay, and Ratepay). To change this setting, you first need to contact our Support Team.
Send order confirmation email for Bank Transfer/SEPA	Select Yes to send a confirmation email to the shopper, after you received a PENDING webhook from Adyen.
Sepa Payment flow	Choose the payment flow that you want to use for SEPA payments. Possible values: - Sale – Use immediate automatic capture for SEPA payments. This is the default setting. - Auth/Cap – Use the value that you set for Capture Delay in Adyen Customer Area.
Capture Delay	The capture delay that you set in Adyen Customer Area. Possible values: - manual – Select this if you set capture delay to manual (manual capture). - immediate – Select if you set capture delay to immediate.
Order status: order creation	Only applicable to payments processed with the redirect method: status given to orders before receiving an AUTHORISATION webhook from Adyen. For more information, refer to Order management.
Order status: payment authorisation	Only applicable to payments with manual capture: status given to orders after receiving a successful AUTHORISATION webhook from Adyen. For more information, refer to Order management.
Order status: payment confirmed	Status given to orders after the payment has been completed. When this happens depends on whether the capture is manual or automatic. - Manual capture: after receiving a successful CAPTURE webhook from Adyen. - Automatic capture: after receiving a successful AUTHORISATION webhook from Adyen. For more information, refer to Order management.
Order status: order cancellation	Status given to orders after receiving one of the following webhooks from Adyen: - a successful CANCELLATION webhook - an OFFER_CLOSED - successful CANCEL_OR_REFUND webhook
Order status: payment capture (virtual products)	Status given to orders of virtual products after payment is confirmed. By default, this is the same as for normal products.
Order status: pending Bank Transfer/SEPA orders	Status given to orders after receiving a PENDING webhook from Adyen. By default, Adyen does not inform your Adobe Commerce store about pending payments. To set them up, add BankTransfer pending and Direct-debit pending webhooks when setting up webhooks.