alt

Important information

The API reference is now available here.
The deprecated API reference is available here.

Unzer

Install the plugin

Learn how to install and configure the plugin.

icon warning
If you are using Unzer Direct for your integration, go to Shopware 6 integration for the detailed list of steps.

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:

  • Shopware requirements
  • Basic integration requirements from Unzer
  • PHP version from 7.2-7.4
  • Shopware version 6.2.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 three different ways to install Unzer plugin for Shopware 6.

Option 1: Install using Shopware’s Community Store

  1. Go to Shopware plugin and buy the free-of-charge plugin.
  2. After buying the plugin, sign in to your shop.
    • For Shopware 6.3, go to Settings > System > Plugins > My Plugins
    • For Shopware 6.4, go to Extensions > My extensions

The plugin is now available in the list.

Option 2: 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.3, go to Settings > System > Plugins > My Plugins
    • For Shopware 6.4, go to Extensions > My extension

The plugin is now available in the list.

See also Shopware requiring plugins.

Option 3: 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.3, go to Settings > Plugins.
    • For Shopware 6.4, go to Settings > Extensions.
  2. Install and activate the plugin.
    1. Shopware 6.3 Shopware 6.3 Admin plugin settings
    2. Shopware 6.4 Shopware 6.4 Admin plugin settings

Step 3: Configure your plugin environment (basic configuration)

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

  • For Shopware 6.3, go to Settings > Plugins.
  • For Shopware 6.4, go to Settings > Extensions.

Admin plugin settings

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

Field nameDescription
SaveUse this button to save your settings.
Test API credentialsUse this button to test the private key and public keys for your plugin.
Register webhooksUse this button to register your webhooks for notifications.
Sales ChannelSelect the sales channel for which the configuration should be applied.
icon
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.
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.
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 Authorization option, the amount must be collected manually later. Please refer to the section charge after authorization to learn how to charge after authorization.
Register credit cardsSelect this option if you want to store the credit card data as a reference in the store and be available to your customers for future purchases.
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 Authorization option, the amount must be collected manually later. Please refer to the charge after authorization section to learn how to charge after authorization.
Register PayPal accountsSelect this option if you want the customers to enter PayPal credentials the first time only. They will not be redirected to PayPal in case of future purchases.

Note

icon
Note that if you want to use PayPal’s recurring or save payment data features, you have to activate the PayPal Billing Agreements.
Hire purchase effective interestSet the effective interest rate for the Unzer Installment payment. Refer to your contract with Unzer for valid interest rates.
Register direct debit accountsDecide whether direct debit data of the end customer should be stored as a reference and be selectable to your end customers without re-entry at the future purchases.
Delivery status for shipping notificationAutomatic shipping notifications is sent if an order is in the selected status. Leave it empty to disable automatic shipping notifications. Send notifications for the shipment
icon
This option is only available for Unzer invoice (deprecated) | Unzer Payment and Unzer Installment | Unzer Payment payment methods.
Your invoice payments are only paid out if you send a shipping transaction.

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. So, 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