Merchant Login
...

xt:Commerce 4

Integration manual
Sofort

PDF Download

1. Introduction to SOFORT Paycode

The SOFORT Paycode function allows you to generate a 10 digit code which the customer can use to make a payment by SOFORT at a later point of time within the period of validity.

A SOFORT transaction with a paycode consists of the following steps:

  1. Generate a paycode. You can either generate a paycode in your merchant menu of SOFORT or via the HTTP-XML interface. (See Section 2: Item Paycode in the merchant menu of SOFORT or Section 3: Paycode generation via HTTP-XML interface)
  2. Share paycode with your customer.
  3. Your customer can enter the paycode at https://www.sofort.com/paycode/ to carry out the payment.
  4. Depending on the project configuration, you will either receive a notification or you can see in the merchant menu that the transfer has been listed in your customer's online banking.

2. Integration steps

The following steps are required to integrate  SOFORT Banking Paycode in xt:Commerce 4 SOFORT Banking Paycode :

  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 Banking Paycode  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  SOFORT Banking Paycode 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  SOFORT Banking Paycode here by enabling the checkbox.

  • Validity (default value): Here you can enter the default duration a Paycode is valid (from the time it was created)
  • Test mode: By activating this option, you can test SOFORT Banking Paycode . 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

It is recommended to make a backup copy of your shop and database before you make any changes in your shop system.

4.1. Interface download

In order to use xt:Commerce 4 in your shop system, you first have to download the SOFORT module for xt:Commerce 4 :

http://addons.xt-commerce.com/index.php?page=product&info=5013

Extract the file to your local hard drive (e.g. by 7-Zip or WinRAR).

4.2. SOFORT module upload to xt:Commerce 4

Copy the content of the folder "xt_sofortueberweisung_paycode" to the web server running your shop by means of an FTP program (e.g. FileZilla).

Navigate in the FTP program to the base directory of your xt:Commerce 4 -Shop until you see the directory "plugins". Copy the whole directory "xt_sofortueberweisung_paycode" to this "plugins" directory including the content.

5. Module configuration

Go to the backend of your xt:Commerce 4 -Shop and navigate to "Plugins > plugins uninstalled" in the module class "core". Install the plugin and navigate afterward to "Plugins > plugins installed", find the module named "SOFORT Überweisung Paycode" and configure it. Please enter there the necessary data like customer id, project id, and API Key.

Afterward, can activate the SOFORT Paycode in the settings of each payment method listed under "configuration > method of payment" by setting "Sent Paycode" to "yes"

5.1. Integration into the Mail-Templates

The Paycode will be shown in the Checkout-Success-Page of the shop when it is activated for a payment method.

In order to integrate the Paycode-Block into the order confirmation, E-Mail navigates to "content > e-mail manager > send_order" and add the variable "($paycode)" into the desired place in the HTML-Template. In the Text-Template use the variable "($paycode_txt)". Repeat this for all languages your shop supports.

When you are using the PDF-Invoice module, the variable ""{$data.invoice.paycode}" has to be added to the corresponding template. It is recommended to add this code:

<div class="data" style="font-family: Helvetica; font-size: 10px;">
{$data.invoice.paycode}
</div><div style="clear: both;"></div>

below the following lines:

</div>
<!------------------------------------------------- END COMMENTS
------------------------------------------------->
<div style="clear: both;"></div>

6. Testing

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

  1. Activate the test mode in the desired project in the SOFORT merchant area.
  2. Create a Paycode in your shop/system
  3. Click on the Paycode-Link or open https://www.sofort.com/paycode and enter the generated Test-Paycode.
  4. Check if the payment details are displayed correctly on the payment form
  5. 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 choosen 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)
  6. Please check if the redirect works properly:
    1. Redirect after successful payment to success page?
    2. All notifications are sent properly?
    3. Order in your shopsystem is created correctly and status is updated accordingly?

Note: After successfully testing SOFORT Banking Paycode 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.