1Introduction

This manual leads you through the installation, configuration and usage of the payment module for xt:Commerce and Worldline SIPS.

Before beginning with the installation, please make sure that you are in possession of all necessary data:

• Access to your merchant account of Worldline SIPS (https://download.sips-services.com) - On this plattform you can download the access information.
• xt:Commerce payment module from sellxed.com/shop.
• Access to your server.

In case you don't yet have a contract with Worldline SIPS, we please ask you to contact their support.

Note that you must use at least PHP version 5.6 for our plugins. PHP 8 or higher is currently not supported.

1.1Process of the Installation

In this document you will find all important information for the installation of the module. It is important that you strictly follow the checklist. Only by doing so, can a secure usage in correspondence with all security regulations be guaranteed.

1. Configuration of the basic settings of the payment module
2. Configuration of the payment methods
3. Carrying out of a test purchase by means of the attached test data at the end of this document
4. If your test was successful, do not forget to switch the operating mode to live mode.

1.2System Requirements

• PHP Version: 5.4.x or higher
• OpenSSL: Current version with support for TLS 1.2 or higher.
• fsockopen: The PHP function fsockopen must be enabled. The plugin must be able to connect to external systems over the Internet.
• PHP Functions: All common PHP functions must be enabled.

2Configuration of the Payment Module and the Payment Methods

In order to configure and set up the main module in xt:Commerce please double check that you received the following information:

• Live Merchant ID
• Live Secret Key
• Live Secret Key Version

All this informations are provided in the Worldline SIPS merchant account. Click on the button located on the top right hand corner of the page called SECRET KEY.

Figure 2.1: Access to the secret keys.

Follow the instruction in the section main module to install and set the above retrieved credentials directly in your shop. If you want to have additional information regarding how to use the Extranet of Worldline SIPS we ask you kindly to directly call the customer support of Worldline SIPS.

3Payment Plans

You are able to split a payment at Worldline SIPS in order to charge the total amount to your clients in several steps. The remaining payments are directly charged to your customers by Worldline SIPS - You do not have to do anything yourself to debit their cards for later payments. By default your account is able to split payments in 2 or 3 payments. Please contact the support desk of Worldline SIPS, if you wish to setup more than 2 or 3 n-Payments and activate the feature in your account. You'll need to make sure to follow the following two steps in order to activate the payment plans in your shop.

• You need to activate the payment plans option within any payment method. This setting can be found in the settings of any payment method within your shop administration.
• In the setup file of Worldline SIPS within your shop, you will find the section 'Payment Plans' ('Paiement n-fois'). This is where you'll need to setup your payment plans.

Figure 3.1: A payment plan in the setup file of Worldline SIPS.

4Migrating from Version 1 to Version 2

Worldline SIPS will be deprecating Version 1 of it's API by end of year 2021. You can continue to use API Version 1 until this date but it is recommended to make the switch before then. In order to do this please contact your payment provider and ensure they have configured your merchantId to use Version 2 and set up a secret Key to your existing MerchantID.
Once this process is complete enter your new merchant details (as outlined above in the configuration section). Once you have done this ensure you have chosen "2" from the API version dropdown. If you have not chosen this configuration option you will receive the following error message:

Figure 4.1: The api version dropdown for Worldline SIPS.

5Module Installation and Update in the xt:Commerce Shop

5.1Installation

At this time you should already be in possession of the module. Should this not be the case, you can download the necessary files in your customer account in the sellxed shop (Menu "My Downloads Downloads"). In order to install the module in your shop, please carry out the following steps:

1. Download the plugin. The download can be found in your sellxed.com account under "My Downloads".
2. Unzip the archive you have just downloaded.
3. In the unzipped folder navigate to the folder "files"
4. For some shops there are different versions of the plugin provided. If this is the case open the folder which corresponds to your shop version.
5. Using your preferred FTP client upload entire content of this folder into the root directory of your shop. For some shops there is a specific folder containing the plugins. If that is the case upload the plugin into this folder. Make sure that the folders aren't replaced but merely merged.
6. If you haven't yet done so, log back into your shop.

5.2Updates and Upgrades

You have direct and unlimited access to updates and upgrades during the duration of your support contract. In order to receive constant information about available updates we ask you to subscribe to our RSS feed that we publish for your module.

More information regarding the subscription of this RSS feed can be found under: http://www.sellxed.com/en/updates_upgrades.

We only recommend an update if something doesn't work in your shop, if you want to use new feature or if there is a necessary security update.

5.2.1Update Checklist

We ask you to strictly comply with the checklist below when doing an update:

1. Always do a backup for your database and your files in your shop
2. Use always a test system to test the update process.
3. Wait until all the files are copied to the shop, clear the cache if there is one in your shop and then visit the configuration page of the main module so that the update process will be initialized.

Depending on the version it could be that the database has to be migrated. We recommend you therefore, to perform the updates in times when the shop is not visited too frequently by your customers.

5.2.2Update Instructions

Please always read the update instruction. Those instructions can be found in the changelog. If there are no special remarks, you can proceed by just overwriting the files in your system.

6Module Configuration in the xt:Commerce Shop

The configuration consists of two steps. The first step is the configuration of the main module with all the basic settings (cf. Configuration of the Main Module). During the second step you can then carry out individual configurations for each payment method . This allows for full flexibility and perfect adaptation to your processes.

6.1Base Module Configuration

The settings for the Base Module can be found in "Content > Plugin > deinstalled plugins > Worldline SIPS Base Module" . To install the module, click 'install'. A new window should open now. Next, cklick F5 in your browser in order to reload all Java Script data of the modules and then return to the location of the installed plugins.

The settings of the module can be opened by clicking on the pen. Enter the options that you set in the administration surface of Worldline SIPS. If an option is unclear, a click on the question mark will show more information. The central settings will be explained.

6.1.1Sending e-Mails for status updates

Mark every status that you want to trigger an e-Mail to the customer if his order was set to this status.

6.2Payment Method Configuration

After the Basic Module was configured successfully, the payment method settings for your shop can be found under Settings >. Every method is listed seperately. Activate the desired payment methods by selecting them and clicking Activate Selection.

With a click on the pen, a new window for the settings will open. Most settings are self-explanatory. A click on the question mark shows additional information.

6.2.1Choosing the Authorization Method

You can choose between several display options for the authorization of card payments. The option Authorization Method determines, which payment methods you would like to process.

For further information on the differen authorization methods, visit our sellxed Website.

6.2.2Payment Form Position

If you have the corresponding package of Worldline SIPS, the payment information can be entered directly in your shop. The setting Page for Payment Form adjusts the position of the payment form

6.2.3Capturing Orders Directly

The option "Capturing" determines wether payments should be captured directly or if they should be authorized before. If you only want to authorize as a first step, ensure that the payments are issued later.

Depending on your Acquiring Contract, a reservation is guaranteed for a limited time only. If you are not capturing within this time, the authorization might not be guaranteed. Further information on the process of capturing is provided below.

6.2.4Uncertain Status

You can mark orders without a 3D Secure Verification or other security mechanism failures. This allows you to examine the order manually before the shipment.

6.2.5Setting the Order Status

You can determine which status the order should have for every payment method. This refers to the initial order status.

6.3Direct Capturing of Transactions

The option "Capture" allows you to specify if you wish to debit payments directly or if you first wish to authorise them and then debit the payment at a later point.

Depending on your acquiring contract, a reservation is only guaranteed for a specific period of time. Should you fail to debit the payment within that period, the authorisation may therefore no longer be guaranteed. Further information on this process can be found below.

6.4Uncertain Status

You can specifically label orders for which the money is not guaranteed to be received. This allows you to manually control the order before shipment.

6.4.1Setting the order state

For each payment method you may select in which state the order should be set to depending on the booking state. This is the initial state of the order.

6.5Stock Management in xt:Commerce 4 / 5

Since the 19.05.2017 we changed the way we handle the stock implementation in xt:Commerce 4 / 5. Products will now automatically be restocked when the status of the order is changed to failed. The status of the order is automatically changed to failed if the customer does click on the cancel button on the payment page. However if he uses the back button in the browser we can not determine the status of the order. In this case you have to manually cancel the order to restock the items.

Please note the stock will automatically be increased if you switch an order into the failed state.

6.6Optional: Validation

Note: It can be that this option is not visible in your module. In this case just ignore this section.

With the option 'Validation' you can define the moment when the payment method should be made visible to the customer during the checkout process. This setting is relevant for modules where the usage depends on the customer's compliance with specific preconditions. For example, if a solvency check has to be carried out or if the payment method is only available in certain countries. In order for the credit check or address validation to also work with European characters, the charset of the "Blowfish mode" must be set to "UTF-8" for certain PSP settings.

You have the choice between these options:

• Validation before the selection of the payment method: A validation verification is carried out before the customer selects the payment method. If the customer does not fulfill the requirements, the payment method is not displayed
• Validation after selection of the payment method: The verification of the compliance occurs after the selection of the payment method and before the confirmation of the order
• During the authorisation: The validation verification is carried out by Worldline SIPS during the authorisation process. The payment method is displayed in any case

7Settings / Configuration of Payment Methods

7.1General Information About the Payment Methods

The plugin contains the most common payment methods. In case a desired payment method is not included per default, please contact us directly.

In order to be able to use a payment method, it must be activated in your account with Worldline SIPS as well as in your shop. Information about the configuration of the payment methods can be found further above.

Below you can find important information for specific payment methods that deviate from the standard process.

7.2Information on Payment Status

For each payment method you can define an initial payment status (status for authorized payments etc.). You hereby define the payment status for each state depending on the processing type of the order (captured, authorized, etc.). It's the initial status which the order assumes. Depending on the mutation carried out by you, the status can change.

7.2.1Order status "pending" / imminent payment (or similar)

Orders with the status 'pending Worldline SIPS' are pending orders. Orders are set to that status if a customer is redirected in order to pay but hasn't returned successfully or the feedback hasn't reached your shop yet (Customer closed window on the payment page and didn't complete payment). Depending on the payment method these orders will automatically be transformed into cancelled orders and the inventory will be cleared (so long as the Cronjob is activated). How long this takes depends on the characteristics of the payment method and cannot be configured.

If you have a lot of pending orders it usually means that the notifications from your webserver to Worldline SIPS are being blocked. In this case check the settings of your firewall and ask the Hoster to activate the IPs and User Agents of Worldline SIPS.

7.2.2Order status "cancelled"

Orders with the status "cancelled" have either been set to that status automatically due to a timeout, as described above, or have been cancelled directly by the customer.

8The Module in Action

Below you will find an overview of the most important features in the daily usage of the Worldline SIPS module.

Figure 8.1: Transaction Information.

8.1Order Transaction Information

In each order processed by our module, you can view all important information on the transaction. For instance, this feature allows you to match the orders to the transactions visible in the Worldline SIPS backend.

To view this information, open the orders. At the bottom of the order you will find the paragraph Worldline SIPS Transactions. This shows all details on all former actions related to this order. Click on the key in the column "Action" to see the transaction information (c.f. image "Transaction Information").

Figure 8.1: Transaction Overview

Figure 8.1: Transaction Information

8.2Transaction Table

In addition to information on the order, the transaction table shows information on the transactions in your shop. Among other things, it allows you to match the Worldline SIPS transaction number to the order in your shop.

Figure 8.1: Transaction Information.

8.2.1Refunding Orders

In order to issue a refund, open the transaction information (c.f. above). This shows all information on the transaction. With a click on "Refund", an input mask for credit notes will open. By clicking Refund , the refund request is transmitted to Worldline SIPS.

Figure 8.1: refund button

Executing a refund will not change the status of the order.

8.3Capturing / Cancelling Orders

8.3.1Capturing / Cancelling Orders

To capture orders, open the transaction information (c.f. above). This will show you all information on the transaction. With a click on "Capture" (top right), the order is forwarded to Worldline SIPS. You do not have to log in to the Worldline SIPS backend. You can enter the products you would like to capture in the input mask.

By clicking "Cancel" the transaction is cancelled and the reserved amount is cleared on the customer's card immediately.

Figure 8.1: Capturing Transactions

8.4Using the Alias Manager / Token Solution

The Alias Manager feature allows you to securely save your customers' credit card data at Worldline SIPS for future orders. You can enable this by activating the option "Alias Manager" in the configuration of the Payment Method. Now the customer can choose between already saved credit cards when ordering again, without having to enter all card information.

Figure 8.1: Alias Manager

8.5Setting up Cron Job

To activate the time-controlled plug-in functions (e.g. Update Service, deleting pendant orders, etc.), follow the Worldline SIPS instructions for the set up of Cron Job.

9Testing

Before switching from test to live mode it is important that you test the module extensively.

9.1Test Data

10Errors and their Solutions

You can find detailed information under http://www.sellxed.com/en/faq. Should you not be able to solve your problem with the provided information, please contact us directly under: http://www.sellxed.com/en/support

10.1The Referrer URL appears in my Analytics Tool

When a customer and the notification are redirected via Header Redirection, the Worldline SIPS Referrer URL might appear in your Analytics Tool thus hiding the original traffic source. However, most Analytic Tools are able to minimize this problem.

In case you are using Google Analytics as reporting tool, this step by step guide may help you to exclude the URLs: under bullet point 4.

11Error Logging

The module will log different unexpected errors or information depending on the configured level. If there is any issue with the module, this log can help identify the cause.

11.1Log Levels

You can configure the log level in the Worldline SIPS settings.

• Error: Logs unexpected errors only. (Default)
• Info: Logs extended information.
• Debug: Logs information helpful for debugging.

11.2Log Location

The log file is stored in the xt:Commerce log directory. Please make sure the path exists and it is writable by the webserver. (Default Path: {shopRootDirectory}/xtLogs/)

12Advanced Information

This section of the manual is for advanced usage of the module. The content is for advanced users with special requirements. Everything in this section is optional and not required for the daily usage of the module.

12.1Transaction Object

This section describes how to extract information from a transaction, if you need it for further processing. E.g. you require more information of the transaction for further processing an order in your ERP system.

The code snippets in this section assume your script resides in the root folder of the shop with the default shop folder structure.

$root_dir = dirname(__FILE__).'/';
define('_VALID_CALL','true');
define('_SRV_WEBROOT',$root_dir);

include _SRV_WEBROOT.'conf/debug.php';
include _SRV_WEBROOT.'conf/config.php';

include _SRV_WEBROOT.'conf/database.php';
include _SRV_WEBROOT.'conf/paths.php';
include _SRV_WEBROOT._SRV_WEB_FRAMEWORK.'function_handler.php';
include _SRV_WEBROOT._SRV_WEB_FRAMEWORK.'database_handler.php';

require_once 'plugins/worldlinesipscw/init.php';
require_once 'plugins/worldlinesipscw/lib/WorldlineSipsCw/Util.php';

$transactionById = WorldlineSipsCw_Entity_Util::loadTransaction($transactionId);
$transactionObject = $transactionById->getTransactionObject();