Shopware 6 User Guide - English
Saferpay Plugin for Shopware 6
Requirements
Shopware Version 6.4.8.x - 6.7.x.x
Saferpay account with at least one eCommerce terminal
Saferpay API Credentials (Customer-ID, Terminal-ID, JSON API Username and Password)
Valid acceptance contracts for the payment methods to be used
Installation and Activation
Log in to the Shopware 6 backend.
Navigate to: Extensions--> My Extensions --> Apps -->Upload extension and upload the plugin or install the plugin via your Shopware account
Open the context menu via the "..."-button and click the button Install.
Under My extensions --> Apps you can activate the plugin via the corresponding switch.
Configuration
General settings
Click the button with the three dots (…) on the right side and select Configure to get to the plugin configuration.
At Operation Mode select either "Live" or "Test", depending on which Saferpay environment you want to use (see https://docs.saferpay.com/home/integration-guide/testing-and-go-live).
At Merchant email addresses, enter a comma-separated list of up to 10 email adresses that should receive a confirmation email after successful payment authorization.
At Payment Page-Configuration you can specify the payment page configuration you want to use by entering the of the corresponding configuration (see https://docs.saferpay.com/home/features/payment-page-configuration).
The “Save payment method” option defines whether the payment information should be saved via Secure Card Data (for more information, see the “Save payment data” section)
The “Force 3-D Secure” option is used to define whether a 3-D Secure challenge should be forced (see https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/general-information/3d-secure#forcing-a-3ds-challenge)
The “Payment Reference” option allows you to specify whether the order number or the order ID should be sent to Saferpay as a reference.
At the configuration section Payment API (JSON API) live credentials you enter the data of your Saferpay live account (Customer-ID, Terminal-ID, JSON API Username, JSON API Password), which should be used if the operation mode "Live" is selected.
At the configuration section Payment API (JSON API) test credentials you enter the data of your Saferpay test account (Customer-ID, Terminal-ID, JSON API Username, JSON API Password), which should be used if the operation mode "Test" is selected.
In the “Payment capture behavior” configuration block, you can configure individually for each Saferpay payment method that supports manual payment capture whether the payment should be captured automatically (auto-capturing) or not (for more information, see the “Manual payment capture” section).
Saferpay Fields
Instead of redirecting the user to the Saferpay payment page to enter payment information during the payment process, Saferpay Fields allows payment information (e.g. credit card details) to be entered directly in the final checkout step.
This can be configured individually for each payment method. Please note that integration only works with payment methods supported by Saferpay; otherwise, payment via the payment page will be used as a fallback.
Iframe integration
Instead of redirecting the user to Saferpay, payment processing can be embedded directly into the Shopware checkout process via iframe integration.
Iframe integration is supported for both Saferpay Fields and the payment page.
Save payment methods
Payment means can be saved via Secure Card Data (see https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/secure-card-data). The saved payment methods can be viewed and deleted in the Shopware customer account:
If you use Saferpay Fields, customers can use the stored payment method(s) for their next purchase:
Add payment methods
After you have made the general settings for the Saferpay plugin, you need to configure the payment methods you want to support:
Go to Settings--> Payment methods in the Shopware 6 admin area.
All payment methods supported by the Saferpay plugin will now appear here.
Open the details of the payment methods you want to use.
Activate the payment methods
In the section Custom fields in the tab Saferpay you can use various fields to configure the payment method.
At Payment means you can explicitly set which means of payment should be available on the Saferpay payment page when this payment type is selected in the storefront. Please note that the payment method must also be activated in the Saferpay terminal. If you leave this field empty, all payment methods available in the Saferpay terminal will be offered.
If 3D-Secure (https://docs.saferpay.com/home/integration-guide/3d-secure) is supported by the payment methods, you can set at Liability shift behavior whether the payment should be aborted if no liability shift is granted or whether the payment should be accepted anyway.
At Wallets you can set which wallets should be available on the Saferpay Payment Page when this payment type is selected in the storefront. Again, the payment type must be enabled on the Saferpay terminal. If you leave this fields empty, no wallets will be offered
Note that all configurations can be configured individually for each Shopware language. By default, all fields are empty for all NON-standard languages. If a field is empty in a NON-standard language, the value is taken from the standard language.
Setting up the Checkout Page
Last but not least, the payment methods must be assigned to the sales channels so that customers can select them in the checkout process. To do this, proceed as follows:
Navigate to Sales Channels in the Shopware 6 admin area.
Select the sales channel for which you want to activate the payment methods.
In the section Payment and shipping, assign the Saferpay payment methods you want to use for this sales channel.
After assigning the payment methods to the sales channels, the corresponding Saferpay payment methods are available in the storefront.
Refunds
If amounts have already been captured, you can use the “Saferpay” tab to refund either a specific partial amount or all captured amounts at once.
Since plugin versions 1.8.0, 2.6.0 and 3.1.0, it has been possible to configure whether the order number or the order ID should be transmitted to Saferpay as a reference for refunds:
Manual capturing
If you configure a payment method as “Manual,” the Shopware payment status will be set to “Authorized” after each payment transaction using this method, rather than directly to “Paid.” To manually confirm the payment after authorization (capturing), you must change the payment status of the corresponding orders from “Authorized” to “Paid” via the Shopware backend. When the Shopware status is changed, the corresponding Saferpay payment is captured.
Under the “Saferpay” tab, you can also enter several specific partial amounts:
Cancel authorized amounts
You can cancel authorizations by setting the Shopware payment status to “Canceled” or by clicking the “Cancel Authorization” button in the “Saferpay” tab.
Last updated
Was this helpful?