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.
Our plugin supports the following:
- Shopware v6.3.1.1 or later, using PHP 7.0 or later.
Features
- Credit cards – Accept credit card payments on your website and mobile application, without redirecting to an external website. Sensitive cardholder data is collected securely using our Custom Card Component, which reduces your PCI DSS-compliance requirements.
- Dynamic 3D Secure 2 authentication, including AVS checks.
- Local payment methods – Accept local payment methods including iDEAL, Sofort, Klarna, giropay, Google Pay, and many others.
- Tokenization – Offer returning shoppers a faster checkout experience by saving their card details.
- Revenue Protect - 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.
Before you begin
Before you begin to integrate Shopware 6 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.
- 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:
- Download from the Shopware Store: This is the easiest option if you have a Shopware Account.
- Install with Composer: This is the easiest option if you're working on your local environment.
- Download from GitHub: More advanced option for developers, but makes it easier to install updates to the plugin that we do between releases.
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.
- Purchase the plugin (for 0.00 EUR) from the Shopware Store.
- Log in to your Shopware back end.
- Go to Settings > System > Plugins > Licenses.
- Find the Adyen plugin, and select Download.
- Go to Settings > System > Plugins.
- Find the Adyen Payment plugin, and select the action button (...) > Install.
This adds all supported payment methods to your Shopware instance. - Turn on the Activate toggle.
The plugin is now ready to be configured.
Option 2: Install with Composer
Adyen's plugin for Shopware 6 is open-source and available on GitHub. The GitHub repository is connected to Packagist, so you can include it in your project through Composer:
- In your command-line tool, go to the root of your Shopware 6 application and run
composer require adyen/adyen-shopware6
. - In your Shopware back end, go to Settings > System > Plugins.
- Find the Adyen Payment plugin, and turn on the Activate toggle.
The plugin is now ready to be configured.
Option 3: Download from GitHub
- Clone the
adyen-shopware6
GitHub repository. - Go to the downloaded folder, and run
composer install --no-dev
. - Copy the entire
adyen-shopware6
folder into the custom/plugins folder in the root of your Shopware 6 application. - Rename the
adyen-shopware6
folder toAdyenPayment
, so you now have:custom/plugins/AdyenPayment
. - In your Shopware back end, go to Settings > System > Plugins.
- Find the Adyen Payment plugin, and turn on the Activate toggle.
The plugin is now ready to be configured.
Step 2: Generate an API key
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 5.
To generate an API key:
- Log in to your Customer Area.
- Go to Account > API credentials, and select the credential for your integration, for example ws@Company.[YourCompanyAccount].
- Under Authentication, select Generate New API Key.
- 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. - 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
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:
- Log in to your Customer Area.
- Go to Account > API credentials, and select the API credential for your integration, for example ws@Company.[YourCompanyAccount].
- Add your domains under Allowed origins. These are the domains from which you will be sending your client-side requests.
- Under Authentication, select Generate New Client Key.
- 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:
- 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 /adyen/notification as a suffix. For example,
https://www.example.com/adyen/notification
. - Select Active.
- Set Method to JSON.
- 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 5. - 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 5. - Select Save Configuration.
You have now set up notifications for your test environment. To set up notifications for your live environment, follow the same steps in your live Customer Area.
Step 5: Configure the plugin
- Log in to the Shopware backend and go to Settings > System > Plugins.
- Find the Adyen Payment plugin, and select the action button (...) > Config.
-
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. API Key for test Your API key from Adyen test Customer Area. In the live environment, you can enter a dummy value here. API Key for live Your API key from Adyen live Customer Area. In the test environment, you can enter a dummy value here. Client Key for test Your client key from your Adyen test Customer Area. Client Key for live Your client key from your Adyen live Customer Area. Environment Select whether you want to enable live (production) mode or keep using test mode. 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.Username for standard notifications The username for basic authentication that you generated in Step 4. Password for standard notifications The password for basic authentication that you generated in Step 4. HMAC Key for test The HMAC key that you generated in Step 4. HMAC Key for live The HMAC key that you generated in Step 4. -
In the Shopware backend, go to the desired sales channel, and add the payment methods to show in the checkout page. Make sure to also add the payment methods in your Adyen Customer Area.
If using Apple Pay, contact our Support Team to enable Apple Pay for your live account, and provide the domain names and shop name that you want to use.
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
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
-
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
.
- If you installed the plugin from the Shopware Store: Download the newer version and replace the package in the
-
Run the database migration scripts
bin/console database:migrate --all AdyenPaymentShopware6
. - Run the update script
bin/console plugin:update AdyenPaymentShopware6
.