Version 1.12

Zuletzt bearbeitet am: 09.01.2024

About the plugin

Requirements

Klarna merchant account

Before you can set up and use Klarna in Shopware, you need to open a merchant account with Klarna. A separate account with Klarna Playground is required to perform test orders. Our merchant support will be happy to help you to activate payment methods and countries.

Technical requirements

To install the Klarna Plugin, you need a running Shopware 6 environment. You can find an installation guide on https://docs.shopware.com/en/shopware-6-en/first-steps/installing-shopware-6. To send payment updates Klarna’s systems must be able to access your shop from the outside. Pay particular attention if you have set a password request (htpasswd) on your page. The system prerequisites for the plugin are as follows:

  • Shopware (Version >= 6.1)
  • PHP (Version >= 7.2)
  • Complete installation of shopware (storefront and administration, not headless)

Installation & Setup

Installation via Shopware First Run Wizard

Shopware first run wizard

Klarna is a preferred payment provider in Shopware 6. During the installation of Shopware you have the possibility to load the Klarna plugin into your Shopware installation with a single click. After installing Shopware you will be guided through the setup wizard of Shopware 6. The so-called First Run Wizard supports you actively in setting up the Klarna plugin. To do this, first select “Plugins” and choose your country. Under “Payment” you can select the Klarna plugin by clicking the “Install” button. Then click on “Next” to continue the Shopware First Run Wizard.

Installation via Administration

If you decide to install the Klarna Plugin after the first run wizard, you can register it for your shop domain (or shop domains) free of charge in the Shopware Community Store at https://store.shopware.com/en. For this follow the instructions at https://store.shopware.com/en/how-to-find-the-plugin. Klarna im Shopware Community Store After you have licensed the plugin you can find it in the administration under Settings > System > Plugins > Licences. Click on “Download” next to the Klarna plugin to download it into your Shopware installation.

Installation via direct download in the Community Store

In Shopware 6 you also have the possibility to upload a plugin to your installation manually. You can do this in the administration via Settings > System > Plugins > Upload plugin. Download the ZIP archive of the plugin from https://account.shopware.com and upload it in your installation. You find instructions on how to obtain the ZIP archive at https://store.shopware.com/en/how-to-find-the-plugin. If you have not yet licensed the plugin, you can register the Klarna plugin for your shop domain(s) free of charge in the Shopware Community Store at https://store.shopware.com/en. Follow the instructions at https://store.shopware.com/en/how-to-find-the-plugin.

Activating the plugin

Install Klarna plugin After you have successfully loaded the Klarna plugin into your Shopware 6 installation, you can set it up and activate it. To do this go to the overview of your plugins in the Shopware Administration. You access this via Settings > System > Plugins. Here you find the Klarna plugin in its delivery state. Select the menu item “Install” in the context menu (“...”). You will receive a success message from shopware that the plugin has been installed successfully. For your security, the plugin is now installed but not yet activated. First you have to optimize it with your access data and individual settings.

Wizard

Klarna Plugin Wizard After the installation the Klarna plugin can be initially configured. For this, we will guide you through an installation routine. To reach this first activate the plugin via the slider. After the plugin has been activated, you can call the installation routine in form of a wizard in the administration via Settings > Plugins > Klarna. You will then be redirected to the routine. In the menu item “Sales Channel” of the wizard you have the possibility to assign Klarna’s payment methods to all or only certain sales channels: The default setting is “All Sales Channels”. If you want the Klarna Plugin to be available for all your sales channels, you can skip this setting. If you want the Klarna Plugin to be available only for a specific sales channel, select the channel you want to configure in the drop-down menu of the field “Sales Channel”. More channels are only available after the wizard is completed.

Click on the button “Finish” to save all the settings you have made in the wizard. You will then be redirected to the plugin configuration. The reopen the wizard press the button “Start Wizard” in the plugin configuration.

Plugin configuration

After you have successfully completed the wizard, you can adjust the plugin configurations. If you want to adjust the configuration again at a later time, you can call up the plugin configuration in the administration via Settings > Plugins > Klarna.

