1Introduction

This manual describes the installation, configuration and usage of the payment module for JTL and 2Checkout.

Before beginning the installation, make sure to have all necessary data at hand. The data you will need is listed below and can be found at the respective tab in the 2Checkout backend( ):

• 2Checkout Seller-ID
• 2Checkout Publishable Key (Sandbox / Live)
• 2Checkout Private Key (Sandbox / Live)
• 2Checkout API Username (Sandbox / Live))
• 2Checkout API Password (Sandbox / Live))
• JTL Payment Module from sellxed.com/shop
• Access data to your server and shop

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

1.1Installation Process

This document contains all information you need to install te module. Please follow the described steps strictly when installing the module in order to ensure its safe usage in compliance with all security regulations.

1. Main Module Configuration
2. Configuration of accepted Payment Methods including the authorisation methods
3. Do not forget to enter the Notification URL
4. Conduct a test order
5. Set the Account 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.

22Checkout Backend Configuration

An overview of all transactions and settings can be found in the 2Checkout backend. This is also where the initial settings for the module activation are performed. These will be explained in the following section.

The backend can be accessed here:

2.1Main Module Configuration

You will find the Seller ID by clicking on your account on the top right..

Figure 2.1: The Seller ID is shown by clicking on the symbol

2.1.1Generating the Publishable Key and the Private Key

The Publishable and the Private Key can be generate under the tab API. Enter these keys into the corresponding fields in the Main Module of your shop.

2.1.2Generating the API User for the Transaction Management

If you wish to generate transactions from the JTL backend directly, you need to create an API User under Account > User Managmeent . It is important to set the access to API Access. Copy the access data into the respective field in the Main Module of your shop.

Figure 2.1: Generating an API User.

2.1.3Instant Notification Settings

Die Instant Notification Settings are only required, if you want to authorise payments through the Payment Page.

To set up theTransaction feedback response, enter the URLs which the main module generated for you. These URLs are displayed in the JTL module. Further information can be found in the section on Transaction Feedback.

The Instant Notification Settings can be found by clicking on the symbol at the top right. Enter the displayed URL into the Global Settings and activate the Notification URL for Order Created.

Figure 2.1: Instant Notification Settings.

2.2Payment Method Configuration

More information on how to set up the payment methods and the implementations of each settings can be found here.

2.3Testing

The Test Data for the test are attached at the end of this document.

2.4Switching from Sandbox to Live Mode

After all tests have been concluded successfully, request the activation of your account directly in the 2Checkout Backend. In order to do this, fill out the Account Activation Form. The link to the form can be found in the backend. Enter your new Passwords and Public Keys for the Live Environment into the Main Module. After activating your account, set the operation mode to Live. Now you can process payments.

3Module Installation and Update in the JTL 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 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.

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

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

4Module Configuration in the JTL 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.

4.1Configuration of the Main Module

In a first step the plugin must be installed. The installation of the plugin is carried out under: Plugins > Plugin administration > 2Checkout . By clicking on install, the plugin is installed in your shop. You can find the settings for the main module under Plugins > 2Checkout .

In order to configure the main module, go to Plugins > 2Checkout . Change to the tab Configurations. Enter the data and settings you have already saved in the back-office of 2Checkout. In case of questions, you can find further information by moving the cursor to the question mark.

In the tab Information you can find important information on the plugin such as the version number, release date and callback URL. This data is important when contacting our support.

You have the option of synchronising the order status with the transactions with 2Checkout. This means that when an item is sent or cancelled, you have the possibility of automatically also debiting the payment with 2Checkout. Further information can be found in the section The Module in Action.

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 2Checkout configuration. The URL to be entered can be found in your JTL Shop under: Plugins > Plugins > 2Checkout > Erweiterte Informationen

4.3Configuration of the Payment Module

After having successfully configured the main module, you can find the settings for the individual payment methods in your shop under Payment Processing > Payment Methods . Each payment method is listed individually. Install the payment methods you wish to offer you customers in your shop. You can carry out individual settings for each payment method and thereby optimally adapt the payment methods to your existing processes. The most central options are described in more detail further below.

In order for the payment method to be displayed in the shop, you must link them with a shipping method. Open the shipping methods under Payment Processing > Shipping Methods. By clicking edit, you can modify the shipping methods. Here you can link the payment methods you wish to offer and also have the option of setting individual payment fees.

4.3.1Configuration of payment methods in the WaWi

In order for the JTL WaWi to map the payment methods from the shop, make sure that you add them inside the WaWi Einstellungen > Zahlungsarten verwalten). Make sure that they are spelled exactly as written in the colum "Anmerkung".

4.4Direct 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.

4.5Uncertain 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.

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

4.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 2Checkout during the authorisation process. The payment method is displayed in any case

5Settings / Configuration of Payment Methods

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

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

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

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 of the most important features in the daily usage of the 2Checkout module.

6.1Useful Transaction Information on the Order

You can find an overview of the transaction information in within the order detail view. Among others, this information allows for the definite attribution of the orders to their corresponding transaction, seen in the backend of 2Checkout.

Figure 6.1: Transaction Information in the JTL backend

The payment information is also transmitted to your JTL WaWi Client.

Figure 6.1: Transaction Information in JTL WaWi

6.2Refunds

You can also create refunds for already debited transactions and automatically transmit these to 2Checkout. In order to do so, open the invoice of the already debited order (as described above). By clicking on Refund a dialog box for refunds will open up. Insert the amount you wish to refund and then click on Refund. The transaction will now be transmitted to 2Checkout.

Figure 6.1: Refunds Directly from Within the JTL backend

Please note that you can't refund more than 100% of the originally authorised amount.

Executing a refund will not affect the order.

6.3Setting up Cron Job

In order to activate the time-controlled functions of the plugin (such as update service, deleting pending orders, etc.) set up a time-controlled request in your hosting on the URL, which you will find via Plugins > Plugins >2Checkout in the tab "Extended Information". Invoking it regularly will trigger the actions.

Here we suggest you use a Cron Engine like for example EasyCron. This allows you to open the file ( URL ) with an external service.

7Testing

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

7.1Test Data

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 name of the payment method is not shown correctly in the email.

Depending on the name of the payment method and due to the naming convention, the name of the payment method in the email can be slightly strange. You can avoid this by adapting the email template. Go to Content > Email Templates.

In the order email you can replace the following '{$Bestellung->cZahlungsartName}' with '{$Bestellung->Zahlungsart->caption}'. From then on, the name you set in the payment configuration will be shown.

8.2The Referrer URL appears in my Analytics Tool

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

9Compatibility with Third-Party Plugins

The plugins listed below are compatible with our payment modules and allow you to handle certain tasks in an easier way.

9.1Birthday and gender in JTL

For certain payment service providers it is necessary to check the birthday and the gender of a customer. JTL does not check this by default. These checks can be enabled under "Einstellungen > Kunden / Formulare > Anrede abfragen" and "Einstellungen > Kunden / Formulare > Anrede abfragen" respectively.

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

10.1Log Levels

You can configure the log level in the 2Checkout settings. The logs are stored according to this setting and are not affected by the shopwide log level settings.

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

10.2Log Location

The log messages are visible in the JTL backend under the menu item Admin > Systemlog.

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

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

require_once("includes/globalinclude.php");

require_once 'includes/plugins/tocheckoutcw/version/100/init.php';
require_once 'includes/plugins/tocheckoutcw/version/100/classes/ToCheckoutCw/Entity/Transaction.php';

$transactionById = ToCheckoutCw_Entity_Transaction::loadById($transactionId);
$transactionObject = $transactionById->getTransactionObject();