Search

Are you looking for test card numbers?

Would you like to contact support?

Plugin icon

Shopware 5

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

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

Our plugin for Shopware 5 gives you access to all the features of the Adyen payments platform in one integration.

Our plugin supports the following:

  • Shopware v.5.6 and higher, using PHP 7.0 and higher.
  • Shopware's default cookie consent manager version 5.6.2 and later.

Features

Before you begin

Before you begin to integrate Shopware 5 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. While you test your integration, you can apply for a live account with Adyen.

Step 1: Install the plugin

You have the following options for installing the plugin:

Option 1: Download from the Shopware Store

To use this option, you need to have a valid Shopware Account, and a URL with a verified Shopware instance.

  1. Log in to the Shopware back end, and go to Configuration > Plugin Manager.
  2. Find the Adyen plugin, and select Download now.
  3. Enter your Shopware Account credentials.
  4. In the Plugin Manager, select Installed. Find the Adyen plugin, and select the pencil icon to open the plugin.
  5. Select Activate.

The plugin is now ready to be configured.

Option 2: Install with Composer

Adyen's plugin for Shopware 5 is open-source and available on GitHub. The GitHub repository is connected to Packagist, so you can include it in your project through Composer:

  1. In your command-line tool, go to the root of your Shopware 5 application and run composer require adyen/adyen-shopware5.
  2. In your Shopware back end, go to Configuration > Plugin Manager.
  3. Select Installed. Find the Adyen plugin, and select the pencil icon to open the plugin.
  4. Select Activate.

The plugin is now ready to be configured.

Option 3: Download from GitHub

  1. Clone the adyen-shopware5 GitHub repository.
  2. Go to the downloaded folder, and run composer install --no-dev.
  3. Copy the entire adyen-shopware5 folder into the custom/plugins folder in the root of your Shopware 5 application.
  4. Rename the adyen-shopware5 folder to AdyenPayment, so you now have: custom/plugins/AdyenPayment.
  5. In your Shopware back end, go to Configuration > Plugin Manager.
  6. Select Installed. Find the Adyen plugin, and select the pencil icon to open the plugin.
  7. Select Activate.

The plugin is now ready to be configured.

Step 2: Generate an API key in Adyen Customer Area

To authenticate API requests from Shopware, you need to provide an API key. You will need to enter the API key when setting up the Shopware back end in Step 4.

To generate an API Key:

  1. Log in to your Customer Area.
  2. Go to Developers > 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.

Make sure that your API credential has the following permissions:

  • API Clientside Encryption Payments role
  • Checkout webservice role

To get an API key for your live environment, follow the same steps in your live Customer Area.

Step 3: Generate a client key

The plugin needs the client key to show the input fields for card details.

The client key is linked to one or more allowed origins — the domains from which we expect to get your client-side requests. For example, if you're collecting shopper's payment information at: https://example.org/checkout, you would need to link the domain https://example.org as an allowed origin to your client key.

To generate a client key:

  1. Log in to your Customer Area.
  2. Go to Developers > 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 end as described in Step 5.

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 Developers > Webhooks.
  3. In the upper-right corner, select the + Webhook button.
  4. Next to Standard notification, select Add.
  5. In the URL box, enter your website URL followed by /frontend/notification/adyen as a suffix. For example, https://www.example.com/frontend/notification/adyen.
  6. Select the Active checkbox.
  7. Set Method to JSON.
  8. In the User Name and Password boxes, enter a username and password for basic authentication.
    You will need to enter these when setting up the Shopware back end in Step 4.
  9. Under Additional settings, select Generate new HMAC key.
    Securely save the HMAC key in your system - you won't be able to restore it later. You will need to enter the HMAC key when setting up the Shopware back end in Step 4.
  10. 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.

Step 5: Configure the plugin

  1. In your Shopware back end, go to Configuration > Plugin Manager.
  2. Select Installed. Find the Adyen plugin, and select the pencil icon to open the plugin.
  3. Enter the required fields as described in the table below:

If you have more than one shop, you have to set up the following configurations for each shop:

Field Notes Required field
Environment Select whether you want to use test or live (production) mode. -white_check_mark-
Merchant account Name of your Adyen merchant account for which the payments will be processed. -white_check_mark-
API key (Test) Your API key from Adyen test Customer Area. In the live environment, you can enter a dummy value here. -white_check_mark-
API key (Live) Your API key from Adyen live Customer Area. In the test environment, you can enter a dummy value here. -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-
API: URL prefix The URL prefix [random]-[company name] from your Adyen live Customer Area > Developers > API URLs. For more information, refer to Checkout endpoints.
This field is required for live (production) mode.
-x-
Notification HMAC (Live) The HMAC key that you generated in Step 3. -white_check_mark-
Notification Auth Username (Live) The username for basic authentication that you generated in Step 3. -white_check_mark-
Notification Auth Password (Live) The password for basic authentication that you generated in Step 3. -white_check_mark-
Google Merchant ID ID of your Google account for which the Google Pay payments will be processed (if applicable). -x-
Enable Payment Methods cache Cache the list of payment methods for better performance. -x-

With our Shopware 5 plugin, you cannot configure any payment method within the Shopware platform. The plugin dynamically gets available payment methods from Adyen, based on the billing country and the amount in the shopping basket of the shopper. You can add and manage payment methods from your Customer Area.

You need to assign the relevant payment methods to a corresponding shipping cost. To do so:

  1. Login to the Shopware backend and go to Configuration > Shipping cost to edit the fields.
  2. In the Payment Method tab, move the required payment methods from blocked to allowed.

You can change the language of the payment method name and description. To do so, go to Snippets in your admin panel within Shopware, and set the translated information to the following:

Field Namespace Name Value
Payment method title The value identified by adyen/method/name. ID of the payment method. The title you want to show for this payment method.
Payment method description The value identified by adyen/method/description. This value must match the one used for the adyen/method/name snippet. The description you want to show next to the payment method name.

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. 

When a shopper makes a payment using a payment method option provided by Adyen, you can see a menu item called Adyen Notifications in the detail screen of an order in Shopware.

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.
the_credit_has_been_accepted The payment authorization was successful.
the_process_has_been_cancelled The payment authorization failed or the payment was canceled.
the_credit_has_been_accepted The capture was successful.
re_crediting The full refund was successful.

In Shopware it is possible to modify the line items of an order after the order has been placed. However, this feature is currently not supported in the plugin. If you would like to request for this or for other additional features in the plugin, open a feature request in our GitHub repository.

Refund an order

You can order a full refund, but the plugin doesn't support partial refunds.

To refund an order:

  1. Log into Shopware and go to the menu.
  2. Go to Order details > Adyen Notifications > Refunds and select Full Refund.

Next steps