alt

Important information

Please be advised that there will be a scheduled downtime across our API network on November 05 and November 07, 2024. For more information, visit our platform status portal.:
- Scheduled maintenance on November 5, 2024
- Scheduled maintenance on November 7, 2024

Unzer

Install the plugin

Learn how to install and configure the plugin.

Before you begin

In addition to the system requirements specified by Shopware (see Shopware 6 system requirements), you require the following before you start installing the plugin:

  • Go to Shopware requirements and select the relevant Shopware 6 version.
  • Basic integration requirements from Unzer
  • Shopware version 6.4.0 or later
  • The bc-math PHP extension installed on your server. You can get bc-math extension from your server provider.
  • Your php variable serialize_precision must be set to value -1

Step 1: Install the plugin

There are two different ways to install Unzer plugin for Shopware 6.

Option 1: Install using Composer

To learn how to install Composer, go here.

  1. Install Shopware 6 plugin using the Composer.
    composer require unzerdev/shopware6
    
    After the download process is complete, you can find the plugin in the \custom\plugins\UnzerPayment6 directory.
  2. Now sign in into your shop.
  • For Shopware 6.4, go to Extensions > My extension.

The plugin is now available in the list.

Option 2: Install using GitHub

  1. Download the latest version of our Shopware 6 plugin from GitHub.

  2. Upload the unzipped files into the directory \custom\plugins on your server.

  3. Run the following console command within the \custom\plugins\UnzerPayment6 directory to install the dependencies.

    composer install --no-dev
    

Once the dependencies are installed, you can see the vendor folder.

Step 2: Install your plugin environment

  1. Sign in with the admin user of your shop.

    • For Shopware 6.6, go to Settings > Extensions.
  2. Install and activate the plugin. Install the plugin

  3. Select Unzer Payment.

Step 3: Configure your plugin environment (basic configuration)

To update the plugin configuration according to the sales channel and your requirements:

  • For Shopware 6.6, go to Settings > Extensions > Unzer Payment.

Admin plugin settings

In the settings window, configure the plugin according to your requirements.

Field nameDescription
SaveUse this button to save your settings.
Sales ChannelSelect the sales channel for which the configuration should be applied.
  • If you want to configure a specific sales channel, deactivate the inheritance of values for the specific payment method by deactivating the Booking Mode for it.
  • If you have a multi-store setup and update the Public or Private keys for payment methods under All Sales Channels, you must make sure that you review and verify the key configurations for your other sales channels after selecting Save.
Public keyEnter your public key here.
Private keyEnter your private key here.
Show test dataActivate this to show test data on the storefront that can be used to perform sandbox transactions.
icon
For live transactions, you must deactivate this toggle button.
Extended loggingSelect this option if you want to log the API transactions to the Shopware log. The activation of this function is for analysis purposes.
Register webhooksUse this button to register your webhooks for notifications.
Booking mode credit cardSelect the booking mode that you want to use, for the payment method credit card or debit card.
If you select the Charge option, the amount is debited immediately, if you select the Authorize option, the amount must be collected later. Please refer to the section charge after authorization to learn how to charge after authorization.
Booking mode PayPalSelect in which booking mode you want to use the PayPal payment method.
If you select the Charge option, the amount is debited immediately, if you select the Authorize option, the amount must be collected manually later. Please refer to the charge after authorization section to learn how to charge after authorization.
Booking mode Apple PaySelect in which booking mode you want to use the PayPal payment method.
If you select the Charge option, the amount is debited immediately, if you select the Authorize option, the amount must be collected manually later. Please refer to the charge after authorization section to learn how to charge after authorization.
Advanced settingsSelect the various options for Delivery status for shipping notification, Delivery status for triggering automatic capture, and Delivery status for triggering automatic cancel/refund.
Show ‘Show ‘Save PayPal Account for next order’ on checkoutSelect the toggle button if you want to enable one-click payments for PayPal.
Google PayFor more details for setting up Goole Pay.
Invoice B2B EURFor more details, go to setting up Invoice payment method.
Invoice B2B CHFFor more details, go to setting up Invoice payment method.
Invoice B2C EURFor more details, go to setting up Invoice payment method.
Invoice B2C CHFFor more details, go to setting up Invoice payment method.
Installment B2C EURFor more details, go to setting up Installment payment method.
Installment B2C CHFFor more details, go to setting up Installment payment method.
Direct Debit B2C EURFor more details, go to setting up Direc Debit payment method.

Step 4: Clear the caches

After completing the steps as described earlier, you must clear the cache for the configuration to take effect.

  1. Go to Settings > System > Caches & Indexes.
  2. Select Clear caches.

Shopware admin cache clear

Step 5: Set up webhook notification

After the plugin is installed and configured, you can register your personal webhook notifications to your keypair and shop.

  1. Go to Settings > Plugins > Unzer Payment (Settings > Extensions, respectively).
  2. Select Register webhooks.
  3. In the pop-up window, select the URLs to register the notifications for them.
icon
Unzer API supports only TLS protected URLs. You must have https:// at the beginning of your URL.

(Optional) You can also delete existing webhooks by selecting the Clear webhooks button.

Shopware admin webhook management

Next steps