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. Once you're set up, you can accept credit card payments in multiple currencies. Apart from credit card payments, we currently support iDEAL, Sofort, Klarna Invoice, giropay, and Google Pay. We collect sensitive cardholder data securely with our Custom Card Component, which reduces your PCI DSS-compliance requirements. The integration supports stored card details, native and Dynamic 3D Secure 2 authentication and includes AVS checks.
Use our risk management system to identify and block fraudsters, while reducing friction for legitimate shoppers. You can either fully automate the risk management process, or add manual review for certain payments.
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.
Before you begin
Before you begin to integrate Shopware 5 with the Adyen payments platform, make sure that you have performed the following steps:
- Sign up for a test account with Adyen at https://www.adyen.com/signup.
- Apply for a live account with Adyen. For more information, refer to Apply for a live account.
Step 1: Generate an API key in Adyen Customer Area
To authenticate API requests from Shopware, you need to provide an API key.
To generate an API Key:
- Log in to your Adyen Customer Area.
- Go to Account > Users, and select the user ws@Company.[YourCompanyAccount].
Under Authentication, select Generate New API Key.
Don't forget to copy and securely store the API Key in your system – you will need to enter it in Shopware in Step 2.
- Select Save Generated API Key.
Step 2: Install and configure the Shopware plugin
- Download the plugin from GitHub.
- In the root of your Shopware 5 application, in the
custom/pluginsfolder, create an
AdyenPaymentfolder and then add the plugin in the
composer install --no-devin the
custom/plugins/AdyenPaymentfolder to install the necessary dependencies.
- Login to the Shopware backend, go to Configuration > Plugin Manager and install the Adyen plugin.
- In the Plugin Manager, select Installed. Find the Adyen plugin, and select the pencil icon to open the plugin. Select Activate.
- 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:
|Environment||Select whether you want to use test or live (production) mode.|
|Merchant account||Name of your Adyen merchant account for which the payments will be processed.|
|API key||Your API key from Adyen test/live Customer Area. The following web service user roles must be activated in the backend of Adyen:
|API: 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.
|Notification HMAC||The HMAC key that you generated in your Adyen account.
|Notification Auth Username||This can be any username, as long as it matches the username for basic authentication that you entered in your Adyen Customer Area.|
|Notification Auth Password||This can be any password, as long as it matches the password for basic authentication that you entered in your Adyen Customer Area.|
|Google Merchant ID||ID of your Google account for which the Google Pay payments will be processed (if applicable).|
|Enable Payment Methods cache||Cache the list of payment methods for better performance|
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:
- Login to the Shopware backend and go to Configuration > Shipping cost to edit the fields.
- 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:
|Payment method title||The value identified by
||ID of the payment method.||The title you want to show for this payment method.|
|Payment method description||The value identified by
||This value must match the one used for the
||The description you want to show next to the payment method name.|
Step 3: 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:
- Log in to your Customer Area with your company-level account.
- Go to Account > Server Communication.
- Next to Standard Notification, select Add.
- In the URL box, enter your website URL followed by /frontend/notification/index as a suffix. For example,
- Select the Active checkbox.
- Set Method to JSON.
- In the User Name and Password boxes, enter a username and password for basic authentication.
- 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.
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 transactions 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.|
Refund an order
You can order a full refund, but the plugin doesn't support partial refunds.
To refund an order:
- Log into Shopware and go to the menu.
- Go to Order details > Adyen Transactions > Refunds and select Full Refund.