1Introduction

This manual describes how to install, configure and use the payment module for xt:Commerce 4 and Innocard.

Before getting started with the Installation make sure to have all necessary data at hand:

  • Innocard Shop ID
  • Innocard Test and Live Certificate
  • xt:Commerce 4 Payment module from sellxed.com/shop
  • Login data for your server and shop

1.1Installation Process

This document contains all information necessary to install the module. When installing the module, strictly follow the instructions. This ensures the safe use of the module in compliance with all security regulations.

  1. Entering the Main Configuration into the main module
  2. Configuration of the payment methods
  3. Conducting a test order with the Test Data provided at the end of this document
  4. Creating the production certificate in the Innocard-backend.
Installation Service

Our payment plugins should have per default the correct settings for most of our customers' preferences. That means once you have entered the required credentials in the plugin configuration to connect your account to your website, the plugin should be fully operational. Should you be willing to receive detailed informations on a setting you do not know, you may contact our support team who will be able to assist you further.

Our support team is at your disposal during regular business hours at: http://www.sellxed.com/support. Furthermore, you have the option of ordering our installation service. We will make sure the plugin is installed correctly in your shop: http://www.sellxed.com/shop/de/integration-und-installation.html

.htaccess Directory Protection

In order to test the module, any kind of directory protection or IP blocking on your server must be deactivated. This is crucial; otherwise the payment feedback of Innocard might not get through to the shop.

2Configuration

2.1Main Configuration

For the module configuration, go to the setting page in the Main Module of your shop and enter the following data for the Live Tests in the corresponding fields.

2.1.1Settings > Shops > Your Shop (Innocard Backend)