Sales channel

Klarna Plugin configuration sales channels

Here you specify whether the following settings are to apply to "all sales channels" or only to certain individual sales channels.

Global API settings

Klarna Plugin global API settings

API Test Mode

Here you can activate and deactivate the API test mode. If this is activated, only test orders are created. No payments are made, which debit an account, for example. This mode is particularly recommended for testing the functionality of the plugin, for updates or when setting up your shop for the first time, as well as in development or staging environments. The API test mode should be deactivated as soon as you want to use your shop productively.

Debug mode

Here you can activate and deactivate the debug mode. If this is activated, you can track all inputs, outputs and changes of the plugin in the Klarna Plugin Log.

API settings

Klarna Plugin API settings Europe Klarna Plugin API settings North america

API Username and API Password

Enter your API access data for live and test mode in the appropriate sections here. If you do not have your access data at hand, you can retrieve them at https://eu.portal.klarna.com/. You can check your API access data with the button "Test API access data", which is located in the header area. You will then receive a success message or a note indicating which data does not appear to be correct. If you have not yet registered with Klarna or your Klarna customer number does not begin with Kxxxxxx, please contact us by e-mail at vertrieb@klarna.com.

Europe and North America

Depending on the desired sales countries for your shop, shop the corresponding access data for Europe and/or North America. If you only offer sales for one region, it is sufficient to leave the input fields for the other region empty. The access data to be used will be based on the country of invoice.

The North America region currently only supports the United States of America. Please note that this country has the ISO code "US" configured in your shop.

Please note that you may need different login details to use multiple regions. Please contact Klarna merchant support.

Basic settings

Klarna On-Site Messaging

Klarna on-site messaging Here you can activate or deactivate Klarna On-Site Messaging. If you already have data for it, you can fill in the fields for the script and the snippet (placements) for Klarna On-Site Messaging. If you do not have any data, you can create data by clicking on “Generate your data here”.

The Klarna On-Site Messaging will only be displayed on the product detail page. When using financing placements, the amount must be issued via a variable, otherwise no placement will be displayed.

<!-- Placement v2 -->
<klarna-placement
  data-key="credit-promotion-badge"
  data-locale="de-DE"
  data-purchase-amount="{{productPrice}}">
</klarna-placement>
<!-- end Placement -->

It is mandatory to make sure that {{productPrice}} is inserted without spaces between the curly braces.

Payment Behavior

Klarna payment behaviour

Automatic capture

Choose between “Delivery Status”, “Order Status” or deactivate the automatic capture. If you have selected “Delivery Status” or “Order Status”, a further selection appears in which you can determine at which “Delivery Status” (e. g. shipped, shipped partially, open) or “Order Status” (e. g. open, in progress, done) the outstanding amount should be automatically captured. If you select “Deactivated” no amounts will be automatically captured.

Automatic refund

Choose between “Delivery Status”, “Order Status” or deactivate the automatic refund. If you have chosen “Delivery Status” or “Order Status”, a further selection appears in which you can determine at which “Delivery Status” (e. g. shipped, shipped partially, open) or “Order Status” (e. g. open, in progress, done) the recorded amount should be automatically refunded. If you select “Deactivated” no amounts will be automatically refunded. In addition to the automatic entry amounts can also be entered and refunded manually in each order.

Payment Settings

Klarna payment settings

Klarna Product

Shows whether your Klarna Payment plugin is active. This can only be set via the wizard. To get to the wizard, click on “Start Wizard” in the plugin settings at the top.

Send Extra Merchant Data

This function allows to send extra merchant data via the plugin from shopware to Klarna when setting up the user session and after Klarna´s order has been created (e. g. in case of additional fields in the registration process or in case of hotel bookings).

If you activate this setting the Klarna logo will appear in the footer of your shop. Deactivate this setting, if you don’t want this to happen.

Use the authorization callback

