Merchant Login

Shopware

Integration manual
Sofort

1. Introduction to ''Direct Bank Transfer''

Customers (end customers) do not have to register for 'Direct Bank Transfer'': They make a fast and easy payment using their online banking details. Thanks to real time acknowledgement of the transfer order, you as a merchant can immediately ship the goods or provide services. Furthermore, you can optionally offer buyer protection, providing additional security for your customers.

From your customer's perspective, a ''Direct Bank Transfer'' transaction consists of the following steps:

As soon as payment by 'Direct Bank Transfer'' is requested, the customer is redirected to a ''Direct Bank Transfer'' page.

Below the overview of the transfer data (recipient, reason, amount), your customer is requested to enter the sort code.

Subsequently, your customer is asked to log on by entering the online banking details.

After successful logon, the customer has to confirm and release the transfer by entering a valid confirmation code.

If a valid confirmation code has been entered, the transfer is authorized and your customer will receive a summary of the executed transaction.

Finally, the customer is redirected to your online shop with one click.

2. Integration steps

The following steps are required to integrate  SOFORT Überweisung / SOFORT in Shopware 4 SOFORT Überweisung / SOFORT :

  1. Register as a merchant on our website https://www.sofort.com/register
  2. Create a new SOFORT project and configure it
  3. Install the SOFORT module in the shop
  4. Set up the SOFORT module in the administration backend of your shop

3. SOFORT project setup

3.1. Registration at ''Direct Bank Transfer''

In order to be able to offer ''Direct Bank Transfer'' in your shop, a customer account with ''Direct Bank Transfer'' is required.

If you do not have such an account you may register at https://www.sofort.com/register.

After your registration, you have to be logged on in the merchant area and have to create a project for your system / online shop. If you do not use  ''Direct Bank Transfer'', you have to activate the desired product. Go to "My account > Product activation" in the left navigation bar.

3.2. Create new SOFORT project

To set up a project, click "New project" in the left column and create a SOFORT Gateway project. If you already us another SOFORT payment method in your shop, you may activate  Shopware 4 in the project that already exists.

Attention: Please create a "SOFORT Gateway" project

Functions such as automatic refunds and buyer protection are only available if you provide a Deutsche Handelsbank account. You will have the possibility to apply for a Deutsche Handelsbank account during project setup.

Complete your project data now. The most important settings are:

General settings

  • Project name: Enter the name of your shop here.
  • Shop system: Select your shop system.
  • Industry: Select your industry.
  • Website: Enter the URL of your online shop.

Address

The address entered here will be displayed to your customer on our payment wizard.

Bank account information

Enter your bank information here for the receipt of payments. Please keep in mind that international transactions in other currencies require a corresponding currency account. After you have created the project, you may store additional bank information for foreign currencies (e.g. a Złoty currency account for transactions from Poland) in the "Extended settings".

Settings for all payment methods

Select your merchant profile first:

  • Merchant/Shop provider: Select this profile if you offer goods for sale.
  • Content provider: Select this profile if you offer digital goods (downloads, credits, etc.) or services for sale.

Automatic redirection: Please activate this option

Please do not change the other settings as they are determined by the module.

Buyer protection

If you have a Deutsche Handelsbank account, you may activate buyer protection. Your account must be activated for this feature; please check with Deutsche Handelsbank for this purpose. More information on Deutsche Handelsbank and buyer protection can be found at https://www.handelsbank.com/

Payment methods

Activate  Shopware 4 here by enabling the checkbox.

  • Test mode: By activating this option, you can test Shopware 4 . More information can be found in the "Testing" chapter. Test transactions and real transactions are possible in parallel. However, we recommend to deactivate the test mode for productive operation.
  • Block sender country: Leave this option disabled.

Configuration key

After you have created the project, you can view the configuration key in your project. Please store this key with your module.

Project logo

After you have created the project, you can upload a logo of your shop or company in the "Extended settings". This logo will be displayed on our payment wizard instead of the registered address.

4. Interface installation

If you do not use the preinstalled module, carry out the following steps. Otherwise, you may skip the upload and continue installing the SOFORT module.

Note:

  • It is recommended to make a backup copy of your shop and database before you make any changes in your shop system.
  • Please ensure that no previous version of the module is installed in your shop system.

4.1. Interface download

In order to use SOFORT Überweisung / SOFORT in your shop system, you first have to download the SOFORT module for var: https://www.sofort.com/integrationCenter-eng-DE/.

