--- title: "Shopware 6" description: "Use Adyen's plugin for Shopware 6 to accept payments." url: "https://docs.adyen.com/plugins/shopware-6" source_url: "https://docs.adyen.com/plugins/shopware-6.md" canonical: "https://docs.adyen.com/plugins/shopware-6" last_modified: "2024-01-29T09:26:00+01:00" language: "en" --- # Shopware 6 Use Adyen's plugin for Shopware 6 to accept payments. ![](/user/pages/docs/05.plugins/09.shopware-6/shopware_logo.svg?decoding=auto\&fetchpriority=auto)  **Read more**\ Learn more about [Shopware](https://www.adyen.com/partners/shopware) in our Partner Directory. Our plugin for Shopware 6 gives you access to the native payment features of the Adyen payments platform. ## 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 [Card Component](/payment-methods/cards/web-component), which reduces your [PCI DSS-compliance](/get-started-with-adyen/adyen-glossary/#pci-compliance) requirements. * **[Dynamic 3D Secure 2 authentication](/risk-management/dynamic-3d-secure)**, including [AVS](/risk-management/configure-manual-risk/standard-risk-rules#consistency-rules) checks. * **Local payment methods**: accept local payment methods including [iDEAL](/payment-methods/ideal), [Klarna](/payment-methods/klarna), [Google Pay](/payment-methods/google-pay), and many others. * **[Tokenization](/online-payments/tokenization)**: offer returning shoppers a faster checkout experience by saving their card details. * **[Revenue Protect](/risk-management)**: use our risk management system to identify and block fraudsters, while reducing friction for legitimate shoppers. * **[Adyen Giving](/online-payments/donations)**: allow shoppers to donate to a chosen nonprofit at checkout. This feature is available with card payments and iDEAL payments. ## Supported versions ![](/images/2/9/f/a/2/29fa2e22a8a52bc8dd4599e7501ae7187d20e40b-github-icon.png)  **Try it out!**\ You can find the latest version of our plugin on [GitHub](https://github.com/Adyen/adyen-shopware6/tree/master). This documentation reflects the latest version of the plugin. You can find the latest version on [GitHub](https://github.com/Adyen/adyen-shopware6/releases). Our plugin supports the following: * Shopware v6.3.1.1 or later, using PHP 7.0 or later. We may be unable to provide support if you are not using the default Shopware checkout. We do not recommend customizing the plugin, because this could make it harder to upgrade and maintain your integration. If you decide to customize, we recommend that you: * Keep track of the custom code added to your integration. * Create an issue on [GitHub](https://github.com/Adyen/adyen-shopware6/issues) if you want to suggest a new feature for the plugin. ### Support levels We provide three levels of support for major versions of the plugin: * **Level 1**: Full support. * **Level 2**: High priority bug fixes and security updates. * **Level 3**: Security updates only. | Major version | Release date | Level 1 support until | Level 2 support until | Level 3 support until | | ------------- | -------------- | -------------------------- | ----------------------- | ----------------------- | | **V2** | March 2021 | March 2022 | October 2022 | March 2023 | | **V3** | June 2021 | Schedule not yet available | | | | **V4** | In development | 12 months after release | 18 months after release | 24 months after release | When the level 3 support period has ended, security updates will no longer be provided and Adyen support ends. You should [upgrade to a later version](/plugins/shopware-6/upgrade) or consider the plugin your own custom integration. ## Requirements **Implementation examples**\ ![](/images/8/5/c/d/3/85cd31c7f5ca462779c0cd1810f3077eef26b6d9-github-icon.png)  [Try it out on GitHub!](https://github.com/adyen-examples/adyen-shopware-plugin-demo) Before you begin to integrate, make sure you have followed the [Get started with Adyen guide](/get-started-with-adyen) to: * Get an overview of the steps needed to accept live payments. * Create your test account. ## Step 1: Install the plugin You have the following options for installing the plugin: * [Download from the Shopware Store](/plugins/shopware-6/?tab=shopware_store_1): This is the easiest option if you have a [Shopware Account](https://account.shopware.com/front). * [Install with Composer](/plugins/shopware-6/?tab=composer_2): This is the easiest option if you are working on your local environment. * [Download from GitHub](/plugins/shopware-6/?tab=git_hub_3): More advanced option for developers, but makes it easier to install updates to the plugin that we do between releases. ### Tab: Shopware Store ### Option 1: Download from the Shopware Store To use this option, you need to have a valid [Shopware Account](https://account.shopware.com/front), and a URL with a verified Shopware instance. 1. Purchase the plugin (for **0.00** EUR) from the [Shopware Store](https://store.shopware.com/). 2. Log in to your Shopware back end. 3. Go to **Settings** > **System** > **Plugins** > **Licenses**. 4. Find the Adyen plugin, and select **Download**. 5. Go to **Settings** > **System** > **Plugins**. 6. Find the **Adyen Payment** plugin, and select the action button (...) > **Install**.\ This adds all supported payment methods to your Shopware instance. 7. Turn on the **Activate** toggle. The plugin is now ready to be configured. ### Tab: Composer ### Option 2: Install with Composer Adyen's plugin for Shopware 6 is open-source and available on [GitHub](https://github.com/Adyen/adyen-shopware6/tree/master). The GitHub repository is connected to Packagist, so you can include it in your project through [Composer](https://getcomposer.org/): 1. In your command-line tool, go to the root of your Shopware 6 application and run `composer require adyen/adyen-shopware6`. 2. In your Shopware back end, go to **Settings** > **System** > **Plugins**. 3. Find the **Adyen Payment** plugin, and turn on the **Activate** toggle. The plugin is now ready to be configured. ### Tab: GitHub ### Option 3: Download from GitHub 1. Clone the [`adyen-shopware6` GitHub repository](https://github.com/Adyen/adyen-shopware6/tree/master). 2. Go to the downloaded folder, and run `composer install --no-dev`. 3. Copy the entire `adyen-shopware6` folder into the **custom/plugins** folder in the root of your Shopware 6 application. 4. Rename the `adyen-shopware6` folder to `AdyenPayment`, so you now have: `custom/plugins/AdyenPayment`. 5. In your Shopware back end, go to **Settings** > **System** > **Plugins**. 6. 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](#set-up-shopware). To generate an API key: 1. Log in to your [Customer Area](https://ca-test.adyen.com/) and select your **Company** account. 2. Go to **Developers** > **API credentials**. 3. Select the **Payments** or **Platforms** tab, depending on your integration type. 4. Select the credential username. 5. Under **Server settings** > **Authentication** select the **API key** tab. 6. Select **Generate API key**. 7. Select the copy icon **and store your API key securely in your system. You cannot copy the API key again after you leave the page. 8. Select **Save changes**. Make sure that your API credential has the following [permissions](/development-resources/api-credentials#api-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 are 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](https://ca-test.adyen.com/). 2. Go to **Developers** > **API credentials**, and select the credential username for your integration, for example **ws\@Company.\[YourCompanyAccount]**. 3. Under **Client settings** > **Authentication** select the **Client key** tab. 4. Select **Generate client key**. 5. Select the copy icon **and store your client key securely in your system. 6. Under **Add allowed origins**, enter your [domains](/development-resources/client-side-authentication#allowed-origins) and select **Add**. 7. Select **Save changes**. 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](https://ca-live.adyen.com/). You will need to copy the test and live client keys and add them in the Shopware back end as described in [Step 5](#set-up-shopware). ## Step 4: Set up webhooks Adyen uses webhooks to inform your Shopware platform of payment status changes. For more information, refer to [Webhooks](/development-resources/webhooks).  To set up webhooks:  1. In your [Customer Area](https://ca-test.adyen.com/), go to **Developers** >  **Webhooks**. We [recommend to configure webhooks for your company account](/development-resources/webhooks/configure-and-manage). This ensures that you do not have duplicate webhook configurations, and improves performance. 2. Select ****Webhook**. 3. From the list of webhooks, next to **Standard webhook**, select **Add**. 4. Under **General**, configure the following: | Setting | Description | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Enabled** | Select the toggle to enable or disable the webhook. | | **Version** | The webhook version. | | **Description** | Your description of the webhook. | | **Merchant accounts** | You can apply the webhook to all merchant accounts for a company account, include only specific merchant accounts, or exclude specific merchant accounts for your company account. | 5. Under **Server configuration**, configure the following: | Setting | Description | | ---------- | ----------------------------------------------------- | | **URL** | Your website URL followed by **/adyen/notification**. | | **Method** | **JSON** | 6. Under **Security**, configure the following: | Setting | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Basic authentication** | Enter your server's username and password. You need to enter these credentials when you [set up the Shopware back end](#set-up-shopware) later. | | **HMAC Key** | [Generate the HMAC Key](/development-resources/webhooks/secure-webhooks/verify-hmac-signatures#enable-hmac-signatures), copy it, and store it securely in your system. You need to enter HMAC key when you [set up the Shopware back end](#set-up-shopware) later. | 7. Select **Save configuration**. ## Step 5: Configure the plugin 1. Log in to the Shopware back end and go to **Settings** > **System** > **Plugins**. 2. Find the **Adyen Payment** plugin, and select the action button (...) > **Config**. 3. 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](/account/account-structure) for which the payments will be processed. | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | | **API Key for test** | Your [API key](#set-up-api-key) from Adyen [test Customer Area](https://ca-test.adyen.com/). In the live environment, you can enter a dummy value here. | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | | **API Key for live** | Your [API key](#set-up-api-key) from Adyen [live Customer Area](https://ca-live.adyen.com/). In the test environment, you can enter a dummy value here. | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | | **Client Key for test** | Your [client key](#generate-a-client-key) from your Adyen [test Customer Area](https://ca-test.adyen.com/). | ![-x-](/user/data/smileys/emoji/x.png "-x-") | | **Client Key for live** | Your [client key](#generate-a-client-key) from your Adyen [live Customer Area](https://ca-live.adyen.com/). | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | | **Environment** | Select whether you want to enable live (production) mode or keep using test mode. | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | | **Live endpoint URL prefix** | The prefix for your live URL. Get it from your Adyen [live Customer Area](https://ca-live.adyen.com/) > **Developers** > **API URLs** > **Prefix**.This field is only required for live (production) mode. | ![-x-](/user/data/smileys/emoji/x.png "-x-") | | **Username for standard notifications** | The username for basic authentication that you generated in [Step 4](#set-up-webhooks). | ![-x-](/user/data/smileys/emoji/x.png "-x-") | | **Password for standard notifications** | The password for basic authentication that you generated in [Step 4](#set-up-webhooks). | ![-x-](/user/data/smileys/emoji/x.png "-x-") | | **HMAC Key for test** | The HMAC key that you generated in [Step 4](#set-up-webhooks). | ![-x-](/user/data/smileys/emoji/x.png "-x-") | | **HMAC Key for live** | The HMAC key that you generated in [Step 4](#set-up-webhooks). | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ## Step 6: Add payment methods 1. Log in to your Shopware back end and go to **Storefront**. 2. Under **Payment and shipping**, add payment methods to show on the checkout page. 3. Select **Save**. 4. [Add the payment methods in your Customer Area](/plugins/shopware-6/supported-payment-methods#add-payment-methods-to-your-account). 5. Some [payment methods](/payment-methods) have additional setup instructions which you can find on the payment method page in our documentation. For example, for Apple Pay, you must [use Adyen's Apple Pay certificate](/payment-methods/apple-pay/web-component?tab=adyen-certificate-live_1). ### Stored payment methods The plugin allows you to securely store shopper's payment details giving your returning shoppers a faster checkout experience. To enable or disable this functionality: 1. Log in to your Shopware back end and go to **Storefront**. 2. Under **Payment and shipping**, add or remove the **Stored Payment Methods | Adyen Payment** payment method. 3. Select **Save**. ### 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: ```bash bin/console adyen:fetch-logos ``` ## Donations With our [Giving](/online-payments/donations) feature, you can give shoppers the option to donate to a nonprofit after they have placed an order. Make sure that the [nonprofit is onboarded](/online-payments/donations#choosing-a-nonprofit) at Adyen before you configure this feature. To configure donations using Giving: 1. In your Shopware environment, go to **Extensions** > **My Extensions**. 2. In the **Adyen Payments**, click **Configure**. 3. In your plugin configuration panel, scroll down to **Adyen Giving**. Fill out the following fields: | **Field** | Description | | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Enabled** | Select **Yes** to enable Giving. | | **Charity merchant account** | Adyen merchant account name for the charity. | | **Charity name** | Name of the charity shown on the Adyen Giving component. | | **Charity description** | Description of the charity. | | **Charity website** | Link to the charity website. | | **Donation amounts** | Suggested amounts that the shopper can donate using the order currency, separated by commas. The minimum amount is the equivalence of EUR 1 in your selected currency. | | **Charity logo** | Logo shown on the Adyen Giving component. | | **Background image** | Background image of the Adyen Giving component. | 4. In the [Customer Area](https://ca-test.adyen.com/), go to **Developers** > \***Additional data**. 5. In the **Card** section, select **Variant**. ## Next steps ###### [Go-live checklist](/plugins/shopware-6/go-live-checklist) [Get ready to start accepting payments from your shoppers.](/plugins/shopware-6/go-live-checklist) ###### [Keep your integration up to date](/plugins/release-notes) [Follow our release notes, and subscribe to our releases on GitHub.](/plugins/release-notes)