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 v9.0.1 or later. If you are using an earlier version, see the older documentation.

Step 1: Install the plugin

Implementation examples
Try it out on GitHub!

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

The Express Checkout module enables express checkout with Apple Pay and Google Pay and PayPal. To use the module, you must be using:

Adobe Commerce v2.4.6 or later.
Adyen Adobe Commerce plugin v8.8.0 or later.

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

Enable the plugin:

bin/magento module:enable Adyen_ExpressCheckout

Execute the update scripts:
```
bin/magento setup:upgrade
```
Flush cache storage:
```
bin/magento cache:flush
```

(Optional) Use Hyvä Checkout

The Adyen Hyvä Checkout Compatibility module enables you to use the plugin with the Hyvä Checkout theme. To use the module, you must be using:

Adobe Commerce v2.4.3 or later.
Adyen Adobe Commerce plugin v9.5.2 or later.

To use Hyvä Checkout through our Compatibility module:

Install Hyvä Checkout by following instructions from Hyvä Docs.

Install the Adyen compatibility module:

composer require adyen/module-HYVA-CHECKOUT

Execute the update scripts:
```
bin/magento setup:upgrade
```
Flush cache storage:
```
bin/magento cache:flush
```

When configuring the plugin in Adobe Commerce, there are additional steps to follow to set up Hyvä Checkout.

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.

For webhook processing, you can also use RabbitMQ. For instructions on how to set up RabbitMQ queueing, refer to Set up RabbitMQ service. After you have set up the queuing, you have to enable the queue in Adobe Commerce:

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.
Under Testing and performance, set Webhook processor to Queue.

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.
Select Configure next to Adyen Payments.
Select Initial setup and fill out the following fields:
Select Save Config.

(Optional) Set up Hyvä Checkout

If you installed our Hyvä Checkout Compatibility module:

In your Adobe Commerce admin panel, go to Content > Design > Configuration.
Next to the store view that you want to use the Hyvä Checkout theme, select Edit.
Activate the Hyvä/default theme for the store view.
Select Save Configuration.
Go to Stores > Configuration > Hyvä Themes > Checkout > General.
Activate either Hyvä Default or Hyvä One Page for the store.

Step 4: Configure order management settings

In your Adobe Commerce admin panel, go to Stores > Configuration.
In the menu, go to Sales > Payment Methods.
Select Configure next to Adyen Payments.
Select Order management.

Capture settings

Fill out the following fields to configure capture settings:

Field	Description
Capture Delay	The capture delay that you set in Adyen Customer Area. Possible values: manual: Select this if you set capture delay to manual. immediate: Select if you set capture delay to automatic.
Capture delay for open invoice	Set a capture delay for open invoice methods. Possible values: On shipment: Capture will automatically happen when an order is shipped to the shopper. Immediate Manual Contact our Support Team to change this setting.
Use manual capture for PayPal	Select Yes if you want to use manual capture for your PayPal integration. To change this setting, you need to contact our Support Team.
SEPA payment flow	Choose the payment flow that you want to use for SEPA payments. Possible values: Sale: Use automatic capture for SEPA payments. This is the default setting. Auth/Cap: Use the value that you set for Capture Delay in the Adyen Customer Area.

Order status

You can define custom status names that the plugin can assign to your orders. The statuses are defined depending on the shopper actions or payment statuses.
Fill out the following fields to define different statuses for different occasions:

Field	Description
Order creation	The status for new orders before payment result confirmation via server webhooks from Adyen.
Payment authorisation	The status for orders that are confirmed by an AUTHORISATION webhook from Adyen.
Payment capture for virtual products	Status given to orders of virtual products after payment is confirmed. By default, this is the same as for normal products.
Pending bank transfer/SEPA orders	By default, Adyen does not inform your Adobe Commerce store about pending payments. If you want to receive these webhooks, go to your Customer Area > Server Communication and select BankTransfer Pending Webhook and Direct-Debit Pending Webhook.
Payment confirmed	The status for orders after capture result is confirmed by a webhook: AUTHORISATIONif capture mode is immediate CAPTURE if capture mode is manual capture.
Order cancellation	The status for orders after order cancellation is confirmed by a CANCEL_OR_REFUND webhook from Adyen. If orders are already invoiced, they will be refunded.
Send order confirmation email for Bank Transfer/SEPA	Send a confirmation email to the shopper after you received a PENDING webhook from Adyen. If you want these webhooks to be received, go to your Customer Area > Server Communication and select BankTransfer Pending Webhook and Direct-Debit Pending Webhook.

Next steps

required

Set up the payment methods.

Set up the payment methods you want you offer to your shoppers.

Set up stored payment methods

Store your shopper's payment details for later payments.

required

Configure your live account

Follow this checklist before you start accepting live payments.