By activating the authorization callback, the order is created even if there are communication issues on the client side.
Payment methods that require complex client interactions, such as switching between banking apps, are prone to communication issues. This can result in the customer being charged without the order creating in Shopware. Such errors can affect your store's conversion rates if the customer thinks they've completed an order but doesn't receive a confirmation from the shop. Enable this option to improve conversion rates.

Configuration in the Saleschannel

Klarna is only available in selected countries, languages and currencies. If additional countries or additional country-language-currency combinations are configured in the sales channel, the Klarna payment methods will not be available. Please note that the available countries may first need to be activated for your account by merchant support.

Activate/deactivate the plugin

If you want to activate or deactivate the Klarna Payments plugin or just want to see the current activation status, go to Settings > System > Plugins in the administration. There you can find the current status in the table below “My Plugins”. The status can be changed by clicking the slider.

Uninstalling and restoring the plugin

If you want to uninstall the plugin, you can do this in the administration via Settings > System > Plugins in the context menu (“...”) of the plugin by clicking on “Uninstall”. The plugin will still be displayed under “My Plugins”, but it is deactivated now. Using the context menu, you now have the options “Install” and “Delete”.

  • Install: The plugin will be restored with the initial configuration. No settings will be lost during uninstallation. However, after installation, the plugin still has the status “deactivated”. The status (activated/deactivated) can be changed by clicking the slider.
  • Delete: Select this option only if you definitely want to delete the plugin. First you have to uninstall the plugin.

Activate/deactivate payment types

Klarna Zahlungsarten If the Klarna Payments Plugin is activated, you can use all payment methods provided by Klarna for your sales channels. Currently, you can choose between the following payment methods:

  • Credit card
  • Direct Debit
  • Hire purchase (“Financing”)
  • Invoice (“Pay Later”)
  • Online Bank Transfer

In order to make certain payment methods available to your customers, go to Settings > Shop > Payment. Here you can find all the above mentioned payment methods. In the context menu you can choose between “edit” and “delete”.

  • Edit: Here you can adjust the status (Active/Inactive), the logo (note that a Klarna logo is already displayed by default for each payment method in the storefront), the position in the checkout, the description and the availability rule for each payment method.
  • Delete: Herewith you delete the payment method completely. After deletion, you can no longer adjust this payment type. If you have deleted a payment method, but want to use it again later, you must reinstall the Klarna Payments Plugin via the wizard.

A payment method that has already been used to process payments can only be deactivated.

To activate specific payment methods, click on “Edit” in the context menu. Then click the slider at “Active” to change the activation status. If the status is set to “Active”, customers (depending on the availability rules) can then use this payment method in the checkout and process payments with it. Please note that the desired payment methods also must be selected in the sales channels to make them usable for customers.

Translation of the payment methods

If Shopware is not installed with English as the system language, the payment types will not be translated correctly. This can be easily adjusted manually under Settings > Shop > Payment.
More details about this case can be found in ticket NEXT-12900.

Limitations for Configuration in Shopware 6.3.4.0 and above

Currently the configuration inheritance for specific sales channels can not be displayed correctly for Shopware 6.3.4.0 and above. Please make sure to make sales-channel-specific configuration changes in full, until a future Klarna plugin update mitigates this.

Usage

Order Cancellation by the customer

With Shopware 6.2 you have the possibility to allow your customers to cancel orders via the storefront. You can find this setting in the administration under Settings > Shop > Cart Settings > Enable refunds.

If the order is cancelled via the storefront, Klarna will not issue an automatic refund.

Allowing change of payment method after completion

Klarna payment type change

With Shopware 6.2 you have the possibility to allow your customers to change the payment method after placing their order. If you have updated the Klarna plugin before Shopware, this option for Klarna payment methods is deactivated. To allow your customers this function, go to the administration and select Settings > Shop > Payment. For each Klarna payment method you use in your shop, navigate via the respective context menu to “Edit” and activate the option “Allow payment change after checkout”.

B2B sale

Selling to other companies is only possible with Klarna in certain countries. For this, see the answer to the question Can I sell to other companies with Klarna? from Klarna merchant support.