Note: When using Shopware 4.3.4 or higher the manual installation described in this section is not recommended. Please install the plugin directly from the Shopware Community Store in the Plugin Manager.

4.2. SOFORT module upload in Shopware (only Shopware versions < 4.3.4)

To integrate the interface for SOFORT products, proceed as follows:

  1. Open the admin interface of your SOFORT Überweisung / SOFORT shop, go to the menu item "Configuration > Plugin Manager" and click the button "Add plugin manually"

    Modul Upload Shopware (1)
  2. Insert the previously loaded ZIP file in the field "Upload plugin".

    Modul Upload Shopware (2)
  3. Finally click the button "Upload plugin".

4.3. Payment method installation

The next step after uploading the SOFORT module is the installation.

Warning:

For systems with a high workload, or if you are using more than 5 subshops, during the following installation process a timeout may occur. If you face such a problem, please do not hesitate to contact our support team.

Locate the payment module of the SOFORT named "Sofort AG Shopware Module" in the list. Click the green plus sign to the right of the module (if a blue, round arrow is displayed to the right of the plus sign, click it before the installation to update the module).

Modul Upload Shopware (3)

5. Module configuration

After successfully uploading and installing the SOFORT module, it can be configured.

5.1. Payment method configuration

  1. Go to "Configuration > Basic settings" in your admin area.
  2. Click the plus sign in the left column in the menu item "Payment methods" and then "Sofort AG Shopware Module". If the module has been integrated correctly, the available payment methods for this module will appear there.

    Modul Konfiguration Shopware (1) (SÜ) - 2.1
  3. Enter the configuration key from the SOFORT merchant menu in the field "configuration key" and press "Save".
  4. The following expert settings might be edited but are not necessary for the proper function of the module.

Reason 1/Reason 2: here you can define the default reason for the SOFORT transaction. The following replacement parameters can be used:

    • {{order_id}} - order id
    • {{order_date}} -order date
    • {{customer_id}} - customer id of the buyer
    • {{customer_name}} - name of the buyer
    • {{customer_company}} - company name of the buyer
    • {{customer_email}} - email address of the buyer
    • {{transaction_id}} - transactions-ID of the SOFORT transaction

Attention: Each of the two reason fields allows reasons with a length up to 27 characters. Any characters over the limit will be truncated. Special characters are not allowed and will be removed.

    • Activate logging: if activated the API calls will be logged (at "Configuration > Logfile > Sofort AG Log"). For privacy reason, this should only be activated for debugging purposes.
    • Place order before redirection:
      • Yes: If this is selected the order will be visible in the Shopware Orders Overview ("Customers > Orders") right after the redirection of the customer  to our payment form. The payment status will change as set in the status settings.
      • No: If this is selected the order will not be visible in the Shopware Orders Overview ("Customers > Orders") until the payment was executed successfully with SOFORT. All transactions that were not (yet) finished are listed in the Cancellation Analysis in the Shopware administration ("Marketing > Analysis > Cancellation Analysis").
    • Discard aborted payments: if activated aborted payments will not be stored as orders.
    • Banner or text in the selection of payment methods: choose the presentation of the payment method in the checkout.
    • Display buyer protection text/banner: if activated the buyer protection will be shown in the checkout. Keep in mind that you also need to activate buyer protection in the SOFORT merchant area.
    • Recommended payment method: if activated the payment method will be shown as "(recommended payment method)".

Status settings

    • Temporary - define the status for orders that have not been paid yet.
    • Confirmed payment - define the status for orders that have been successfully executed with SOFORT.
    • Receipt of payment - define the status for orders for which the amount has been received on the bank account. Only available if you have a Deutsche Handelsbank account.
    • Aborted payment - define the status of orders that have been aborted.
    • Check order - define the status of orders that need to be checked due to a payment loss. Only available if you have a Deutsche Handelsbank account.
    • Partial refund - define the status of orders that have been partially refunded.
    • Refund - define the status of orders that have been completely refunded.After installing and configuring the module, the respective payment method must finally be activated to be displayed to your customer when selecting a payment method (see next chapter).

5.2. Individual payment method activation

  1. Go to "Configuration > Payment methods" in the admin area of your shop. All available payment methods are displayed.
  2. Click the desired payment method (e.g. SOFORT Überweisung / SOFORT ). You may now adjust specific shop settings as regards this payment method, e.g. availability for certain countries, surcharges, etc.

    Modul Konfiguration Shopware (2) (SÜ)
  3. Enable the checkbox "Active" to activate the module.
  4. In the field "Position" you may determine the placement of the payment method in the payment selection list (the lower the number, the higher up the payment method will be placed).

