{"title":"Shopware 6","category":"default","creationDate":1596705300,"content":"<div class=\"additional-info-block output-inline\">\n<div class=\"additional-info-block__body\"><p><img style=\"width: 38px;\" alt=\"\" src=\"\/user\/pages\/docs\/05.plugins\/09.shopware-6\/shopware_logo.svg?decoding=auto&amp;fetchpriority=auto\" \/>&nbsp; <strong>Read more<\/strong><br \/>\nLearn more about <a href=\"https:\/\/www.adyen.com\/partners\/shopware\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Shopware<\/a> in our Partner Directory.<\/p><\/div><\/div>\n\n<p>Our plugin for Shopware 6 gives you access to the native payment features of the Adyen payments platform.<\/p>\n<h2>Features<\/h2>\n<ul>\n<li><strong>Credit cards<\/strong>: accept credit card payments on your website and mobile application, without redirecting to an external website. Sensitive cardholder data is collected securely using our <a href=\"\/pt\/payment-methods\/cards\/web-component\">Card Component<\/a>, which reduces your <a href=\"\/pt\/get-started-with-adyen\/adyen-glossary\/#pci-compliance\">PCI DSS-compliance<\/a> requirements.<\/li>\n<li><strong><a href=\"\/pt\/risk-management\/dynamic-3d-secure\">Dynamic 3D Secure 2 authentication<\/a><\/strong>, including <a href=\"\/pt\/risk-management\/configure-manual-risk\/standard-risk-rules#consistency-rules\">AVS<\/a> checks.\n<\/li>\n<li><strong>Local payment methods<\/strong>: accept local payment methods including <a href=\"\/pt\/payment-methods\/ideal\">iDEAL<\/a>, <a href=\"\/pt\/payment-methods\/klarna\">Klarna<\/a>, <a href=\"\/pt\/payment-methods\/google-pay\">Google Pay<\/a>, and many others.\n<\/li>\n<li><strong><a href=\"\/pt\/online-payments\/tokenization\">Tokenization<\/a><\/strong>: offer returning shoppers a faster checkout experience by saving their card details.\n<\/li>\n<li><strong><a href=\"\/pt\/risk-management\">Revenue Protect<\/a><\/strong>: use our risk management system to identify and block fraudsters, while reducing friction for legitimate shoppers.<\/li>\n<li><strong><a href=\"\/pt\/online-payments\/donations\">Adyen Giving<\/a><\/strong>: allow shoppers to donate to a chosen nonprofit at checkout. This feature is available with card payments and iDEAL payments.<\/li>\n<\/ul>\n<h2 id=\"supported-versions\">Supported versions<\/h2>\n<div class=\"additional-info-block output-inline\">\n<div class=\"additional-info-block__body\"><p><img alt=\"\" src=\"\/images\/b\/d\/b\/9\/0\/bdb90c8c6e3ad368e94c60faa64c22d80fcc6517-github-icon.png\" \/>&nbsp; <strong>Try it out!<\/strong><br \/>\nYou can find the latest version of our plugin on <a href=\"https:\/\/github.com\/Adyen\/adyen-shopware6\/tree\/master\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">GitHub<\/a>.<\/p><\/div><\/div>\n\n<p>This documentation reflects the latest version of the plugin. You can find the latest version on <a href=\"https:\/\/github.com\/Adyen\/adyen-shopware6\/releases\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">GitHub<\/a>. Our plugin supports the following:<\/p>\n<ul>\n<li>Shopware v6.3.1.1 or later, using PHP 7.0 or later.<\/li>\n<\/ul>\n<p>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:<\/p>\n<ul>\n<li>Keep track of the custom code added to your integration.<\/li>\n<li>Create an issue on <a href=\"https:\/\/github.com\/Adyen\/adyen-shopware6\/issues\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">GitHub<\/a> if you want to suggest a new feature for the plugin.<\/li>\n<\/ul>\n<h3 id=\"support-levels\">Support levels<\/h3>\n<p>We provide three levels of support for major versions of the plugin:<\/p>\n<ul>\n<li><strong>Level 1<\/strong>: Full support.<\/li>\n<li><strong>Level 2<\/strong>: High priority bug fixes and security updates.<\/li>\n<li><strong>Level 3<\/strong>: Security updates only.<\/li>\n<\/ul>\n<table>\n<thead>\n<tr>\n<th>Major version<\/th>\n<th>Release date<\/th>\n<th>Level 1 support until<\/th>\n<th>Level 2 support until<\/th>\n<th>Level 3 support until<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>V2<\/strong><\/td>\n<td>March 2021<\/td>\n<td>March 2022<\/td>\n<td>October 2022<\/td>\n<td>March 2023<\/td>\n<\/tr>\n<tr>\n<td><strong>V3<\/strong><\/td>\n<td>June 2021<\/td>\n<td>Schedule not yet available<\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><strong>V4<\/strong><\/td>\n<td>In development<\/td>\n<td>12 months after release<\/td>\n<td>18 months after release<\/td>\n<td>24 months after release<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div class=\"notices yellow\">\n<p>When the level 3 support period has ended, security updates will no longer be provided and Adyen support ends. You should <a href=\"\/pt\/plugins\/shopware-6\/upgrade\">upgrade to a later version<\/a> or consider the plugin your own custom integration.<\/p>\n<\/div>\n<h2 id=\"before-you-begin\">Requirements<\/h2>\n<div class=\"additional-info-block output-inline\">\n<div class=\"additional-info-block__body\"><p><strong>Implementation examples<\/strong><br \/><img alt=\"\" src=\"\/images\/a\/1\/e\/2\/c\/a1e2c8f087730e8565e5073245582a9636238705-github-icon.png\" \/>&nbsp;&nbsp;<a href=\"https:\/\/github.com\/adyen-examples\/adyen-shopware-plugin-demo\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Try it out on GitHub!<\/a><\/p><\/div><\/div>\n\n<p>Before you begin to integrate, make sure you have followed the <a href=\"\/pt\/get-started-with-adyen\">Get started with Adyen guide<\/a> to:<\/p>\n<ul>\n<li>Get an overview of the steps needed to accept live payments.<\/li>\n<li>Create your test account.<\/li>\n<\/ul>\n<h2 id=\"install\">Step 1: Install the plugin<\/h2>\n<p>You have the following options for installing the plugin:<\/p>\n<ul>\n<li><a href=\"\/pt\/plugins\/shopware-6\/?tab=shopware_store_1\">Download from the Shopware Store<\/a>: This is the easiest option if you have a <a href=\"https:\/\/account.shopware.com\/front\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Shopware Account<\/a>.<\/li>\n<li><a href=\"\/pt\/plugins\/shopware-6\/?tab=composer_2\">Install with Composer<\/a>: This is the easiest option if you are working on your local environment.<\/li>\n<li><a href=\"\/pt\/plugins\/shopware-6\/?tab=git_hub_3\">Download from GitHub<\/a>: More advanced option for developers, but makes it easier to install updates to the plugin that we do between releases.<\/li>\n<\/ul>\n\n<div id=\"tabbS4vw\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Shopware Store&quot;,&quot;content&quot;:&quot;\\n&lt;h3 id=\\&quot;shopware-back-end\\&quot;&gt;Option 1: Download from the Shopware Store&lt;\\\/h3&gt;\\n&lt;p&gt;To use this option, you need to have a valid &lt;a href=\\&quot;https:\\\/\\\/account.shopware.com\\\/front\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Shopware Account&lt;\\\/a&gt;, and a URL with a verified Shopware instance.&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;Purchase the plugin (for &lt;strong&gt;0.00&lt;\\\/strong&gt; EUR) from the &lt;a href=\\&quot;https:\\\/\\\/store.shopware.com\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Shopware Store&lt;\\\/a&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Log in to your Shopware back end.&lt;\\\/li&gt;\\n&lt;li&gt;Go to &lt;strong&gt;Settings&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;System&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;Plugins&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;Licenses&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Find the Adyen plugin, and select &lt;strong&gt;Download&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Go to &lt;strong&gt;Settings&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;System&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;Plugins&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Find the &lt;strong&gt;Adyen Payment&lt;\\\/strong&gt; plugin, and select the action button (...) &amp;gt; &lt;strong&gt;Install&lt;\\\/strong&gt;.&lt;br \\\/&gt;\\nThis adds all supported payment methods to your Shopware instance.&lt;\\\/li&gt;\\n&lt;li&gt;Turn on the &lt;strong&gt;Activate&lt;\\\/strong&gt; toggle.&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&lt;p&gt;The plugin is now ready to be configured.&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;shopware_store_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Composer&quot;,&quot;content&quot;:&quot;\\n&lt;h3 id=\\&quot;composer\\&quot;&gt;Option 2: Install with Composer&lt;\\\/h3&gt;\\n&lt;p&gt;Adyen&#039;s plugin for Shopware 6 is open-source and available on &lt;a href=\\&quot;https:\\\/\\\/github.com\\\/Adyen\\\/adyen-shopware6\\\/tree\\\/master\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;GitHub&lt;\\\/a&gt;. The GitHub repository is connected to Packagist, so you can include it in your project through\\u00a0&lt;a href=\\&quot;https:\\\/\\\/getcomposer.org\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Composer&lt;\\\/a&gt;:&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;In your command-line tool, go to the root of your Shopware 6 application and run &lt;code&gt;composer require adyen\\\/adyen-shopware6&lt;\\\/code&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;In your Shopware back end, go to &lt;strong&gt;Settings&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;System&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;Plugins&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Find the &lt;strong&gt;Adyen Payment&lt;\\\/strong&gt; plugin, and turn on the &lt;strong&gt;Activate&lt;\\\/strong&gt; toggle.&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&lt;p&gt;The plugin is now ready to be configured.&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;composer_1_2&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;GitHub&quot;,&quot;content&quot;:&quot;\\n&lt;h3 id=\\&quot;github\\&quot;&gt;Option 3: Download from GitHub&lt;\\\/h3&gt;\\n&lt;ol&gt;\\n&lt;li&gt;Clone the\\u00a0&lt;a href=\\&quot;https:\\\/\\\/github.com\\\/Adyen\\\/adyen-shopware6\\\/tree\\\/master\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;&lt;code&gt;adyen-shopware6&lt;\\\/code&gt; GitHub repository&lt;\\\/a&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Go to the downloaded folder, and run &lt;code&gt;composer install --no-dev&lt;\\\/code&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Copy the entire &lt;code&gt;adyen-shopware6&lt;\\\/code&gt; folder into the &lt;strong&gt;custom\\\/plugins&lt;\\\/strong&gt; folder in the root of your Shopware 6 application.&lt;\\\/li&gt;\\n&lt;li&gt;Rename the &lt;code&gt;adyen-shopware6&lt;\\\/code&gt; folder to &lt;code&gt;AdyenPayment&lt;\\\/code&gt;, so you now have: &lt;code&gt;custom\\\/plugins\\\/AdyenPayment&lt;\\\/code&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;In your Shopware back end, go to &lt;strong&gt;Settings&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;System&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;Plugins&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Find the &lt;strong&gt;Adyen Payment&lt;\\\/strong&gt; plugin, and turn on the &lt;strong&gt;Activate&lt;\\\/strong&gt; toggle.&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&lt;p&gt;The plugin is now ready to be configured.&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;github_2_3&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2 id=\"set-up-api-key\">Step 2: Generate an API key<\/h2>\n<p>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 <a href=\"#set-up-shopware\">Step 5<\/a>.<\/p>\n<p>To generate an API key:<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> and select your <strong>Company<\/strong> account.<\/li>\n<li>Go to <strong>Developers<\/strong> &gt; <strong>API credentials<\/strong>.<\/li>\n<li>Select the <strong>Payments<\/strong> or <strong>Platforms<\/strong> tab, depending on your integration type.<\/li>\n<li>Select the credential username.<\/li>\n<li>Under <strong>Server settings<\/strong> &gt; <strong>Authentication<\/strong> select the <strong>API key<\/strong> tab.<\/li>\n<li>Select <strong>Generate API key<\/strong>.<\/li>\n<li>Select the copy icon <i class=\"adl-icon-copy\"><\/i> and store your API key securely in your system.\n<div class=\"notices yellow\">\n<p>You cannot copy the API key again after you leave the page.<\/p>\n<\/div><\/li>\n<li>Select <strong>Save changes<\/strong>.<\/li>\n<\/ol>\n<p>Make sure that your API credential has the following <a href=\"\/pt\/development-resources\/api-credentials#api-permissions\">permissions<\/a>:<\/p>\n<ul>\n<li>API Clientside Encryption Payments role<\/li>\n<li>Checkout webservice role<\/li>\n<\/ul>\n<h2 id=\"generate-a-client-key\">Step 3: Generate a client key<\/h2>\n<p>The plugin needs the client key to show the input fields for card details.<\/p>\n<p>The client key is linked to one or more <strong>allowed origins<\/strong> &mdash; the domains from which we expect to get your client-side requests. For example, if you are collecting shopper's payment information at: <code>https:\/\/example.org\/checkout<\/code>, you would need to link the domain <code>https:\/\/example.org<\/code> as an allowed origin to your client key.<\/p>\n<p>To generate a client key:<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li>Go to <strong>Developers<\/strong> &gt; <strong>API credentials<\/strong>, and select the credential username for your integration, for example <strong>ws@Company.[YourCompanyAccount]<\/strong>.<\/li>\n<li>Under <strong>Client settings<\/strong> &gt; <strong>Authentication<\/strong> select the <strong>Client key<\/strong> tab.<\/li>\n<li>Select <strong>Generate client key<\/strong>.<\/li>\n<li>Select the copy icon <i class=\"adl-icon-copy\"><\/i> and store your client key securely in your system.<\/li>\n<li>Under <strong>Add allowed origins<\/strong>, enter your <a href=\"\/pt\/development-resources\/client-side-authentication#allowed-origins\">domains<\/a> and select <strong>Add<\/strong>.<\/li>\n<li>Select <strong>Save changes<\/strong>.<\/li>\n<\/ol>\n<p>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 <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>.<\/p>\n<p>You will need to copy the test and live client keys and add them in the Shopware back end as described in <a href=\"#set-up-shopware\">Step 5<\/a>.<\/p>\n<h2 id=\"set-up-webhooks\">Step 4: Set up webhooks<\/h2>\n<p>Adyen uses webhooks to inform your Shopware platform of payment status changes.\u00a0For more information, refer to\u00a0<a href=\"\/pt\/development-resources\/webhooks\">Webhooks<\/a>.\u00a0<\/p>\n<p>To set up webhooks:\u00a0<\/p>\n<ol>\n<li>\n<p>In your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, go to <strong>Developers<\/strong>\u00a0&gt;\u00a0 <strong>Webhooks<\/strong>.<\/p>\n<div class=\"notices green\">\n<p>We <a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage\">recommend to configure webhooks for your company account<\/a>. This ensures that you do not have duplicate webhook configurations, and improves performance.<\/p>\n<\/div>\n<\/li>\n<li>\n<p>Select <i class=\"adl-icon-add\" role=\"img\" aria-label=\"add icon\"><\/i> <strong>Webhook<\/strong>.<\/p>\n<\/li>\n<li>\n<p>From the list of webhooks, next to <strong>Standard webhook<\/strong>, select <strong>Add<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Under <strong>General<\/strong>, configure the following:<\/p>\n<table>\n<thead>\n<tr>\n<th>Setting<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>Enabled<\/strong><\/td>\n<td>Select the toggle to enable or disable the webhook.<\/td>\n<\/tr>\n<tr>\n<td><strong>Version<\/strong><\/td>\n<td>The webhook version.<\/td>\n<\/tr>\n<tr>\n<td><strong>Description<\/strong><\/td>\n<td>Your description of the webhook.<\/td>\n<\/tr>\n<tr>\n<td><strong>Merchant accounts<\/strong><\/td>\n<td>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.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>Under <strong>Server configuration<\/strong>, configure the following:<\/p>\n<table>\n<thead>\n<tr>\n<th>Setting<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>URL<\/strong><\/td>\n<td>Your website URL followed by <strong>\/adyen\/notification<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td><strong>Method<\/strong><\/td>\n<td><strong>JSON<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>Under <strong>Security<\/strong>, configure the following:<\/p>\n<table>\n<thead>\n<tr>\n<th>Setting<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>Basic authentication<\/strong><\/td>\n<td>Enter your server's username and password. You need to enter these credentials when you <a href=\"#set-up-shopware\">set up the Shopware back end<\/a> later.<\/td>\n<\/tr>\n<tr>\n<td><strong>HMAC Key<\/strong><\/td>\n<td><a href=\"\/pt\/development-resources\/webhooks\/secure-webhooks\/verify-hmac-signatures#enable-hmac-signatures\">Generate the HMAC Key<\/a>, copy it, and store it securely in your system. You need to enter HMAC key when you <a href=\"#set-up-shopware\">set up the Shopware back end<\/a> later.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>Select <strong>Save configuration<\/strong>.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"set-up-shopware\">Step 5: Configure the plugin<\/h2>\n<ol>\n<li>Log in to the Shopware back end and go to <strong>Settings<\/strong> &gt; <strong>System<\/strong> &gt; <strong>Plugins<\/strong>.<\/li>\n<li>Find the <strong>Adyen Payment<\/strong> plugin, and select the action button (...) &gt; <strong>Config<\/strong>.<\/li>\n<li>\n<p>Fill out the following fields:<\/p>\n<div class=\"notices blue\">\n<p>If you have more than one Shopware shop, you need to set up these configurations for each shop.<\/p>\n<\/div>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: left;\">Notes<\/th>\n<th style=\"text-align: center;\">Required field<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Merchant account<\/strong><\/td>\n<td style=\"text-align: left;\">Name of your Adyen <a href=\"\/pt\/account\/account-structure\">merchant account<\/a> for which the payments will be processed.<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>API Key for test<\/strong><\/td>\n<td style=\"text-align: left;\">Your <a href=\"#set-up-api-key\">API key<\/a>\u00a0from Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>. In the live environment, you can enter a dummy value here.<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>API Key for live<\/strong><\/td>\n<td style=\"text-align: left;\">Your <a href=\"#set-up-api-key\">API key<\/a>\u00a0from Adyen <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>. In the test environment, you can enter a dummy value here.<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Client Key for test<\/strong><\/td>\n<td style=\"text-align: left;\">Your <a href=\"#generate-a-client-key\">client key<\/a> from your Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>.<\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Client Key for live<\/strong><\/td>\n<td style=\"text-align: left;\">Your <a href=\"#generate-a-client-key\">client key<\/a> from your Adyen <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>.<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Environment<\/strong><\/td>\n<td style=\"text-align: left;\">Select whether you want to enable live (production) mode or keep using test mode.<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Live endpoint URL prefix<\/strong><\/td>\n<td style=\"text-align: left;\">The prefix for your live URL. Get it from your Adyen <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>\u00a0&gt;\u00a0<strong>Developers<\/strong>\u00a0&gt;\u00a0<strong>API URLs<\/strong> &gt; <strong>Prefix<\/strong>. <div class=\"notices green\">This field is only required for live (production) mode.<\/div><\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Username for standard notifications<\/strong><\/td>\n<td style=\"text-align: left;\">The username for basic authentication that you\u00a0generated in <a href=\"#set-up-webhooks\">Step 4<\/a>.<\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Password for standard notifications<\/strong><\/td>\n<td style=\"text-align: left;\">The password for basic authentication that you\u00a0generated in <a href=\"#set-up-webhooks\">Step 4<\/a>.<\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>HMAC Key for test<\/strong><\/td>\n<td style=\"text-align: left;\">The HMAC key that you generated in <a href=\"#set-up-webhooks\">Step 4<\/a>.<\/td>\n<td style=\"text-align: center;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>HMAC Key for live<\/strong><\/td>\n<td style=\"text-align: left;\">The HMAC key that you generated in <a href=\"#set-up-webhooks\">Step 4<\/a>.<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n<h2 id=\"add-payment-methods\">Step 6: Add payment methods<\/h2>\n<ol>\n<li>Log in to your Shopware back end and go to <strong>Storefront<\/strong>.<\/li>\n<li>Under <strong>Payment and shipping<\/strong>, add payment methods to show on the checkout page.<\/li>\n<li>Select <strong>Save<\/strong>.<\/li>\n<li><a href=\"\/pt\/plugins\/shopware-6\/supported-payment-methods#add-payment-methods-to-your-account\">Add the payment methods in your Customer Area<\/a>.<\/li>\n<li>Some <a href=\"\/pt\/payment-methods\">payment methods<\/a> have additional setup instructions which you can find on the payment method page in our documentation. For example, for Apple Pay, you must <a href=\"\/pt\/payment-methods\/apple-pay\/web-component?tab=adyen-certificate-live_1\">use Adyen's Apple Pay certificate<\/a>.<\/li>\n<\/ol>\n<h3 id=\"stored-payment-methods\">Stored payment methods<\/h3>\n<p>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:<\/p>\n<ol>\n<li>Log in to your Shopware back end and go to <strong>Storefront<\/strong>.<\/li>\n<li>Under <strong>Payment and shipping<\/strong>, add or remove the <strong>Stored Payment Methods | Adyen Payment<\/strong> payment method.<\/li>\n<li>Select <strong>Save<\/strong>.<\/li>\n<\/ol>\n<h3 id=\"update-payment-method-logos\">Updating payment method logos<\/h3>\n<p>By default, the Shopware 6 plugin automatically keeps the logos for all your payment methods up to date.<\/p>\n<p>To turn off automatic logo updating, in the Shopware 6 configuration file <code>platform\/src\/Core\/Framework\/Resources\/config\/packages\/shopware.yaml<\/code>, set <code>shopware.media.enable_url_upload_feature<\/code> to <strong>false<\/strong>.<\/p>\n<p>To manually update the logos, go to your Shopware 6 project root directory and run:<\/p>\n<pre><code class=\"language-bash\">bin\/console adyen:fetch-logos<\/code><\/pre>\n<h2>Donations<\/h2>\n<p>With our <a href=\"\/pt\/online-payments\/donations\">Giving<\/a> feature, you can give shoppers the option to donate to a nonprofit after they have placed an order. Make sure that the <a href=\"\/pt\/online-payments\/donations#choosing-a-nonprofit\">nonprofit is onboarded<\/a> at Adyen before you configure this feature.<\/p>\n<p>To configure donations using Giving:<\/p>\n<ol>\n<li>\n<p>In your Shopware environment, go to <strong>Extensions<\/strong> &gt; <strong>My Extensions<\/strong>.<\/p>\n<\/li>\n<li>\n<p>In the <strong>Adyen Payments<\/strong>, click <strong>Configure<\/strong>.<\/p>\n<\/li>\n<li>\n<p>In your plugin configuration panel, scroll down to <strong>Adyen Giving<\/strong>. Fill out the following fields:<\/p>\n<table>\n<thead>\n<tr>\n<th><strong>Field<\/strong><\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>Enabled<\/strong><\/td>\n<td>Select <strong>Yes<\/strong> to enable Giving.<\/td>\n<\/tr>\n<tr>\n<td><strong>Charity merchant account<\/strong><\/td>\n<td>Adyen merchant account name for the charity.<\/td>\n<\/tr>\n<tr>\n<td><strong>Charity name<\/strong><\/td>\n<td>Name of the charity shown on the Adyen Giving component.<\/td>\n<\/tr>\n<tr>\n<td><strong>Charity description<\/strong><\/td>\n<td>Description of the charity.<\/td>\n<\/tr>\n<tr>\n<td><strong>Charity website<\/strong><\/td>\n<td>Link to the charity website.<\/td>\n<\/tr>\n<tr>\n<td><strong>Donation amounts<\/strong><\/td>\n<td>Suggested amounts that the shopper can donate using the order currency, separated by commas. The minimum amount is the equivalence of EUR&nbsp;1 in your selected currency.<\/td>\n<\/tr>\n<tr>\n<td><strong>Charity logo<\/strong><\/td>\n<td>Logo shown on the Adyen Giving component.<\/td>\n<\/tr>\n<tr>\n<td><strong>Background image<\/strong><\/td>\n<td>Background image of the Adyen Giving component.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>In the <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, go to <strong>Developers<\/strong> &gt; *<strong>Additional data<\/strong>.<\/p>\n<\/li>\n<li>\n<p>In the <strong>Card<\/strong> section, select <strong>Variant<\/strong>.<\/p>\n<\/li>\n<\/ol>\n<h2>Next steps<\/h2>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/plugins\/shopware-6\/go-live-checklist\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Go-live checklist<\/h6><p>Get ready to start accepting payments from your shoppers.<\/p><\/div><\/p><\/a><a href=\"\/plugins\/release-notes\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Keep your integration up to date<\/h6><p>Follow our release notes, and subscribe to our releases on GitHub.<\/p><\/div><\/p><\/a><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/plugins\/shopware-6","articleFields":{"description":"Use Adyen's plugin for Shopware 6 to accept payments.","feedback_component":true,"last_edit_on":"29-01-2024 09:26","filters_component":false,"page_id":"85beca2f-0b32-4cf2-9c74-1f76b65ad759","decision_tree":"[]","parameters":{"logo_2":"![](\/docs\/plugins\/shopware-6\/github-icon.png?resize=25)","example_2":"[Try it out on GitHub!](https:\/\/github.com\/adyen-examples\/adyen-shopware-plugin-demo)"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/plugins\/shopware-6","title":"Shopware 6","content":"\n&nbsp; Read more\nLearn more about Shopware in our Partner Directory.\n\nOur plugin for Shopware 6 gives you access to the native payment features of the Adyen payments platform.\nFeatures\n\nCredit 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, which reduces your PCI DSS-compliance requirements.\nDynamic 3D Secure 2 authentication, including AVS checks.\n\nLocal payment methods: accept local payment methods including iDEAL, Klarna, Google Pay, and many others.\n\nTokenization: offer returning shoppers a faster checkout experience by saving their card details.\n\nRevenue Protect: use our risk management system to identify and block fraudsters, while reducing friction for legitimate shoppers.\nAdyen Giving: allow shoppers to donate to a chosen nonprofit at checkout. This feature is available with card payments and iDEAL payments.\n\nSupported versions\n\n&nbsp; Try it out!\nYou can find the latest version of our plugin on GitHub.\n\nThis documentation reflects the latest version of the plugin. You can find the latest version on GitHub. Our plugin supports the following:\n\nShopware v6.3.1.1 or later, using PHP 7.0 or later.\n\nWe 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:\n\nKeep track of the custom code added to your integration.\nCreate an issue on GitHub if you want to suggest a new feature for the plugin.\n\nSupport levels\nWe provide three levels of support for major versions of the plugin:\n\nLevel 1: Full support.\nLevel 2: High priority bug fixes and security updates.\nLevel 3: Security updates only.\n\n\n\n\nMajor version\nRelease date\nLevel 1 support until\nLevel 2 support until\nLevel 3 support until\n\n\n\n\nV2\nMarch 2021\nMarch 2022\nOctober 2022\nMarch 2023\n\n\nV3\nJune 2021\nSchedule not yet available\n\n\n\n\nV4\nIn development\n12 months after release\n18 months after release\n24 months after release\n\n\n\n\nWhen 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 or consider the plugin your own custom integration.\n\nRequirements\n\nImplementation examples&nbsp;&nbsp;Try it out on GitHub!\n\nBefore you begin to integrate, make sure you have followed the Get started with Adyen guide to:\n\nGet an overview of the steps needed to accept live payments.\nCreate your test account.\n\nStep 1: Install the plugin\nYou have the following options for installing the plugin:\n\nDownload from the Shopware Store: This is the easiest option if you have a Shopware Account.\nInstall with Composer: This is the easiest option if you are working on your local environment.\nDownload from GitHub: More advanced option for developers, but makes it easier to install updates to the plugin that we do between releases.\n\n\n\n    \n        \n        \n    \n\n\nStep 2: Generate an API key\nTo 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.\nTo generate an API key:\n\nLog in to your Customer Area and select your Company account.\nGo to Developers &gt; API credentials.\nSelect the Payments or Platforms tab, depending on your integration type.\nSelect the credential username.\nUnder Server settings &gt; Authentication select the API key tab.\nSelect Generate API key.\nSelect the copy icon  and store your API key securely in your system.\n\nYou cannot copy the API key again after you leave the page.\n\nSelect Save changes.\n\nMake sure that your API credential has the following permissions:\n\nAPI Clientside Encryption Payments role\nCheckout webservice role\n\nStep 3: Generate a client key\nThe plugin needs the client key to show the input fields for card details.\nThe client key is linked to one or more allowed origins &mdash; 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.\nTo generate a client key:\n\nLog in to your Customer Area.\nGo to Developers &gt; API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].\nUnder Client settings &gt; Authentication select the Client key tab.\nSelect Generate client key.\nSelect the copy icon  and store your client key securely in your system.\nUnder Add allowed origins, enter your domains and select Add.\nSelect Save changes.\n\nYou 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.\nYou will need to copy the test and live client keys and add them in the Shopware back end as described in Step 5.\nStep 4: Set up webhooks\nAdyen uses webhooks to inform your Shopware platform of payment status changes.\u00a0For more information, refer to\u00a0Webhooks.\u00a0\nTo set up webhooks:\u00a0\n\n\nIn your Customer Area, go to Developers\u00a0&gt;\u00a0 Webhooks.\n\nWe recommend to configure webhooks for your company account. This ensures that you do not have duplicate webhook configurations, and improves performance.\n\n\n\nSelect  Webhook.\n\n\nFrom the list of webhooks, next to Standard webhook, select Add.\n\n\nUnder General, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nEnabled\nSelect the toggle to enable or disable the webhook.\n\n\nVersion\nThe webhook version.\n\n\nDescription\nYour description of the webhook.\n\n\nMerchant accounts\nYou 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.\n\n\n\n\n\nUnder Server configuration, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nURL\nYour website URL followed by \/adyen\/notification.\n\n\nMethod\nJSON\n\n\n\n\n\nUnder Security, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nBasic authentication\nEnter your server's username and password. You need to enter these credentials when you set up the Shopware back end later.\n\n\nHMAC Key\nGenerate the HMAC Key, copy it, and store it securely in your system. You need to enter HMAC key when you set up the Shopware back end later.\n\n\n\n\n\nSelect Save configuration.\n\n\nStep 5: Configure the plugin\n\nLog in to the Shopware back end and go to Settings &gt; System &gt; Plugins.\nFind the Adyen Payment plugin, and select the action button (...) &gt; Config.\n\nFill out the following fields:\n\nIf you have more than one Shopware shop, you need to set up these configurations for each shop.\n\n\n\n\nField\nNotes\nRequired field\n\n\n\n\nMerchant account\nName of your Adyen merchant account for which the payments will be processed.\n\n\n\nAPI Key for test\nYour API key\u00a0from Adyen test Customer Area. In the live environment, you can enter a dummy value here.\n\n\n\nAPI Key for live\nYour API key\u00a0from Adyen live Customer Area. In the test environment, you can enter a dummy value here.\n\n\n\nClient Key for test\nYour client key from your Adyen test Customer Area.\n\n\n\nClient Key for live\nYour client key from your Adyen live Customer Area.\n\n\n\nEnvironment\nSelect whether you want to enable live (production) mode or keep using test mode.\n\n\n\nLive endpoint URL prefix\nThe prefix for your live URL. Get it from your Adyen live Customer Area\u00a0&gt;\u00a0Developers\u00a0&gt;\u00a0API URLs &gt; Prefix. This field is only required for live (production) mode.\n\n\n\nUsername for standard notifications\nThe username for basic authentication that you\u00a0generated in Step 4.\n\n\n\nPassword for standard notifications\nThe password for basic authentication that you\u00a0generated in Step 4.\n\n\n\nHMAC Key for test\nThe HMAC key that you generated in Step 4.\n\n\n\nHMAC Key for live\nThe HMAC key that you generated in Step 4.\n\n\n\n\n\n\nStep 6: Add payment methods\n\nLog in to your Shopware back end and go to Storefront.\nUnder Payment and shipping, add payment methods to show on the checkout page.\nSelect Save.\nAdd the payment methods in your Customer Area.\nSome 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.\n\nStored payment methods\nThe plugin allows you to securely store shopper's payment details giving your returning shoppers a faster checkout experience. To enable or disable this functionality:\n\nLog in to your Shopware back end and go to Storefront.\nUnder Payment and shipping, add or remove the Stored Payment Methods | Adyen Payment payment method.\nSelect Save.\n\nUpdating payment method logos\nBy default, the Shopware 6 plugin automatically keeps the logos for all your payment methods up to date.\nTo 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.\nTo manually update the logos, go to your Shopware 6 project root directory and run:\nbin\/console adyen:fetch-logos\nDonations\nWith our Giving 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 at Adyen before you configure this feature.\nTo configure donations using Giving:\n\n\nIn your Shopware environment, go to Extensions &gt; My Extensions.\n\n\nIn the Adyen Payments, click Configure.\n\n\nIn your plugin configuration panel, scroll down to Adyen Giving. Fill out the following fields:\n\n\n\nField\nDescription\n\n\n\n\nEnabled\nSelect Yes to enable Giving.\n\n\nCharity merchant account\nAdyen merchant account name for the charity.\n\n\nCharity name\nName of the charity shown on the Adyen Giving component.\n\n\nCharity description\nDescription of the charity.\n\n\nCharity website\nLink to the charity website.\n\n\nDonation amounts\nSuggested amounts that the shopper can donate using the order currency, separated by commas. The minimum amount is the equivalence of EUR&nbsp;1 in your selected currency.\n\n\nCharity logo\nLogo shown on the Adyen Giving component.\n\n\nBackground image\nBackground image of the Adyen Giving component.\n\n\n\n\n\nIn the Customer Area, go to Developers &gt; *Additional data.\n\n\nIn the Card section, select Variant.\n\n\nNext steps\n\nGo-live checklistGet ready to start accepting payments from your shoppers.Keep your integration up to dateFollow our release notes, and subscribe to our releases on GitHub.\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Plugins","lvl2":"Shopware 6"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/plugins","lvl2":"\/pt\/plugins\/shopware-6"},"levels":3,"category":"Plugins","category_color":"green","tags":["Shopware"]},"articleFiles":{"github-icon.png":"<img alt=\"\" src=\"https:\/\/docs.adyen.com\/images\/c\/6\/7\/1\/2\/c6712caa4ef1602ec85154e829dd7d75e078d6ad-github-icon.png\" \/>","shopware_logo.svg":"<img style=\"width: 38px;\" alt=\"\" src=\"https:\/\/docs.adyen.com\/user\/pages\/docs\/05.plugins\/09.shopware-6\/shopware_logo.svg?decoding=auto&amp;fetchpriority=auto\" \/>"}}