---
title: "Set up the plugin in Adobe Commerce"
description: "Install Adyen's plugin for Adobe Commerce, and configure it in your Adobe Commerce admin panel."
url: "https://docs.adyen.com/plugins/adobe-commerce/set-up-the-plugin-in-adobe-commerce"
source_url: "https://docs.adyen.com/plugins/adobe-commerce/set-up-the-plugin-in-adobe-commerce.md"
canonical: "https://docs.adyen.com/plugins/adobe-commerce/set-up-the-plugin-in-adobe-commerce"
last_modified: "2024-05-27T10:35:00+02:00"
language: "en"
---

# Set up the plugin in Adobe Commerce

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

[View source](/plugins/adobe-commerce/set-up-the-plugin-in-adobe-commerce.md)

## Step 1: Install the plugin

**Implementation examples**\
![](/images/b/2/2/1/b/b221b265a9c6b77a7b46951d7e3db0fc381397ba-github-icon.png)  [Try it out on GitHub!](https://github.com/adyen-examples/adyen-magento-plugin-demo)

Adyen's plugin for Adobe Commerce (formerly Magento 2) is open-source and available on [GitHub](https://github.com/adyen/adyen-magento2/tree/master). The GitHub repository is connected to Packagist, so you can easily include it in your project through [Composer](https://getcomposer.org/).

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

The Express Checkout module enables [express checkout](/payment-methods/express-checkout/) with [Apple Pay](/payment-methods/apple-pay) and [Google Pay](/payment-methods/google-pay) and [PayPal](/payment-methods/paypal). To use the module, you must be using:

* Adobe Commerce [v2.4.4](https://experienceleague.adobe.com/en/docs/commerce-operations/release/notes/adobe-commerce/2-4-4) or later.
* Adyen Adobe Commerce plugin [v8.8.0](/plugins/release-notes/?title%5B0%5D=Magento%202#releaseNote=2022-10-21-magento-2-8.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:

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](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/configure-cron-jobs.html).

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](https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/configure/service/rabbitmq.html?lang=en). After you have set up the queuing, you have to enable the queue in Adobe Commerce:

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. 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](/plugins/adobe-commerce/set-up-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**.

4. Select **Configure** next to **Adyen Payments**.

5. Select **Initial setup** and fill out the following fields: 

   ### Tab: Automated

   | 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 test or live Customer Area](/plugins/adobe-commerce/set-up-adyen-customer-area?tab=automated_1#step-1-generate-your-api-and-client-keys).                 |
   | **Test/Live Client key** | 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.                                                                              |

   ### Tab: Manual

   | Field                         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
   | **Configuration Mode**        | Select **Manual**.                                                                                                                                                                                                                                                                                                                                                                                                                               |
   | **Environment**               | Select whether you want to use test or live environment.                                                                                                                                                                                                                                                                                                                                                                                         |
   | **Test/Live API key**         | The API key you [generated in the test or live Customer Area](/plugins/adobe-commerce/set-up-adyen-customer-area?tab=manual_2#step-1-generate-your-api-and-client-keys-1).                                                                                                                                                                                                                                                                       |
   | **Test/Live Client key**      | The API key you [generated in the test or live Customer Area](/plugins/adobe-commerce/set-up-adyen-customer-area?tab=manual_2#step-1-generate-your-api-and-client-keys-1).                                                                                                                                                                                                                                                                       |
   | **Merchant Account**          | Name of your Adyen merchant account for which the payments will be processed.                                                                                                                                                                                                                                                                                                                                                                    |
   | **Webhook Username**          | The username for basic authentication that you [configured in your Adyen Customer Area](/plugins/adobe-commerce/set-up-adyen-customer-area?tab=manual_2#step-3-set-up-webhooks). This is used for webhook authentication.                                                                                                                                                                                                                        |
   | **Webhook Password**          | The username for basic authentication that you [configured in your Adyen Customer Area](/plugins/adobe-commerce/set-up-adyen-customer-area?tab=manual_2#step-3-set-up-webhooks). This is used for webhook authentication.                                                                                                                                                                                                                        |
   | **HMAC Key test/live**        | The HMAC key you generated when you [set up webhooks](/plugins/adobe-commerce/set-up-adyen-customer-area#step-3-set-up-webhooks).                                                                                                                                                                                                                                                                                                                |
   | **Front-end Resource 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. |

6. Select **Save Config**.

## Step 4: Configure order management settings

1. In your Adobe Commerce admin panel, go to **Stores** > **Configuration**. 
2. In the menu, go to **Sales** > **Payment Methods**.
3. Select **Configure** next to **Adyen Payments**.
4. 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](/plugins/adobe-commerce/set-up-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 for open invoice methods** | 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](https://ca-test.adyen.com/ca/ca/contactUs/support.shtml?form=other) to change this setting.                                    |
| **Use manual capture for PayPal**    | Select **Yes** if you want to use [manual capture](/online-payments/capture#manual-capture) for your PayPal integration. To change this setting, you need to contact our [Support Team](https://ca-test.adyen.com/ca/ca/contactUs/support.shtml?form=other).                                                                                     |
| **SEPA payment flow**                | Choose the payment flow that you want to use for SEPA payments. Possible values:* **Sale**: Use [automatic capture](/online-payments/capture) for SEPA payments. This is the default setting.* **Auth/Cap**: Use the value that [you set for **Capture Delay**](/online-payments/capture/#delayed-automatic-capture) in the Adyen Customer Area. |

### Order status

You can define [custom status names](https://experienceleague.adobe.com/docs/commerce-admin/stores-sales/order-management/orders/order-status.html?lang=en#custom-order-status) 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](https://docs.adyen.com/api-explorer/Webhooks/1/post/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](https://ca-test.adyen.com/) > **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:* [AUTHORISATION](https://docs.adyen.com/api-explorer/Webhooks/1/post/AUTHORISATION)if capture mode is immediate* [CAPTURE](https://docs.adyen.com/api-explorer/Webhooks/1/post/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](https://ca-test.adyen.com/) > **Server Communication** and select **BankTransfer Pending Webhook** and **Direct-Debit Pending Webhook**. |

## Next steps

[required](/plugins/adobe-commerce/set-up-the-payment-methods-in-adobe-commerce)

[Set up the payment methods](/plugins/adobe-commerce/set-up-the-payment-methods-in-adobe-commerce)

[Set up the payment methods you want you offer to your shoppers.](/plugins/adobe-commerce/set-up-the-payment-methods-in-adobe-commerce)

[Set up stored payment methods](/plugins/adobe-commerce/set-up-tokenization)

[Store your shopper's payment details for later payments.](/plugins/adobe-commerce/set-up-tokenization)

[required](/plugins/adobe-commerce/go-live-checklist)

[Configure your live account](/plugins/adobe-commerce/go-live-checklist)

[Follow this checklist before you start accepting live payments.](/plugins/adobe-commerce/go-live-checklist)
