Retail:Ingenico TSI Payment Provider
This document describes the installation and configuration of the Openbravo payment integration with Ingenico Lane/7000 payment devices. This integration allows to automatically process payment transactions using the Ingenico Lane/7000 payment device. This integration takes advantage of the payment methods grouping by provider functionality that allows to use one single payment button in Web POS and select a different payment method depending on the type of card used in the payment transaction: DISCOVER, VISA, AMEX,...
The Web POS application communicates directly with the Lane/7000 device without any other piece of software or proxy in the middle to manage the communication. The communication protocol is WebSocket. WebSocket provides full-duplex communication channels over a single TCP connection. The WebSocket protocol was standardized by the IETF.
This architecture also allows to continue selling and processing payments even in offline mode, because is the Lane/7000 device who is in charge of the communication with the bank and this communication can be provided by a 4G mobile connection or using the Ingenico USB_PCL technolgy to proxy the network connection through the USB wire.
This is an overview of the architecture.
Installation and configuration
The Ingenico Lane/7000 must be loaded with the parameters file (PARAMS.PAR) including the MID and TID values provided by your bank and the correct URL for the service DwRegUrl1 and Dw1Url1. Then use the LLT tool to download the parameters file to the Lane/7000.
Once installed, it must be connected to the network. This device offers different network connections: WIFI, Ethernet and PCL over USB. To access the desktop, press ‘F’ on the device and go to the Admin Menu. The default admin password is 123456A + ENTER.
To activate PCL over USB, in the device in the option Admin Menu > iConnectWS > Mode Setup > Setup Server Mode. It will ask you to enable USB_PCL. Another way is to use a PBT file reference. This method is best for initial load configuration. Then in the windows machine the device is connected with USB install the PCL addon and start the PCL bridge. This utility bridges the USB to IP connection. To download the PCL addon for Windows use the link https://developer.ingenico.us/software-list/add-on-pcl-for-windows-v1-02-latest/
WebSockets is configured in the device desktop application wsConnect. Here you can see the current configuration in the option Admin Menu > iConnectWS > Current Setup, and change the configuration in n Admin Menu > iConnectWS > Mode Setup > Setup Server Mode.
For secure websockets it is needed to upload the certificates to the device using the LLT tool and the configuration file with the proper certificate file names.
Telium Local Loading Tool (LLT)
The payment application, parameters file and certificates are uploaded with the Ingenico LLT tool. The LLT tool can be downloaded from ingenico https://developer.ingenico.us/software-list/telium-local-loading-tool-llt-5-5-0/ and in the case of Windows, the USB drivers must be installed. These USB drivers can be downloaded from here. https://developer.ingenico.us/software-list/ingenico-usb-driver-3-14/
Once the LLT tool and drivers are installed, connect the Lane/7000 to the USB port, and reboot the device while pressing the "#" (hash) key. This makes the device enter in LLT mode. In LLT mode it will appear in the device screen an icon with a folder and an arrow.
Open the LLT took and the device will appear in the Plugged terminals window. Connect the terminal double clicking on it, browse to the file to import, use right click and the option Download to transfer the file to the device. After the download process finishes double click on the terminal to disconnect and reboot again the device.
iConnect WebSockets V1.0.5
You can test the device using the Ingenico iConnect WebSockets tool. https://developer.ingenico.us/software-list/iconnect-websockets-v1-5-0/ . With this test tool you can simulate sales, refunds, void transactions, … Uncompress the package and open the page located in tools/tsi/clients/tests/index.html select settings and configure the network address and port of the Lane/7000. For example it can be ws://188.8.131.52:50000.
Then select the action, amount and tender type and press Process. If everything is working properly, you will see in the device the payment request, and after the payment has been approved or rejected you will see in the test tool the result.
As System administrator you need first to install the module Ingenico TSI Payment Provider This module implements the integration. After the module is installed, you can rebuild the application and start the configuration. Follow the Modules_Management documentation for the details to install a new module.
To configure Openbravo to integrate Payments with the Ingenico Lane/7000 login in Openbravo as company administrator and follow these steps:
In the window Provider Group create a new record and select in the field Provider the value Ingenico TSI, in Name the label to display in the payment button, and in Tender Type, the type of tender to use for payments when using this Provider Group. The tender types supported by Ingenico are the following: All, Credit, Debit, Cash, EBT or Gift Card.
In order to test the Openbravo configuration and simulate payments, refunds and void transactions without having the Lane/7000 device you can use the provider Ingenico TSI Mock. The Ingenico TSI Mock will simulate a connection error if the amount is $100.00, a user cancellation if the amount is $101.00 and simulate an approval for any other amount.
Here you have an example of a Provider Group configuration using Ingenico TSI.
Then complete the payment methods configuration in the windows Channel - Touchpoint and Channel - Touchpoint Type linking in this last window the corresponding payment methods with the Provider Group created in the previous step and the Payment Method Type assigned to each payment method. For more information about how to configure payment methods using this Provider Group go to the guide http://wiki.openbravo.com/wiki/Retail:Payment_Methods_grouping_by_Provider_User_Guide
Finally in the window Channel - Touchpoint you must configure the WebSocket address for the device this terminal is connected in the field Ingenico Device URL, this URL is in the format <protocol>://<address>:<port> where <protocol> is ws for WebSockets or wss for secure WebSockets. For example: ws://192.168.1.36:50000.
Here you have an example:
To identify the address and port of the Lane/7000, in the device, select Admin Menu > iConnectWS > Current setup and you will see the current IP address and listening port.
Once everything is configured, the operation of the POS terminal is as usual. In the moment to process a payment transaction select the button with the Provider Group name configured and add the payment. In this case, a dialog will appear waiting for the Ingenico Lane/7000 to process the payment. And after the payment is completed the dialog will disappear and the payment line will appear in the Web POS application.
When closing the receipt, the receipt will be printed and a customer copy and merchant copy of the payment transaction will be printed too.
This integration also allows to process refunds and void transactions. Refunds works the same way as payments.
When adding payments to a refund, a dialog will appear waiting for the Ingenico Lane/7000 to process the payment and the refund with the payment details will be added after the Lane/7000 finishes to process the refund.
Void transaction is the action of voiding a payment that has just been processed when tapping on the remove icon that appears next to the payment recently added. In this case, a dialog will appear too and the payment will be removed after the payment has been successfully voided by the Lane/7000.
After closing a receipt paid with the Lane/7000 two copies will be printed with all the details of the transaction, the customer copy and the merchant copy.
This is a sample of one of the copies, the customer copy.