5.3. Mapping the payment method with the shipping costs

  1. Navigate to "Configuration > Shipping costs"
  2. Do the following steps for each shipping cost entry that should be used together with SOFORT Überweisung / SOFORT :
    1. Click on the pencil symbol to edit the shipping cost entry
    2. Choose the payment method SOFORT Überweisung / SOFORT on the tab "Payments", click on the right arrow and choose "Save".

5.4. Finalization of the configuration

In order to apply the edited settings you need to clear the shop cache. Click "Configuration > Caches / Performance" and choose the options of the following screenshot. Confirm your selection by clicking "Clear".

Modul Upload Shopware (4)

Information on orders paid by SOFORT Überweisung / SOFORT can be found in "Customer > Orders".

If you have selected Place order before redirection: No in die settings of our module you can quickly delete all (or single) orders for which the payment was not completed. You can find the overview over these orders under "Customer > Payments > Sofort AG Orders"

Please note: Beginning from version 2.2.0 of the module there is the possibility to change the order creation process of an order paid with SOFORT. Following the steps below the order process will be
adapted to the process known from other payment modules and therefore increasing compatibility with other modules (like for example "Bonus-System":
1) Edit the file "OrderProcessHelper.php" which you can find in the folder "/engine/Shopware/Plugins/Community/Frontend/SofortPayment/Components/Helpers/" on your server. Change the line "private $createOrder = true;" to
"private $createOrder = false;"
2) In the settings of the SOFORT module in the Shopware-Backend set the option "Place order before redirection:" to "No"
Notice: If this change is made the order number cannot be used in the reason fields of the transaction.

6. Testing

In order to check the correct integration in your shopsystem please perform a test transaction by placing an order directly in your shop. The single steps are:

  1. Activate the test mode in the desired project in the SOFORT merchant area.
  2. Place an order in your shop / system and choose SOFORT Überweisung / SOFORT as the payment method.
  3. In order to simulate German sender bank accounts use "88888888" (8x "8") on our payment form, for Belgium choose "Others" and "999" (3x "9") and for all other countries "00000" (5x "0") or select "Demo Bank". The following requested data can be chosen randomly with at least 4 digits. (Instead of the test bank code a country specific test BIC will shortly be available: "SFRT{ISO-country code}20XXX", e.g. "SFRTDE20XXX" for Germany)
  4. Please check if the redirect works properly:
    1. Redirect after successful payment to success page?
    2. Are all notifications sent properly?
    3. Order in your shopsystem is created correctly and status is updated accordingly?

Note: After successfully testing SOFORT please deactivate the test mode in the project settings in the SOFORT merchant area to prevent customers to simulate payments with the test data.

7. Support & Contact

The ''Direct Bank Transfer'' team will be available if you need help.

You may send us an email at service@sofort.com.

We are also glad to assist you in case of technical issues:

Technical support:
Phone: +49 (0)89 24 88 37 691
Email: integration@sofort.com

Business hours:
Monday to Thursday: 8:30 a.m. to 6:00 p.m.
Friday: 8:30 a.m. to 5:00 p.m.

8. Legal Notice

SOFORT GmbH
Theresienhöhe 12
80339 Munich
Germany

Support for customers
Phone: +49 (0)89 24 88 37 690

Support for merchants
Phone: +49 (0)89 24 88 37 692

info@sofort.com
www.sofort.com

Directors

Felix Würtenberger
Wilhelmus Geerling Klaassen

External Data Protection Officer
Mr. Michael Schramm, LL.M. 
For privacy questions please contact us at: datenschutz@sofort.com

Registered at the District Court Munich
HRB 218675
VAT-ID: DE248376956

© SOFORT GmbH. All rights reserved, including the translation.

The documentation including all published content is protected by copyright. Reprints or reproduction of any kind and processing, duplication, and distribution using electronic systems of any kind shall only be permitted with prior written consent of SOFORT GmbH.

The contents of this documentation and the implementation of the information contained therein may only be used at your own risk. SOFORT GmbH assumes no responsibility for the function of individual programmes or of parts of them. In particular, SOFORT GmbH assumes no responsibility for possible damages resulting from the use.