1Introduction

This manual explains the installation, configuration and usage of the payment module for JTL and First Cash Solution.

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

• You should have received a Merchant ID from First Cash Solution for the test account. Furthermore, you have received the corresponding user name and password
• Encryption password and HMAC-Key
• An Analytics Password which you require for logging into First Cash Solution Analytics
• JTL payment module by sellxed.com/shop
• Access data to your server and shop

In case you don't yet have a contract with First Cash Solution, 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.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. Basic configuration of the server including the setting up of the notify script
2. Configuration of the basic settings of the payment module
3. Configuration of the payment methods
4. Carrying out of a test purchase with the attached test data at the end of this document
5. If the test was successful, your account can be activated

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 Server

In order to perform the configuration of the main module of JTL, the following information is necessary. You should have received the information from First Cash Solution.

• First Cash Solution Live Merchant ID
• First Cash Solution Live Encryption Key
• First Cash Solution Live Signature Passphrase

Enter the credentials directly inside the configuration of the main module. After you performed some test payments, you can switch between Live Mode and Test Mode.

2.1Configuration of the Payment Module

For the usage of the gateway in your shop, fill in all received access data at its corresponding place in the main module and in the payment methods.

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

In order to configure the main module, go to Plugins > First Cash Solution . Change to the tab Configurations. Enter the data and settings you have already saved in the back-office of First Cash Solution. 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 First Cash Solution. This means that when an item is sent or cancelled, you have the possibility of automatically also debiting the payment with First Cash Solution. 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 First Cash Solution 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 First Cash Solution 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 First Cash Solution' 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 First Cash Solution are being blocked. In this case check the settings of your firewall and ask the Hoster to activate the IPs and User Agents of First Cash Solution.

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

The modules differentiate between the standard and the professional version. In the professional version, all payment methods available for First Cash Solution are integrated. With the standard version, however, you only receive the most common payment methods. Should a desired payment method not be available, please contact us directly.

5.4MasterPass Integration: What to keep in mind

If you integrate MasterPass as a payment method in your shop, you have two integration options: External and Standard Checkout. When using External Checkout, the customer does not have to provide address data during checkout. The customer only needs a MasterPass account and the data will be transmitted by MasterPass. In order to use this option as a merchant, you have to activate this payment method with First Cash Solution.

Please keep in mind, that using additional functions such as address transmission through MasterPass, may require the activation of the respective options through First Cash Solution aktiviert.

In order to use MasterPass in compliance with the MasterCard guidelines, please read the following information carefully before using this payment method.

5.4.1Integration Possibilities for MasterPass

MasterPass can be integrated as a normal payment method with redirection to First Cash Solution or as an external checkout.

5.4.1.1MasterPass as a Payment Method

If you like to integrate MasterPass as a normal payment method, activate the payment method as usual (seeConfiguration of the payment method). In this scenario the customer will first be redirected to MasterPass and then to the wallet of the issuer.

5.4.1.2MasterPass as External Checkout

If you integrate MasterPass as an external Chekout, you can minimize the steps towards the payment radically. The adress transfer and the creation of the account is processed via MasterPass. If you activate the external checkout, there appears a button in the basket with which you can jump after the login directly to the last step of the order confirmation. The creation of the account happens in the background.

For the activation of the external checkout go to Plugins > Plugins > First Cash Solution > Erweiterte Informationen . There you'll find all settings for the external checkout:

Figure 5.1: Activation of the external checkout.

MasterPass as external checkout is not for all cases available. If this point in the manual doesn't appear, please make sure to contact us.

5.4.2Checkout: MasterPass Learn More Button

When using MasterPass as a payment method for standard checkout, it is mandatory to link to the MasterPass Learn More Page. In order to do this, navigate to Payment Method Configuration. Paste the link for the Learn More Page into the field 'Description' for the respective languages. The field 'Learn More' will now be displayed when choosing a payment method.

We have already collected the most important links for you. You only have to copy and paste the links into the description field:

• German:<a href="https://www.mastercard.com/mc_us/wallet/learnmore/de/DE/" target="_blank">Mehr Erfahren </a>
• French:<a href="https://www.mastercard.com/mc_us/wallet/learnmore/fr/FR/" target="_blank">apprendre plus </a>
• English: <a href="https://www.mastercard.com/mc_us/wallet/learnmore/en/DE/" target="_blank">Learn More </a>
• Spanish:<a href="https://www.mastercard.com/mc_us/wallet/learnmore/en/ES/" target="_blank">aprender más </a>
• Italian:<a href="https://www.mastercard.com/mc_us/wallet/learnmore/it/IT/" target="_blank">saperne di più </a>
• Dutch:<a href="https://www.mastercard.com/mc_us/wallet/learnmore/nl/NL/" target="_blank">Leer Meer </a>

Figure 5.1: Example for entering a description (Magento). These settings are to be found in the payment method configuration for MasterPass.

Figure 5.1: The Learn More Page link should appear in the frontend.

Links for additional languages can be found in this document: https://developer.mastercard.com/...

5.4.3Additional information

General and additional information on using the MasterPass trademark and logo in your webshop are available in the official MasterPass Mechant Branding Requirement Document. which you can access here: https://developer.mastercard.com/...

6The Module in Action

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

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.2Using Invoice Details of a Processor

In the following context you can view or embed the "payment details" of for example an "Open Invoice" transaction:

6.2.1JTL Order Confirmation (E-Mail)

Please add the following code block into your JTL email template, if you want to send the payment details of the processor in the mail confirmation sent to the customer:

1. HTML Mailtemplate

   {if !empty($Bestellung->cwPaymentInformation)} {$Bestellung->cwPaymentInformation} {/if}

2. PLAIN Mailtemplate

   {if !empty($Bestellung->cwPaymentInformation)} {$Bestellung->cwPaymentInformation|replace:"\n"|strip_tags:false} {/if}

6.2.2JTL Invoice (PDF)

Due to technical limitations, it is currently not possible to display the "payment information" here.

6.2.3JTL-Backend (Transaction details)

You can view the transaction details in JTL under Plugins > Plugins > First Cash Solution > Transactions.

6.2.4JTL Success-Page

Due to technical limitations, it is currently not possible to display the "payment information" here.

6.3Usage of the Alias Managers / Token Solution

With the Alias Manager, your customers can securely save their credit cards with First Cash Solution 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.4Transaction Management within the JTL Shop

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

6.4.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.4.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 First Cash Solution.

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

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

Figure 6.1: Cancelling of Orders in the JTL backend

6.5Refunds

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

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.6Setting 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 >First Cash Solution 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

7.2Testing - First Cash Solution Simulation Mode

Any kind of payment method can be tested with our modules. The "Operation Mode" corresponds to the simulation mode with First Cash Solution. Payments with a total of less than 10'000 EUR are always accepted.

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 First Cash Solution 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 First Cash Solution 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/fcsolutioncw/version/100/init.php';
require_once 'includes/plugins/fcsolutioncw/version/100/classes/FCSolutionCw/Entity/Transaction.php';

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