Skip to content

    Checkout for Shopware

    This guide describes how to install, configure, and use the Checkout webshop module for Shopware 5.

    Compatibility: Shopware 5.0+
    Latest version: 1.1.3 (2022-10-04)

    Before you start

    Before you start, you need an Checkout Portal account. See the guide Create account for more information about creating a free test account.

    Shopware 5 has announced an end-of-support and end-of-life, in place from July 2024.

    This means that Checkout is no longer actively supporting Shopware 5 with any new security patches or features. This can also affect your PCI DSS (Payment Card Industry Data Security Standard) compliance. For this reason, we recommend that you migrate or upgrade to Shopware 6.

    Overview - Shopware plugin

    Our Shopware plugin is the perfect extension that enables you to use the Checkout checkout to its full potential for your Shopware store. Checkout supports most popular payment methods.

    You may see below all the payment methods offered by Checkout. This list refers to all markets.

    Depending on your country or region, the list may vary. If you are uncertain about a specific payment method and whether it is available in your country or region, please contact Support for more information.

    Checkout plugin - Shopware5

    Shop features

    • The fast checkout with "remember me" functionality.
    • Embedded checkout for an optimized user experience. Users are not redirected outside Shopware.
    • A smart mix of payment methods to suit all preferences.
    • Multiple checkout languages and currencies for selling in your domestic market and abroad.

    The following screenshot shows a checkout page provided by the Checkout module:

    oxid layout 2 embedded

    Administration features

    • Quick setup and flexible configuration.
    • Intuitive order management with synchronized captures and refunds.
    • Compatibility with discounts, tax (VAT), and shipping options.
    • Compatible with multi-shop setups.

    The screenshot below shows the settings page for the Checkout module:

    sw5 plugin install page


    Follow the steps below to install the Checkout module in Shopware 5.

    Step 1: Add the module to Shopware

    1. Download the latest plugin archive from GitHub:
    2. Upload the zip archive manually and extract it to the path /custom/plugins/nets or upload the zip archive under Configuration > Plugin Manager using the Upload plugin function in Shopware Admin.
    3. Clear your cache and refresh under Configuration > Caches/Performance.

    Step 2: Activate the module

    The next step is to activate the newly installed module under Shopware payment methods.

    1. Go to Payments methods in Shopware admin.
    2. Activate Checkout.
    3. Check with subshop settings so that you will have Checkout payment method available in your subshops.
    Shopware 5 add payment method

    The module is now installed and ready to be configured for your Checkout account.


    After installing the module, you need to do some basic configuration of the module:

    1. Navigate to Configuration > Plugin Manager > Installed
    2. Locate the Nexi Group payment plugin and click on edit (a pencil icon) to access the configuration.
    3. Fill out the required fields, such as merchant ID and integration keys (secret keys and checkout keys).
    4. (Optional) Customize the module according to your needs using the additional settings on the configuration page.

    Both the merchant ID and the integration keys can be found in Checkout Portal. See the following pages for more help:

    The screenshot below shows the configuration page for the module:

    sw5 plugin install page

    The following table lists all the settings you can configure in the administration area for the Checkout module:

    Configuration settingDescription
    Test ModeToggles between live mode and test mode. Choose test mode if you want to make test purchases using the test environment. There are sample card numbers and invoice addresses for testing purposes. Live mode requires an approved account.
    Live Secret keyYour live secret key from Checkout Portal.
    Live Checkout keyYour live checkout key from Checkout Portal.
    Test Secret keyYour secret key for test purchases from Checkout Portal.
    Test Checkout keyYour checkout key for test purchases from Checkout Portal.
    Terms UrlThe URL to the terms and conditions of your webshop.
    Merchant Terms UrlThe URL to the privacy and cookie settings of your webshop.
    Icons bar urlSet and customize icons listing by editing directly in url parameters or visit our custom Icons url generator at:
    Integration TypeSelect between Hosted and Embedded. Hosted loads a new payment page whereas embedded inserts the payment window directly on the checkout page.
    Auto-captureAllows you to instantly charge a payment straight after the order is placed. Important! Capturing a payment before shipment of the order might be liable to restrictions based upon legislations set in your country. Misuse can result in your Checkout account being forfeit.


    You've now installed and configured the Checkout webshop module. If you have further questions, please see the troubleshooting section below or reach out to our support.

    Order management

    It's possible to manage orders directly in the Shopware administration:

    1. Navigate to Customers > Orders
    2. Click on the edit icon (a pencil) to access order details for a particular order.
    3. Choose your desired action (Capture or Refund) on the Checkout tab. The Checkout plugin will synchronize automatically. The payment status will also be updated in Checkout portal.

    All transactions performed by Nexi Group are accessible in Checkout Portal.

    The following screenshot shows the list of orders in Shopware administration:

    capture & refund sw5 admin screen


    Below are some of the most common configuration errors, their cause and steps that you can follow to solve them.

    Nexi Group payment plugin is not visible as a payment method

    • Ensure the Nexi Group plugin is available in the right shop under Configurations > Payment method > Nets Checkout > Subshops.
    • Temporarily switch to the Shopware 5 standard template. Custom templates might need additional changes to ensure correct display. Consult with your web designer or developer.

    Nexi Group payment window is blank

    • Ensure your integration keys in the Nexi Group plugin settings are correct and do not contain additional blank spaces.
    • Temporarily deactivate third party plugins that might affect the functionality of the plugin.
    • Check if there are any temporary technical inconsistencies:

    Payments in live mode don't work

    • Ensure you have an approved Live Checkout account for production.
    • Ensure your Live Checkout account is approved for payments with the selected currency.
    • Ensure payment method data is correct and supported by your Checkout agreement.

    Go live checklist

    For more information, refer to the section Go-live checklist.

    Was this helpful?

    What was your feeling about it?