alt

Important information

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

Unzer

Set up your payment methods

Set up the payment methods that you want to offer to your customers.

Before you begin

Step 1: Configure payment methods

  1. Sign in with your admin credentials and go to Configuration > Payment methods. payment method configuration
  2. Select the payment method that you want to update, for example, Kreditkarte (Unzer Payment).
  3. Edit the payment according to your requirements as described in the following table.
FieldDescription
DescriptionYou can change the payment method name displayed in the storefront
NameDo not change. The plugin uses internally this as an identifier.
TemplateDo not change. The plugin provides own templates for each payment methods.
ClassDo not change. The plugin has a base class and not for each payment method
Database tableDo not change. The plugin doesn’t use single tables for each payment method.
Surcharge / Discounts %Specify the discount percentage. Note that in some countries, using discounts or surcharges is forbidden by law.
Fixed surchargeSpecify the fixed surcharge. Note that in some countries, using discounts or surcharges is forbidden by law.
PositionSpecify the order for displaying the payment method order
ActiveSelect to activate the payment method
Active for ESD itemsSelect to activate the payment method for ESD products
Disable for smartphoneSelect to disable the payment method for smartphone users
URL for iFrameDo not change. The plugin only uses for credit card and debit card own integrated iFrame solutions
ActionDo not change. The plugin has a common action for all payment methods build in.
PluginIDDo not change. This is an internal identifier.
  1. Click Save to save your settings.
  2. (Optional) Click Country to select the countries you want to configure the payment method. payment method configuration countries Select the countries for which the payment method should be available. If you do not select any of the countries, the payment method is available for all the supported countries.
  3. (Optional) Select Surcharge to specify the details.
    icon

    Surcharge is available only for some countries.
  4. (Optional) Select the Subshop for which the payment method shall be available. If you leave it empty, the payment methods for all subshops (optional / conditional) are available.
  5. (Optional) Select Free text fields that are mostly used by third party plugins or ERP systems.
    icon

    Contact the manufacturer of the specific plugin for the free text field details.

Step 2: Set up your payment methods for shipping costs

  1. Sign in with your admin credentials and go to Configuration > Shipping costs to add the Shipping cost management details. shipping methods configuration
  2. Click Edit (pencil icon) to update the specific shipping method.
  3. Go to the Payment methods tab and drag all the payment methods to the Allowed section. shipping methods configuration payment methods
  4. Click Save.

Step 3: Specify payment method restrictions

Some payment methods are only available in specific countries and currencies. You can create specific rules for these using the Shopware Risk Management. Choose the payment methods that you want to restrict and enter the rules according to these restrictions.

Risk management of Shopware

Payment methodRequirement
Apple Pay
  • You require an Apple device to test the integration.
  • For the payment type Apple Pay, make sure to add the necessary certificates as specified here.
  • You need an Apple Developer account and a merchant identifier for the integration.
  • When you change your key pair, you need to re-upload your Apple Pay Payment processing certificate.
  • Currently, Apple Pay is only supported for Safari web browser up to iOS 15.
  • If you want to use Apple Pay for other web browsers, you must update to iOS 16 on your apple device.Go to the Apple Pay site for the latest updates and news.
    iDEAL (Unzer Payment)For the payment method iDEAL (Unzer Payment), make sure that only end customers with a billing address from the Netherlands can use the payment method.
    EPS (Unzer Payment)For the payment method EPS (Unzer Payment), make sure that only end customers with a billing address in Austria can use this payment method.
    Przelewy24 (Unzer Payment)For the Przelewy24 (Unzer Payment) payment method, ensure that only
    • end customers with a billing address from Poland can use the payment method.
    • the currency Zloty (PLN) is used for the payment method.
    SEPA Lastschrift (Unzer Payment)
    +
    SEPA Lastschrift (gesichert, Unzer Payment)
    For the SEPA Direct Debit payment methods, ensure that only
    • end customers with a billing address in Germany, Austria and Switzerland can use the payment method.
    • the currency Euro (EUR) and Swiss Francs (CHF) can be used for the payment method.
    Unzer Rechnung (gesichert)For the payment method Unzer Rechnung (gesichert), make sure that only
    • end customers with an invoice address from Germany and Austria can use the payment method.
    • the currency Euro (EUR) can be used for the payment method.
    • That the payment method can only be used in the minimum/maximum amounts contractually agreed with Unzer.
    Rechnung (Unzer Payment)Depending on your agreed contract with Unzer
    • For the payment method Unzer Invoice, ensure that only end customers with an invoice address from Germany, Austria or Switzerland can use the payment method.
    • You require a unique key pair for each customer type and currency combination, for example a separate key pair for B2C (CHF) and a separate key pair for B2C (EUR).
    • Currently only Euro (EUR) and Swiss Franc (CHF) currencies are supported.
    • Ensure that the payment method can only be used for the minimum to maximum amounts contractually agreed with Unzer.
    • You can view the transactions in Unzer Insights.
    • You must generate an invoice in the Shopware 5 back end before you can charge the payment. This ensures that the insurance period is initiated.

    Set up Unzer Installment payment method

    • For Installment payment method, ensure that only end customers with an invoice address from Germany, Austria, or Switzerland can use this payment method.
    • You require a unique key pair for each customer type and currency combination, for example a separate key pair for each combination B2C (EUR), B2C (CHF)
    • Currently, only B2C customer type is supported.
    • Currently only Euro (EUR) and Swiss Franc (CHF) currencies are supported.
    • Ensure that the payment method can only be used for the minimum and maximum amounts contractually agreed with Unzer.
    • You can view the transactions in Unzer Insights.

    Set up payment method

    1. Go to Basic settings > Payment methods > *UnzerPayment and go your shop settings.
      Add key pair
    2. Select the domain and then select Register Webhooks > Save.
    3. Repeat the same steps to add other combinations according to your business case.
    4. Now, go to Configuration > Payment methods > Ratenkauf (Unzer Payment).
    5. Specify the name that you want to see in the shop front end.
    6. Select Active and then Save.
      Activate payment method

    Set up Direct Debit (Secured) payment method

    • For Direct Debit, ensure that only end customers with an invoice address from Germany or Austria can use this payment method.
    • You require a unique key pair for each customer type and currency combination, for example a separate key pair for each combination B2C (EUR).
    • Only Euro (EUR) currency is supported.
    • Ensure that the payment method can only be used for the minimum and maximum amounts that is contractually agreed with Unzer.
    • You can view the transactions in Unzer Insights.
    • In the Shopware 5 shop back end, you must also set up the key pairs for the B2C currency combination.

    Set up the payment method

    1. Go to Basic settings > Payment methods > UnzerPayment and go your shop settings.
      Add key pair
    2. Select the domain and then select Register Webhooks > Save.
    3. Repeat the same steps to add other combinations according to your business case.
    4. Now, go to Configuration > Payment methods > Lastschrift (Unzer Payment).
    5. Specify the name that you want to see in the shop front end.
    6. Select Active and then Save.
      Activate payment method

    Step 4: Register webhooks

    After configuring the various key pairs, you must also register the webhooks and test your credentials.

    1. Go to Configuration > Basic settings > Payment methods > UnzerPayment and select Register webhooks.
    2. Select Save.
    3. (Optional) Select Test API credentials to test your credentials.

    Step 5: Clear the caches

    After finishing the configuration, you must clear the cache of your shop.

    1. Go to Configuration > Cache/Performance > Cache/Performance and then select Cache. clear cache
    2. Select all to mark all cache areas
    3. Clear to clear all the shop caches

    Next steps

    Learn how to handle transactions Manage transactions