Skip to content

Shopware 6

Last updated: November 11, 2022

From downloading the plugin to requesting your first test payment, learn how to get started with the Checkout.com for Shopware 6 plugin.

To follow this guide, make sure you have Shopware 6.4.0 or later installed.


Supported features

  • Manual capture, refund, and partial refund from the Shopware 6 Administration
  • Frames
  • Custom order statuses
  • Webhook notifications for up-to-date payment statuses
  • 3D Secure 2.0
  • Google Pay and Apple Pay express checkout
  • Headless integration support

Before you start

Create a test account

If you haven't already, create a test Checkout.com account.

Get your API keys

To set up our Shopware 6 plugin, you'll need two API keys: a secret key and a public key. You can create your secret and public keys in the Dashboard.


Install the plugin

There are three ways to install the plugin:

From the Shopware store

  1. Sign in to your Shopware Administration and open the store for your extensions.
  2. Search for the Checkout.com Payments plugin.
  3. Install and activate the plugin.

Using a .zip file

  1. Download the plugin from Github.
  2. Sign in to your Shopware Administration and navigate to Extensions > My extensions.
  3. Select Upload Extension and select your .zip file.
  4. Once the file is uploaded, install and activate the plugin.

Using Composer

  1. Go to your Shopware (Symfony) root directory.
  2. Enter the following command:

$ composer create-project cko/shopware6 cko-shopware6-store-plugin --stability=stable

  1. Sign in to your Shopware Administration to install and activate the plugin.

Configure the plugin

  1. Sign in to your Shopware Administration and navigate to Extensions > My extensions.
  2. Next to Checkout.com Payments, select the three dots menu, then select Configure.
  3. Set Account Type to NAS.
  4. Enter your Checkout.com secret key and public key. If you're testing, make sure you use the sandbox API keys.
  5. To start testing card payments, select Sandbox Mode.
  6. Select Test API Keys to verify that the keys are properly configured. This will automatically register your webhooks in the Checkout.com Dashboard.
  7. Select whether you'd like to include shipping costs in the refunded amount when processing refunds.
  8. Select Save.

Test your integration

  1. Go to your storefront and add a product to your cart.

  2. Go to your cart and proceed to checkout.

  3. Enter the required billing details. We recommend using a real email address so you can receive the order confirmation.

  4. Select Card Payments.

  5. Enter the following card details:

    • Cardholder name: Any name
    • Number: 4242 4242 4242 4242
    • Expiry date: any future date
    • CVV: 100
  6. Select Submit order. You'll be redirected to the order confirmation page. If you entered a real email address in the billing details, you'll also receive an order confirmation email.

  7. Sign in to your Shopware 6 Administration.

  8. Go to Orders > Overview. Your test order will be displayed there with an Open order status and a Paid payment status. This indicates that the payment has been successfully captured. The transaction will also appear in the Payments section of your sandbox Dashboard account.

You can now either go live as is or extend your configuration.


Go live

If you're happy with the outcome of your testing and want to start taking payments right away, contact our Sales team in order to move to a live account.

Before you go live, remember to:

  • Deselect Sandbox Mode in the plugin's settings
  • Replace the sandbox API keys in the plugin's settings with the production API keys
  • Make sure webhooks are properly configured
  • Make sure you only activate payment methods that are enabled in your Checkout.com Dashboard account

Extend your configuration

You can extend your configuration to support alternative payment methods, use 3D Secure payments, and more.