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. Login with your admin credentials and go to Settings > Shop > Payment. Payment method configuration
  2. Select the payment type you want to update and click Edit.
  3. Edit the payment type according to your requirements as described in the table below. single payment method configuration
FieldDescription
NameYou can change the payment type name displayed in the storefront
PositionDetermine the display order for the end customer in shop frontend
DescriptionAdd the additional description text, if required.
LogoAdd a logo for the payment method, if required.
Availability ruleSelect the Availability Rule (Rule builder) to determine when the payment type should be available to the end customer (country restrictions, customer groups, etc.)
ActiveActivate the payment method to be visible in the store front end.
Allow payment change after checkout?Select this option if the payment type must still be selectable for the end buyer after a payment cancellation or rejection.
  1. Select Save to save your settings.

Step 2: Setup your payment methods for sales channel

  1. Go to the Sales channel configuration for which you want to activate the payment methods. Sales channel configuration
  2. Select the payment method that are available for you.

icon
You can only use the payment methods that are specified in your contract with Unzer. Even if you can edit the other payment methods, they will not be reflected in Unzer Insights.
3. Select your default payment type.
4. Select Save.

You must clear the caches each time you update the configuration. See also Step 3: Configure your plugin environment

Specific payment method requirements

Some restrictions for using individual payment types of the plugin. You can easily create these using the Shopware Rulebuilder and then apply them across your payment method setup.

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 for the integration.
  • When you change your key pair, you need to re-upload your Apple Pay Payment processing certificate.
  • 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
    • For the payment type iDEAL, make sure that only end customers with a billing address from the Netherlands can use the payment type.
    EPS
    • For the payment method EPS, make sure that only end customers with a billing address in Austria can use this payment method.
    PostFinance
    • For the PostFinance payment type, ensure that only end customers with a billing address from Switzerland can use the payment type.
    • For the PostFinance payment method, also ensure that only the Swiss Franc (CHF) currency is used for the payment method.
    Przelewy24
    • For the Przelewy24 payment method, ensure that only end customers with a billing address from Poland can use the payment method.
    • For the Przelewy24 payment method, also ensure that only the currency Zloty (PLN) is used for the payment method.
    Unzer direct debit guaranteed / secured
    • For the Unzer Direct Debit payment method, ensure that only end customers with a billing address in Germany, Austria and Switzerland can use the payment method.
    • For the Unzer Direct Debit payment method, also ensure that only the currency Euro (EUR) and Swiss Francs (CHF) can be used for the payment method.
    Unzer invoice (deprecated)
    • For the payment method Unzer Invoice (deprecated), ensure that only end customers with an invoice address from Germany and Austria can use the payment method.
    • For the Unzer Invoice Purchase payment method, also ensure that only the currency Euro (EUR) can be used for the payment method.
    • For the Unzer invoice purchase payment method, also ensure that the payment method can only be used in the minimum/maximum amounts contractually agreed with Unzer.
    Unzer invoice | Unzer PaymentDepending 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 6 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 Setting > Extensions > Unzer Payment and go the Installment keypair setup.
      Add key pair
    Field nameDescription
    Private KeyEnter the private key that is available in Unzer Insights.
    Public KeyEnter the public key that is available in Unzer Insights.
    Show webhooksAfter Entering the key pairs, You can check all webhooks that are registered with the entered key pairs
    Register webhooksRegister webhooks with entered key pairs
    Test API CredentialsTest the validity of the enterd key pairs
    1. Select Save.
    1. Select the domain and then select Register webhooks > Save.
    2. Repeat the same steps to add other combinations according to your business case.
    3. In the shop back end, go to Settings > Extensions > Payment methods.
    4. Go to the Installment payment method and select Edit details. Add payment method
    5. In the payment method details window, specify the name for the payment method as you want to display in the 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 contractually agreed with Unzer.
    • You can view the transactions in Unzer Insights.
    • In the Shopware 6 shop back end, you must also set up the key pairs for the B2C currency combination.

    Set up the payment method

    1. Go to Setting > Extensions > Unzer Payment and go the Installment keypair setup.
      Add key pair

      Field nameDescription
      Private KeyEnter the private key that is available in Unzer Insights.
      Public KeyEnter the public key that is available in Unzer Insights.
      Show WebhooksAfter Entering the key pairs, You can check all webhooks that are registered with the entered key pairs
      Register WebhooksRegister webhooks with entered key pairs
      Test API CredentialsTest the validity of the enterd key pairs
    2. Select Save.

    3. Select the domain and then select Register Webhooks > Save.

    4. Repeat the same steps to add other combinations according to your business case.

    5. In the shop back end, go to Settings > Extensions > Payment methods.

    6. Go to the Direct Debit Secured payment method and select Edit details.

    7. In the payment method details window, specify the name for the payment method as you want to display in the front end.

    8. Select Active and then Save.
      Activate payment method

    Set up one-click payments for cards, PayPal, and SEPA payment methods

    You can set up instant one-click payments for card, PayPal, and SEPA payments for registered customers. The customer can choose to save the payment method for the next purchase. They can also log in to the customer back end and delete them if they want to delete these tokens later.

    Supported payments: Credit cards, PayPal, and SEPA

    When a registered customer chooses any of these payment methods, a checkbox for saving the payment mean is displayed in the checkout page.
    Save credentials for next purchase
    If the customer chooses the option to save credentials for the payment then the token is saved for the next purchases.

    For example, for credit cards

    In the next purchase, the customer can choose to pay with saved card or add a new card:
    Display the saved card for next purchase

    To view and delete the saved payment means,

    1. The customer can log in to their account and go to Payment methods.
      Saved payment methods
    2. Scroll down to Your saved means of payment section to view or delete the saved details.
      Saved payment methods

    Next steps

    See also

    Shopware 6 documentation