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 BETA 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 the following:

  • Shopware v.6.2 and higher, using PHP 7.0 and higher.

Our Shopware 6 plugin is currently in BETA. Support for additional payment methods and features will be added in future versions.

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 2.

Step 2: Install and configure the Shopware plugin

  1. Download the plugin from GitHub.
  2. In the root of your Shopware 6 application, in the custom/plugins folder, create an AdyenPayment folder and then add the plugin in the custom/plugins/AdyenPayment folder.
  3. Run composer install --no-dev in the custom/plugins/AdyenPayment folder to install the necessary dependencies.
  4. Install the plugin by running bin/console plugin:install --clearCache AdyenPayment
  5. Log in to the Shopware backend, and go to Settings > System > Plugins.
  6. Switch the Adyen Payment plugin to Active.
  7. Fill out the required fields as described in the following table:

    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-
    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-
  8. In the Shopware backend, navigate to Storefront > Payment methods.
  9. Switch Credit cards to Active.

Step 3: Set up notifications

Notifications are not supported by this BETA version of our Shopware 6 plugin. The ability to process notifications will be added in a future version of the plugin. You may wish to prepare for this now by following the steps below.

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 /frontend/notification/index as a suffix. For example, https://www.example.com/frontend/notification/index.
  5. Select the Active checkbox.
  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.

When testing notifications from the Adyen backend, you'll receive a 'notification save error' because the notification couldn't be matched with an existing order.

Manage orders

You can manage orders and view transaction summaries in Shopware, while switching to Adyen for more detailed reporting and conversion analytics. The two platforms are synchronized. 

View payment status

You can view the statuses of your payments in Shopware.

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

Refund an order

Refunds are not supported by this BETA version of Shopware 6 plugin. The ability to refund an order will be added in a future version of the plugin.

See also