Shopware 6

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.

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

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

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.

There are three ways to install the plugin:

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

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

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

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

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

Go to your storefront and add a product to your cart.
Go to your cart and proceed to checkout.
Enter the required billing details. We recommend using a real email address so you can receive the order confirmation.
Select Card Payments.
Enter the following card details:
- Cardholder name: Any name
- Number: 4242 4242 4242 4242
- Expiry date: any future date
- CVV: 100
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.
Sign in to your Shopware 6 Administration.
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.

Tip

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

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

You can extend your Shopware 6 integration in the following ways:

Note

To enable an alternative payment method on your account, contact your Customer Success Manager.

We currently support the following payment methods on Shopware 6:

Check the individual payment method pages to see which ones you can support. Availability will depend on your location, as well as your customer's currency and billing address.

Sign in to your Shopware Administration and select the sales channel to which you'd like to add payment methods.
Under the Payment and shipping settings, select the payment methods you want to support.
Select Save.

Sign in to your Shopware Administration and select Settings > Payment methods.
Select Edit details next to Apple Pay.
In the Checkout.com Payments Configuration section, enter your Apple merchant ID. You can find this in your Apple Developer account.
Upload your Apple Key Certificate file (.key) and Apple PEM Certificate file (.pem).
Select Save.

See our Apple Pay documentation for more information.

Sign in to your Shopware Administration and select Settings > Payment methods.
Select Edit details next to Google Pay.
In the Checkout.com Payments Configuration section, enter your Google merchant ID. You can find this in your Google payments profile.
Select Save.

See our Google Pay documentation for more information.

Sign in to your Shopware Administration and navigate to Extensions > My extensions.
Next to Checkout.com Payments, select the three dots menu, then select Configure.
In the Payments section, select 3D Secure.
Select Save.

Sign in to your Shopware Administration and select _Settings > Payment methods.
Select Edit details next to Card Payments.
In the Checkout.com Payments Configuration section, select Manual Capture.
Select Save.

Once you've created an order, sign in to your Shopware Administration and find the order in Orders > Overview.
If the payment was not captured automatically on authorization, capture the payment now. A captured payment will have a Paid status.
Select an order number to open the order.
In the Items section, select Checkout.com Refund.
On the refund page, you'll see a list of items included in the order. Select the items you'd like to refund and the return quantity.
Select Yes, I want to refund the selected items, then select Refund selected items. A new line will appear showing the refunded item's quantity and price.

In case a rounding error occurs, you can use the Fix price difference button to adjust the refund amount.

Sign in to your Shopware Administration and navigate to Extensions > My extensions.
Next to Checkout.com Payments, select the three dots menu, then select Configure.
In the Order Status Customization section, you can customize statuses for paid, failed, authorized, or voided payments. Make sure that the order statuses match the configuration used in your store.

With our Shopware 6 plugin, you create automatic business flows using the Flow Builder. The Flow Builder requires Shopware version 6.4.6.0 or later.

Our plugin supports two Flow Builder flows: full capture and full refund.

Sign in to your Shopware Administration and select Settings > Flow Builder. This page contains an overview of all your created flows.
Select Add flow to create a new flow.
Enter a name and description for the flow.
Go to the Flow tab and select the trigger for which you would like to create a flow. For example, to create a refund flow, select State Enter > Order Delivery > State > Returned.
Select Add action, then select (checkout.com) Full refund.
Select Save. You can now test the refund flow by changing the delivery status of any order paid using a Checkout.com supported payment method to Returned.

Headless integration

Learn how to use our API endpoints to build your headless Shopware 6 integration.

We've made some changes to our API

Shopware 6

Supported features

Before you start

Create a test account

Get your API keys

Install the plugin

From the Shopware store

Using a .zip file

Using Composer

Configure the plugin

Test your integration

Tip

Go live

Extend your configuration

Support alternative payment methods

Note

Enable alternative payments

Enable Apple Pay

Enable Google Pay

Enable 3D Secure payments

Manually capture and refund payments

Manually capture a payment

Refund a payment

Customize order statuses

Create automatic refund or capture flows

Headless integration