Install the plugin

Learn how to install and configure the plugin.

Before you begin

Make sure you meet the following requirements:

If you are an existing user of Shopware 5 CD-Edition

  • If you are user of former heidelpay CD-Edition plugin, there is a transition period for both plugins to handle old follow-up transactions like refunds.
  • Activate the payment methods of Shopware 5 plugin and deactivate the CD-Edition payment methods so that your customers use only the new Unzer payment methods.
  • Shopware 5 Unzer plugin cannot access transactions that were initiated with CD-Edition plugin.
  1. Migrate to the new plugin as described in migration guide
  2. Follow the steps as described for a new user.

If you are a new Shopware 5 user

Install the plugin as described in the following sections.

Step 1: Install the plugin

You can install the plugin using any of the following options:

Option 1: Install from the Shopware’s Community Store

  1. Go to the community store and get the free-of-charge plugin.
  2. Login to your shop and go to Configuration > Plugin Manager > Installed.

The plugin is now available uninstalled in your shop.

Option 2: Install using composer

Go to Shopware’s require plugin page to learn more about installing the Shopware 5 plugin. You can get it by writing the following command:

composer require unzerdev/shopware5

To install and activate the plugin, follow the steps as described in Shopware CLI commands.

Option 3: Install from GitHub

  1. Download the Shopware 5 CD-Edition Plugin from GitHub.

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

  3. Run the following command on your server’s console to download the Unzer SDK files.

    composer install --no-dev
  4. To install and activate the plugin, follow the steps as described in the Shopware CLI commands .

Step 2: Install your plugin environment

  1. In the back end, switch to Configuration > Plugin Manager
  2. Install the UnzerPayment plugin by clicking the button. Install Shopware 5
  3. Click Activate. Activate Shopware 5

After the plugin installation, the Shopware caches will be cleared automatically.

Step 3: Configure your plugin environment (basic configuration)

Configure using plugin settings

  1. Go to the settings of the plugin within the Shopware’s Plugin Manager > Installed, and select Edit.

  2. Update the plugin configuration according to the sub-shop that you want to configure and your requirements. Configure Shopware 5

    Field name Description
    Public Key Enter your public key.
    Private Key Enter your private key.
    Live or test mode Enter your Password from email sent by Unzer support team
    Test API credentials Select this to test the API keys for your plugin.
    effectiveInterest Set the effective annual interest rate for the Unzer Instalment payment.
    Booking mode for credit cards Select the booking mode that you want to use, the payment method. More information about booking modes you get by hovering the questionn next to special config value
    Booking mode Paypal
    Booking mode directdebit
    Customize invoice document for invoice Select Yes if you want to print the payment information for invoice payments to Shopware’s generated PDF invoice, activate this option
    Customize invoice document for prepayment Select Yes if you want to print out the payment information for prepayment payments to Shopware’s generated PDF invoice, activate this option
    enable extended logging Select Yes if you want the plugin to log each call to Unzer payment API
    Automatic update of the payment status Select Yes to automatically register webhooks to get payment status updates from Unzer API in case of updates for payments
    Order status for shipment notification Set your shipping status, for which a shipping message to Unzer is automatically generated and sent. (see also Dispatch message)
    Register webhooks Select this option to register the webhooks.
  3. Click Save to save your configuration.

You must clear the Shopware 5 cache after the configuration.

Next steps