All information necessary for the installation can be found in the Innocard Backend ( https://secure.innopay.ch/vads-merchant/) under Settings > Shops. Here you can select the shop you want to install.

Transfer the data into the Main Module:

  • Shop ID
  • Test certificate
Figure 2.1: Payzen Settings

2.1.2Production Certificate

As soon as the test payments were successful, set the Operation Mode to Live and request the activation of your account with Innocard. After the activation you can enter the Certification Key under Settings > Shops > in the main module.

2.1.3Payment Notifcation

For the Instant Payment Notification please enter the URL that is generated in the main module in the backend of Innocard. More information can be found under the section Transaction Feedback Enter the notification URL in the backend of Innocard under Settings > Notification Rules > 'IPN bei Erstellung einer Rate' into both TEST and LIVE fields and check 'Automatic Retry in case of failure'.

Figure 2.1: Entering the Notification URL

2.2Payment Method Configuration

All other setting options in the main module are not relevant for the product Checkout Page and can be ignored. The next step is the payment method configuration.

2.3Testing

The credit card data for the testing is shown on the Payment Page. By clicking on it the card number is transferred to the mask.

3Module Installation and Update in the xt:Commerce 4 Shop

3.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 download 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 shops 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 thats 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.

3.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.

3.2.1Update Checklist

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

  1. Always do a back up 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.
Do not do updates directly in the live environment

Please test the update procedure first in your test shop. Our support team is able and willing to help you if you experience problems with the update process. However, if you decide to perform the update directly in your live shop there is the possibility of a downtime of the shop of more than two days depending on the availability of our support if you do not want to book our complementary support.

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

3.2.2Update Instructions

Please always read the update instruction. They can be found on the plugin page in the shop under the section change log on the lower end of the page. If there are no special remarks, you can proceed by just overwriting the files in your system

4Module Configuration in the xt:Commerce 4 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.

Create back-ups!

Please create a back-up of the main directory of your shop. In case of problems you will then always be able to return your shop to its original state.

We furthermore recommend testing the integration on a test system. Complications may arise with third party modules installed by you. In case of questions, our support is gladly at your disposal.

4.1Base Module Configuration

The settings for the Base Module can be found in "Content > Plugin > deinstalled plugins > Innocard 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 Innocard. If an option is unclear, a click on the question mark will show more information. The central settings will be explained.

4.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.

4.1.2Capture Delay

You have the option to set a Capture Delay with the configuration. The Capture Delay defines, how many days after the authorization the transaction should be captured. We recommend to leave the number at 0 (standard setting).

In case you want to 0 we strongly recommend setting up a Cron Job so you can stay informed about the transaction status at all times.

In any case, it is helpful to set up the Cron Job to be informed about the Capture Status of the transaction. Instructions on how to set up a Cron Job can be found in this manual under Cron Job.

4.2Defining the URL for the Transaction Feedback

To ensure correct payment processing in your shop, at least one Feedback URL has to be provided in the Innocard configuration. The URL to be entered can be found in your xt:Commerce 4 Shop under the menu item Settings > Innocard > Setup .

4.3Payment 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.

4.3.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.

4.3.2Payment Form Position

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

Payment Processing

Please bear in mind that additional options with Innocard have to be enabled in order to use some of the payment processing methods.

Some authorization methods might not be available for every payment method.

4.3.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.

Varying Settings between Innocard - backend and module

The settings in the payment method module might overwrite your settings in the Innocard backend.

4.3.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.

4.3.5Setting the Order Status

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

4.4Shop ID

In the case of a multi-store set up (cf. chapter: Multi-Store), the parameter Shop ID identifies the shop's request and, therefore, redirects the feedback of Innocard based on the shop ID.

4.5Order Prefix

With the option order prefix you can define your own order scheme for the transmission to Innocard. This option helps you identify to which shop a transaction the back-end of Innocard is related to. The tag "{id}" will automatically be replaced be the consecutive order number.

4.6Selecting the Authorisation Method

You can choose between two options of authorizing credit card payments. By selecting one of the two under the option 'Authorisation Methods', you define how you want to process the individual payment methods.

Further information on the various authorisation methods can be found on our sellxed website.

Payment Processing

Please pay attention to the fact that you require the activation of further options with Innocard in order to use some of the authorisation methods.

It may be that certain authorization methods are not available for every payment method.

Alongside the introduction of PCI 3 there are additional certification requirements in case you are using the authorization method Hidden or AJAX. Please contact Innocard for further information or switch to another authorization method.

4.7Direct 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 the debit the payment at a later point.

Depending on your acquiring contract, a reservation is only guaranteed for a specific amount 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.

Different settings between Innocard and the module

It may be that settings saved in the payment modules overwrite settings saved in Innocard.

4.8Uncertain Status Status

You can specifically label orders for which for example no 3D-Secure verification nor any other security mechanism was carried out. This allows you to manually control the order before shipment.

4.9Stock 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.

4.10Optional: 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. 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 he or she 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 Innocard during the authorisation process. The payment method is displayed in any case

4.11Multi-Shop Set-Up

The payment module is designed for the usage of one Innocard contract for several shops. It must be differentiated, however, between the case of an integrated multi-shop functionality and independent shops:

Figure 4.1: Multi-shop set-up
Licensing

In the case of independent shops, you require a payment module license for each shop. For scale prices, please contact us directly.

5Settings / Configuration of Payment Methods

5.1General Information About the Payment Methods

All sellxed payment modules are delivered with 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 Innocard 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.

5.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.

Important info regarding Order Status

Never set the status to Pending Innocard or any similar pending status which is implemented by the module.

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

Orders with the status 'pending Innocard' 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 Innocard are being blocked. In this case check the settings of your firewall and ask the Hoster to activate the IPs and User Agents of Innocard.

5.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.

6The Module in Action

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

Figure 6.1: Transaction Information.

6.1Order Transaction Information

In each order processed by a sellxed 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 Innocard backend.

To view this information, open the orders. At the bottom of the order you will find the paragraph Innocard 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 6.1: Transaction Overview
Figure 6.1: Transaction Information

6.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 Innocard transaction number to the order in your shop.

Figure 6.1: Transaction Information.

6.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 Innocard.

Figure 6.1: refund button

6.3Capturing / Cancelling Orders

Please note:

The transaction management between Innocard and your shop is not synchronised. When you register payments with Innocard, the status in the shop is not adjusted and the order cannot be captured in the shop again.

6.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 Innocard. You do not have to log in to the Innocard 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 6.1: Capturing Transactions

6.4Using the Alias Manager / Token Solution

The Alias Manager feature allows you to securely save your customers' credit card data at Innocard 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 6.1: Alias Manager
Please remember:

It is necessary to enable the respective option with Innocard to use the Alias Manager. To do this, please contact the support team.

6.5Setting up Cron Job

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

7Testing

Before switching from test to live mode it is important that you test the module extensively. You can find all relevant test credit card data under: http://www.sellxed.com/de/testen.

Testing

Do not forget to switch the operating mode from test to live after having successfully tested the module.

7.1Test Data

In the following section you can find the test data for the various payment methods:
Credit Card
Card number
4917610000000000
Expiry Date
12/2021
CVC
123
Visa
Card number
4970100000000000
Expiry Date
12/2021
CVC
111
Card number
4970100000000001
Expiry Date
12/2021
CVC
111
Card number
4970100000000009
Expiry Date
12/2021
CVC
111
MasterCard
Card number
5970100300000000
Expiry Date
12/2021
CVC
111
Card number
5970100300000001
Expiry Date
12/2021
CVC
111
Card number
5970100300000009
Expiry Date
12/2021
CVC
111
American Express
Card number
378282246310005
Expiry Date
12/2020
CVC
123

8Errors 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

8.1The Referrer URL appears in my Analytics Tool

When a customer and the notification are redirected via Header Redirection, the Innocard 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.

9Error 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.

9.1Log Levels

You can configure the log level in the Innocard settings.

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

9.2Log Location

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

10Advanced 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.

10.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.

Have xt:Commerce 4 initialized in your script, this is required for the database connection.
$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';
Include the module main file and module classes.
require_once 'plugins/innocardcw/init.php';
require_once 'plugins/innocardcw/lib/InnocardCw/Util.php';
Now you can load the transaction and then extract the transactionObject.
Load the transaction by Id:
$transactionById = InnocardCw_Entity_Util::loadTransaction($transactionId);
$transactionObject = $transactionById->getTransactionObject();