Shopware 5

On this page, you will learn how to install the official plugin for Shopware 5 and connect Payrexx with your webshop.

As of July 2024, Shopware 5 is no longer being developed. Users of Shopware 5 are therefore advised to migrate to Shopware 6.

General

Shopware 5 is an e-commerce platform developed in Germany, allowing merchants to create and manage their own online stores.

Links

• Shopware Website

• Shopware 5 Documentation

• Login at Shopware

• Registration at Shopware

• Download Plugin

Features

• ✅ Multicurrency support

• ✅ Payment method icons in checkout

• ✅ Cart transmission

• ✅ Webhook status synchronization

• ❌ Look & Feel configuration

• ✅ Individual payment method configuration

• ❌ Subscription support

Please note that integration with Shopware 5 is only available in the Standard and Premium plans. For more information

Payment methods

The following payment methods are supported by the Shopware 5 plugin:

Payrexx Pay	Payrexx Pay Plus	External Payment Providers
Mastercard	Mastercard	Masterpass
Visa	Visa	PayPal
PostFinance Pay	American Express	Maestro
TWINT	Diners Club International	HeyLight
Google Pay	Discover Card	Swissbilling
Samsung Pay	Apple Pay	WIRpay
Pay by Bank	Google Pay	Barzahlen/viacash
Purchase on Invoice	Klarna	giropay
Reka	WeChat Pay	Paysafecash
Centi	Alipay	JCB
	eps	Ideal Payment
	Bancontact	Coinbase
	iDEAL	Bitcoin
	SEPA Debit Direct	Advance Payment
		Bill

Setup

Follow the instructions below to integrate Payrexx into Shopware 5. If you are using Shopware 6, please switch to the appropriate guide.

Installing the plugin

Download the latest plugin from GitHub by clicking on "Source code (ZIP)":

Downloading the plugin to integrate Payrexx into Shopware 5

• Log in to your Shopware account:

Login to Shopware

• Navigate to Extensions in the main menu and upload the Payrexx plugin.

• Activate the uploaded plugin.

Configuration of Payrexx

Make sure you're logged in to your Payrexx account before you begin. If you don’t have a Payrexx account yet, you can register now.

• Navigate to API & Plugins in the merchant administration of your Payrexx account.

• Click on "Show all" below "Add E-Commerce Integration".

• Click "Add" next to Shopware 5:

Creating an API Key for Shopware 5

• Make the following settings in the window below:

Configuring the connection of Shopware 5 in Payrexx

1. API Key: Copy the displayed API key to the clipboard as you will need it later.

2. Instance Name: Copy the displayed instance name to the clipboard as you will need it later.

3. Enter shop address: Enter the URL of your shop in this field. If your shop is not in the main directory (https://my-shop.com) but in a subdirectory, please provide the complete path to your shop. Example: https://my-shop.com/shop

Please ensure that the shop URL is entered correctly. Any discrepancies (e.g. using http:// instead of https://) may cause errors when processing webhooks.

1. Webhooks: Define whether a failed webhook should be retried or not. If the checkbox is enabled, up to 10 retry attempts will be made. The intervals for the attempts are 5 minutes, 15 minutes, 1 hour, 2 hours, 4 hours, and then every 24 hours.

2. Finalize: Click the green "Activate" button to complete the configuration.

Configuration of Shopware 5

Establish connection

Navigate to the Payrexx plugin in Shopware 5 and configure it by making the following settings:

1. Instance Name: Paste the instance name previously copied from Payrexx.

2. API Key: Paste the API key previously copied from Payrexx.

3. Create order before redirecting to Payrexx:

   1. Yes: An order is created after clicking the order button. As long as the payment is not confirmed, it will have the status "Open". Afterward, the status will change to "Paid". If the order fails, this will also be indicated in the status. The advantage is that an order with all important details is created even in case of connection interruptions.

   2. No: The order is created only after the payment process is completed. However, if there is a connection interruption, no order will be created. The advantage is that you receive fewer notifications about status changes. However, it may happen that no order is created even though the customer has made the payment.

Select payment methods

• Navigate to Settings > Payment Methods in your Shopware account to specify the payment methods your customers can use in the shop.

Payment Process from the Customer's Perspective

The following process shows the steps of an order in Shopware, including payment with Payrexx.

• The customer selects the desired product in the shop and adds it to the shopping cart:

Adding a product to the shopping cart

• The customer clicks the "Checkout" button.

• The customer logs in or enters their personal details and then clicks "Continue":

Login or entering customer data in the Shopware shop

• The customer selects the desired payment method and clicks "Continue":

Selecting the desired payment method

• The customer completes their purchase.

Testing an Order

Use our Shopware demo shop to test an order yourself:

DemoshopDemoshop