1Introduction

This manual explains the installation, configuration and usage of the payment module for JTL and Opayo.

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

• You should have received a vendor name, a user name as well as a password from Opayo for the live and test platform
• JTL payment module by sellxed.com/shop
• Access data to your server and shop

In case you don't yet have a contract with Opayo, you can gladly acquire it directly through us.

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

1.1Procedure 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 test administration interface of Opayo. You will find the test platform under https://test.sagepay.com/mysagepay/loginpage.msp
2. Configuration of the basic settings of the payment module
3. Configuration of the payment methods
4. Carrying out of a test purchase by means of the attached test data at the end of this document
5. If the test was successful, you can request the going live of your account by Opayo. With the obtained access data you can log into the live environment. The live environment can be found under the following URL: https://live.sagepay.com/mysagepay/loginpage.msp

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 Opayo - Backend

For the configuration log into Opayo in the Administration Tool (MySagePay):

• Test Environment: https://test.sagepay.com/mysagepay/loginpage.msp
• Live Environment: https://live.sagepay.com/mysagepay/loginpage.msp

The settings carried out on the following pages are a precondition for the later configuration of the main module.

2.1Valid IPs

In order for your shop to be able to access the payment page of SagePay, the IP of your server has to be saved as a valid IP with SagePay.

2.1.1Identify the IP Address of your Shop

In a first step you must find out the IP address of your shop. We display the IP on the about page of the plugin directly in your store.

Alternatively, request your IP directly with the host of your website.

Figure 2.1: You find your IP in the about section of the plugin (here a screenshot inside Magento).

2.1.2Entering the Valid IP

Click on add and enter the above identified IP address. Enter 255.255.255.000 for the subnet mask.

Figure 2.1: Adding an IP

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 > Opayo . By clicking on install, the plugin is installed in your shop. You can find the settings for the main module under Plugins > Opayo .

In order to configure the main module, go to Plugins > Opayo . Change to the tab Configurations. Enter the data and settings you have already saved in the back-office of Opayo. 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 Opayo. This means that when an item is sent or cancelled, you have the possibility of automatically also debiting the payment with Opayo. Further information can be found in the section The Module in Action.

4.2Configuration 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.2.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.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.

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

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

4.5Optional: 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 Opayo 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 Opayo 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 Opayo' 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 Opayo are being blocked. In this case check the settings of your firewall and ask the Hoster to activate the IPs and User Agents of Opayo.

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.

5.3Opayo Authorization methods

Payment Page (Server) and iFrame (Server with iFrame) are the authorization methods which do not require for your shop a PCI-certificate. Please check our product description page for a real time overview of the payment methods that support the specific authorization method you are interested in. If you are PCI-certified you can feel free to activate and configure the authorization method Server Authorization (Direct). This is an integration which requires a PCI certification. It is therefore crucial that you do not integrate this authorization method if you aren’t PCI-certified.

5.3.1Selection of the Authorisation Method - National Payment Methods

You have the choice between integration via InFrame or via Payment Page. In the case of national payment methods such as ELV, Sofortüberweisung, etc., you must use Payment Page as Authorisation Method.

5.3.2Fraud Recognition Rules

You have the possibility of filtering orders based on certain criteria and then have the order be labelled by the system. You can select a combination of rules which - if the criteria are fulfilled cumulatively - will lead to the order being moved into a pending status for manual verification.

Figure 5.1: Fraud Rules Configuration.

5.4Opayo PayPal

You have the possibility of processing PayPal via Opayo. In order to do so, the payment method must be activated in your account.

Please follow the instructions of the installation guides of Opayo in order to configure the module. You will find these in the administration interface (MySagePay) under the tab 'Payment Methods'.

6The Module in Action

Below you will find an overview of the most important features in the daily usage of the Opayo 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 Opayo.

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.2Usage of the Alias Managers / Token Solution

With the Alias Manager, your customers can securely save their credit cards with Opayo for later purchases. It is enabled by activating the option "Alias Manager" in the configuration of the Payment Method The customer can then choose from his or her saved credit cards without having to re-enter all the details.

Figure 6.1: Alias Manager Integration in JTL

6.3Transaction Management within the JTL Shop

The transaction management can be carried out from within the shop.

6.3.1Shipment

JTL does not support order status. The WAWI allows the processing of the order (e.g. shipments etc.)
The module does generate a payment receipt based on the transaction. The shipment should be created normally based on the payment receipt.

6.3.2Capturing of Orders

You can directly debit orders in the backend of your shop. In order to do so, switch to the tab Transactions. You can now search for the order number and then click on Show in order to find further information about the transaction. If you wish to capture an order, click 'capture'. Here you can modify the amount and the items. By clicking Capture, the action will be transmitted to Opayo.

In case you do not want to capture all items of the order, you can also close the transaction for further captures.

Figure 6.1: Capturing of Orders in JTL backend

6.3.3Cancel Orders

In order to cancel an order, open the corresponding transaction. By clicking Cancel , a cancellation of the payment occurs with Opayo. The reserved amount on the customer's card will be released automatically.

Figure 6.1: Cancelling of Orders in the JTL backend

6.4Refunds

You can also create refunds for already debited transactions and automatically transmit these to Opayo. 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 Opayo.

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.5Setting 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 >Opayo 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 Opayo 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 Opayo 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/sagepaycw/version/100/init.php';
require_once 'includes/plugins/sagepaycw/version/100/classes/SagePayCw/Entity/Transaction.php';

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