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.

To accept payments, you have to configure the payment methods, which you’ve contractually agreed to with Unzer.

Before you begin

Configure payment methods

Individual Payment Method Settings

Now you can configure the individual payment methods. Expand the payment method that you want to configure. The options available vary for each payment method. For example, for card payment method, it can contain the following details.

payment config

Field nameDescription
EnabledSet this to Yes to offer it to your customers at the time of checkout. This activates the respective payment method in the store.
TitleEnter the name of the payment method as it is displayed in the store and in emails.
For multiple Store Views with different languages, you can use this field to translate the payment type names.
The default value will be automatically translated to German if the store uses a German locale.
And translation files can be used to change/add translations.
Booking ModeConfigure the booking mode for the payment methods Credit cards, Debit Cards, and PayPal.
Available modes are:

Debit (Direct Charge)
The order amount is charged immediately.

Authorize
The order amount is reserved at first and captured later when the invoice is created.
Sort OrderEnter the order in which payment methods are displayed in the store.
Minimum Order TotalEnter the amount that your customers order for the payment method if the order total is in this range. To deactivate a limit, set 0 value.
Maximum Order TotalEnter the maximum amount that your customers can select the payment method if the order total is in this range. To deactivate a limit, set 0 value.
Merchant NameThis determines the merchant name displayed in the direct debit mandate for the respective payment method.

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

You can set up instant one-click payments for card and PayPal 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.

Set up one-click payments for card payments

  1. In the admin back end, go to STORES > Configuration > SALES > Payment Methods, and go to Credit Card / Debit Card. One-click payment
  2. In the Enable Vault for Card Payments, select Yes.
  3. (Optional) If you want to the Instant Purchase button for the registered customers, select Yes.
  4. Select Save Config.
icon
If you activate the Instant Purchase button, you must also manage the legal and 3DS-related requirements according the applicable laws.

Set up one-click payments for PayPal payments

  1. In the admin back end, go to STORES > Configuration > SALES > Payment Methods, and go to PayPal. One-click payment
  2. In the Enable Vault for Card Payments, select Yes.
  3. (Optional) If you want to the Instant Purchase button for the registered customers, select Yes.
  4. Select Save Config.
icon
If you activate the Instant Purchase button, you must also manage the legal and 3DS-related requirements according the applicable laws.

When the registered customer selects, the Save my credentials for the next purchase, they don’t need to enter their details and the saved token is selected for the next purchase. For example, if they select the card that was previously used for the purchase, they can do the 3D Secure check and make the payment.
If the customer wants to delete the saved credentials, they can log in to their account and delete the same.

Set up Unzer Invoice payment method

  • For Unzer Invoice, 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 (CHF), B2C (EUR), B2B (CHF), and B2B (EUR).
  • 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.
  • You must generate an invoice in the Magento 2 back end before you can charge the payment. This ensures that the insurance period is initiated.
  • In the Magento 2 shop back end, you must also set up the key pairs for the B2B and B2C currency combination. Go to Stores > Configuration > Sales > Payment methods. Override API keys
Field nameDescription
Override API keysThis field is only available for Unzer Paylater Invoice (B2B) and Unzer Invoice (B2C). Select Yes to enable the key pairs specific for Paylater Invoice. This is required from a technical point of view so that the correct payment method is available, and the correct payment flow is used for the transaction.
Public KeyThis field is only available for payment methods that require additional key pairs. Enter the public key that is available in Unzer Insights.
Private KeyThis field is only available for payment methods that require additional key pairs. Enter the private key that is available in Unzer Insights.
  • Select Save Config.

Set up the 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 (CHF), B2C (EUR).
  • 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.
  • You must generate an invoice in the Magento 2 back end before you can charge the payment. This ensures that the insurance period is initiated.
  • In the Magento 2 shop back end, you must also set up the key pairs for the B2C currency combination.

Set up the payment method

  1. Go to Stores > Configuration > Sales > Payment methods and scroll down to Installment.
    Override key pair
  2. Select Enabled as Yes.
  3. Enter the key pair, select Override API Keys as Yes, and then select Save Config
    Save configuration
Field nameDescription
Override API keysThis field is only available for payment methods that require additional key pairs. Select Yes to enable the key pairs specific for Installment payment method. This is required from a technical point of view so that the correct payment method is available, and the correct payment flow is used for the transaction.
Public KeyThis field is only available for payment methods that require additional key pairs. Enter the public key that is available in Unzer Insights.
Private KeyThis field is only available for payment methods that require additional key pairs. Enter the private key that is available in Unzer Insights.

Set up Direct Debit (Secured) payment method

  • For Direct Debit, ensure that only end customers with an invoice address from Germany and Austria can use this payment method.
  • You require a unique key pair for this payment method, for example, a separate key pair for each combination B2C (EUR).
  • Only B2C customer type is supported.
  • Only Euro (EUR) 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.
  • You must generate an invoice in the Magento 2 back end before you can charge the payment. This ensures that the insurance period is initiated.
  • In the Magento 2 shop back end, you must also set up the key pairs for the B2C currency combination.

Set up the payment method

  1. Go to Stores > Configuration > Sales > Payment methods and scroll down to Direct Debit.
    Navigate to Direct Debit
  2. Specify the payment method details.
    Direct Debit
  3. Select Enabled as Yes.
  4. Enter the key pair, select Override API Keys as Yes, and then select Save Config.
    Save configuration
Field nameDescription
Override API keysThis field is only available for payment methods that require additional key pairs. Select Yes to enable the key pairs specific for Direct Debit. This is required from a technical point of view so that the correct payment method is available, and the correct payment flow is used for the transaction.
Public KeyThis field is only available for payment methods that require additional key pairs. Enter the public key that is available in Unzer Insights.
Private KeyThis field is only available for payment methods that require additional key pairs. Enter the private key that is available in Unzer Insights.

Next steps

See also