Search

Are you looking for test card numbers?

Would you like to contact support?

Plugin icon

Shopware 6

Use Adyen's plugin for Shopware 6 to accept payments.

  Try it out!
You can find the latest version of our plugin on GitHub.

Our plugin for Shopware 6 gives you access to the native payment features of the Adyen payments platform. After you've set up the plugin, you can:

Our plugin supports Shopware v6.3.1.1 and higher, using PHP 7.0 and higher.

Before you begin

Before you begin to integrate Shopware 6 with the Adyen payments platform, make sure that you have performed the following steps:

  1. Sign up for a test account with Adyen at https://www.adyen.com/signup.
  2. Apply for a live account with Adyen. For more information, refer to Apply for a live account.

Step 1: Generate an API key

To authenticate API requests from Shopware, you need to provide an API key that's generated in your Adyen Customer Area.

To generate an API key:

  1. Log in to your Customer Area.
  2. Go to Account > API credentials, and select the credential for your integration, for example ws@Company.[YourCompanyAccount].
  3. Under Authentication, select Generate New API Key.
  4. Copy and securely store the API key in your system — you won't be able to restore it later.
    If your API key is lost or compromised, you need to generate a new one.
  5. Select Save at the bottom of the page.

You will need to enter the API key in the Shopware backend in Step 3.

Step 2: Generate a client key

For client-side authentication, we use a client key that's generated in your Adyen Customer Area. The client key is linked to your API credential and a list of domains from which we expect to get your client-side requests.

To generate a client key:

  1. Log in to your Customer Area.
  2. Go to Account > API credentials, and select the API credential for your integration, for example ws@Company.[YourCompanyAccount].
  3. Add your domains under Allowed origins. These are the domains from which you will be sending your client-side requests.
  4. Under Authentication, select Generate New Client Key.
  5. Select Save.

You now have a client key for your test environment. To get a client key for your live environment, follow the same steps in your live Customer Area.

You will need to copy the test and live client keys and add them in the Shopware back office as described in Step 3.

Step 3: Install and configure the Shopware plugin

  1. There are two ways to get the plugin package:

    • Download the plugin from the Shopware Store and upload it to custom/plugins directory of the Shopware instance.
    • Or in your Shopware project root directory, run composer require adyen/adyen-shopware6. Composer will take care of the required dependencies.
  2. Log in to the Shopware backend and go to Settings > System > Plugins.
  3. Find the Adyen Payment plugin, and select the action button (...) > Install.
    This adds all supported payment methods to your Shopware instance.
  4. Toggle the Activate.
    This enables all payment methods and allows you to configure the plugin.
  5. Select Config, and fill out the following fields:

    If you have more than one Shopware shop, you need to set up these configurations for each shop.

    Field Notes Required field
    Merchant account Name of your Adyen merchant account for which the payments will be processed. -white_check_mark-
    API Key for test Your API key from your Adyen test Customer Area. The following API permissions must be activated in the backend of Adyen:
    • API Clientside Encryption Payments role
    • Checkout webservice role
    -white_check_mark-
    API Key for live Your API key from your Adyen live Customer Area. The following API permissions must be activated in the backend of Adyen:
    • API Clientside Encryption Payments role
    • Checkout webservice role
    -white_check_mark-
    Client Key for test Your client key from your Adyen test Customer Area. -white_check_mark-
    Client Key for live Your client key from your Adyen live Customer Area. -white_check_mark-
    Environment Select whether you want to enable live (production) mode or keep using test mode. -white_check_mark-
    Live endpoint URL prefix The URL prefix [random]-[company name] from your Adyen live Customer Area > Account > API URLs. For more information, refer to Checkout endpoints.
    This field is only required for live (production) mode. For test purposes, enter any value.
    -x-
    Username for standard notifications This can be any username, as long as it matches the username for basic authentication that you entered in your Adyen Customer Area. -white_check_mark-
    Password for standard notifications This can be any password, as long as it matches the password for basic authentication that you entered in your Adyen Customer Area. -white_check_mark-
    HMAC Key for test The HMAC key that you generated in your Adyen account.
    1. Log in to your test Customer Area. If you have set up notifications at the merchant level, switch to your merchant account.
    2. Go to Settings > Server Communication.
    3. Find the Standard Notification endpoint for which you want to enable HMAC, and select Edit & Test.
    4. Under Additional settings, select Generate New HMAC key.
    5. Securely store the HMAC key in your system - you won't be able to restore it later.
    6. Select Save Configuration.
    -white_check_mark-
    HMAC Key for live The HMAC key that you generated in your Adyen account.
    1. Log in to your live Customer Area. If you have set up notifications at the merchant level, switch to your merchant account.
    2. Go to Settings > Server Communication.
    3. Find the Standard Notification endpoint for which you want to enable HMAC, and select Edit & Test.
    4. Under Additional settings, select Generate New HMAC key.
    5. Securely store the HMAC key in your system - you won't be able to restore it later.
    6. SelectSave Configuration.
    -white_check_mark-
  6. In the Shopware backend, go to the desired sales channel, and add the payment methods to show in the checkout page.

Updating payment method logos

By default, the Shopware 6 plugin automatically keeps the logos for all your payment methods up to date.

To turn off automatic logo updating, in the Shopware 6 configuration file platform/src/Core/Framework/Resources/config/packages/shopware.yaml, set shopware.media.enable_url_upload_feature to false.

To manually update the logos, go to your Shopware 6 project root directory and run:

bin/console adyen:fetch-logos

Step 4: Set up notifications

Adyen uses notifications, our webhook service, to inform your Shopware platform of payment status changes. For more information, refer to Notifications

To receive notifications: 

  1. Log in to your Customer Area with your company-level account.
  2. Go to Account > Server Communication.
  3. Next to Standard Notification, select Add.
  4. In the URL box, enter your website URL followed by /adyen/notification as a suffix. For example, https://www.example.com/adyen/notification.
  5. Select Active.
  6. Set Method to JSON.
  7. In the User Name and Password boxes, enter a username and password for basic authentication.
  8. Select Save Configuration.

Manage orders

To manage orders and view transaction summaries, go to Shopware Administration, and then navigate to Orders > Overview. You can switch to Adyen for more detailed reporting and conversion analytics. The two platforms are synchronized via Notifications. 

View payment status

You can find the statuses of your payments in Shopware orders overview.

Shopware payment status Description
open The default state for new orders, it means no notification was received.
in progress The payment transaction is still in progress.
paid The payment was successful.
failed The payment authorization or capture failed or the payment expired or was canceled.

Refund an order

Refunds are not supported by this BETA version of Shopware 6 plugin. Refunds will be added in a future version of the plugin.

Update the plugin version

  1. Update the package based on how you installed the plugin:

    • If you installed the plugin from the Shopware Store: Download the newer version and replace the package in the custom/plugins directory of the Shopware instance.
    • If you installed the plugin using Composer: In your Shopware project root directory, run composer require adyen/adyen-shopware6. This will update the plugin to the latest version.

      Optionally, you can specify the version that you want to use. For example, to update to plugin version 1.2.0, run composer require adyen/adyen-shopware6:1.2.0.

  2. Run the database migration scripts bin/console database:migrate --all AdyenPaymentShopware6.

  3. Run the update script bin/console plugin:update AdyenPaymentShopware6.

Next steps