Table of Contents
Added the sections in Blue giving detail on how on the Phase 2, Phase 3 of the implementation
Added Sign off Procedure in Appendix A and in the Indigo Implementation Process
Added Merchant Environment Requirement on 8. Sign off Procedure
Added the Ingenico IPP350 - Page 10
Re-arranged the order in the following topics:
Sign off procedure, Appendix A & Indigo Implementation Process
Removed IP Class and some level of detail in Phase 3
Re-arranged Sign Off section and included transaction types definition
Additional details or options included on the merchant environment within the sign off section in p.13
This document seeks to define what Indigo integrated is, the parties involved and the implementation process needed in order successfully deploy the Indigo Integrated solution to a production environment
What is Indigo integrated?
Indigo is a solution designed for merchants that have a dedicated till software/ line of business system and whose environment processes multi lane transactions. This document seeks to outline a broad set of requirements which must be met in order to fully implement and run the Indigo integrated solution.
This section covers all the potential prerequisites which should be met before integration is started. The specifics on the agreements that should be in place may vary depending on the parties involved these can be looked at on a case by case bases. Generally these entail the following:
- Merchant should have an agreement with an Acquiring bank
- Merchant number should be shared with iVeri Support
- Where applicable an NDA between the integrator and iVeri must be signed
- Where applicable, costs associated with implementing the solution should be agreed
- Merchant must have a till software system or Line of Business system
- Where applicable relevant agreements between iVeri, an Acquiring bank and or Integrator/Line of Business should be agreed upon.
- Where applicable a network diagram of the merchants store in which Indigo is to be deployed should be supplied to iVeri
2.2 Software Requirements
- POS Till software/Line of Business system
- A dedicated channel i.e. Generic Pos Channel needs to be in place
- Indigo software has to be installed into an Indigo server
2.3 Hardware Requirements
This section contains the overall hardware generally used in Indigo Integrated. The hardware required is dependent on the Acquirer and merchant. To get the appropriate hardware, please contact your account relationship manager
- Depending on region and acquiring bank a Muira 010 or an Ingenico device will be used
- Terminal stands
- Windows server| Ubuntu| or Raspberry Pi 3 with 32G SD Card - HW specs provided by iVeri
- WIFI or Ethernet connections – dependent on the device used by an acquirer
2.3.1 WIFI Specifications
The WIFI specifications are device dependent, these are only applicable to the Muira 010. The following minimum specifications should be tested per terminal onsite.
- WIFI strength should at least be around -60 DB
- There shouldn’t be any dropped packets whilst testing the connection
- Latency should be at an average of 50 milliseconds
3. Parties involved in Indigo Integrated
There are 6 role players in this solution, each has its own distinct role to play.
- Acquiring Bank
- Line of Business Supplier
- Network Manager
- iVeri Payment Technologies
3.1 Acquiring Bank
- The acquiring bank will be responsible for holding the merchant agreement
- Capture the merchant for Indigo and share the merchant number with iVeri Support team
- The Acquiring Bank will need to order and supply the terminals to the merchant
- Key injection process into the device will be the responsibility of the acquiring bank
- Where applicable the acquirer needs to order PI 3, SD cards and terminal stands – varies from acquirer to acquirer
- The shop/store should have a WIFI/LAN connection and or form of connectivity redundancy for back up purposes.
- The merchant should have an individual who looks after their WIFI/LAN network connection.
- An agreement should exist between the merchant and acquiring bank
- Merchant must have a Till software/Line of business in which indigo will be integrated to
- Merchant MUST an ensure that the Indigo PI or Server is in a restricted area
- The merchant can allocate resource to integrate, manage and run the Indigo solution in-house or management of the solution can lie in the Integrators domain. The differences vary from merchant to merchant
3.3 Line of Business Supplier
The Line of business is a sophisticated piece of software that allows retailers or hotels to consolidate, centralize and automate all functions pertaining to their day to day business operations. These involve tracking sales, track item movement, manage inventory, CRM, reporting and analytics etc. Some of these systems are industry specific, whereas some cover a wide spectrum.
Merchants who operate in the multi-lane space usually have a direct relationship with the supplier of the Till system, Indigo is designed for merchants that operate or use such systems.
3.3.1 Line of Business Implementation Scenarios
There are instance in which the supplier is in full control of integrating to Indigo and deploy the solution to the merchant. But there are cases where the supplier only carries out the integration and have integrators or 3rd parties deploy the solution.
An Integrator is the 3rd party who has a contractual agreement with the Line of Business supplier to distribute, integrate and deploy the Line of business to merchants. In some cases though, integrators are only responsible for deploying the solution.
3.4.1 Overall Duties
- Integrate Indigo into the Till software/Line of business, specification guide to be provided by iVeri.
- Perform test transactions/scenarios to iVeri’s test environment
- Deploying the solution to the merchant’s store
- Once deployed to the store the Indigo Pi or machine MUST be in a UPS
- Provide outbound access as specified in 4.2 Phase 2
- Check that the WIFI network can communicate with Indigo machine
- 1st Line of support is the responsibility of the Integrator
- It is required that the Indigo PI or machine is in a UPS
3.5 Network Manager
- A Network manager can be a person employed in-house by the merchant or a 3rd party.
- This individual will be responsible for setting up, configuring and testing the WIFI as per the specification.
- The Network Manager will work closely with the Integrator/Line of business supplier to ascertain that the WIFI connection can communicate with the Indigo Host
3.6 iVeri Payment Technologies
- iVeri Payment Technologies will be responsible for licencing Indigo integrated to an Acquiring Bank
- Developing a dedicated channel to be used as a bridge between the POS Till/Line of Business and Indigo for sending/receiving transaction messages.
- Where applicable iVeri will deliver the relevant hardware to the Acquirer
- Creating the integrator into iVeri’s ticketing system (Assist)
- Create the Integrator as a user in the Gateway, making it easy to view logs and troubleshoot issues.
- iVeri support will be responsible for 2nd Line support.
- iVeri will provide training to the Acquirer and Line of Business Supplier/ Integrator
4. Installation & Configuration Requirements
This section will detail preparatory work which should be performed before the solution is piloted.
*This phase should be arranged, confirmed & scheduled with IVeri in advance so as delays may be averted
4.1 Phase 1
This phase must executed by an iVeri member and is subjected to an installation or deployment date confirmed and agreed by all parties involved. This step allows for the Indigo software to be installed on the SD card to be used on the Raspberry PI, the Installation process that relates to a VM or physical Windows/Linux is not covered in this document.
- Compile a Master File containing a standard indigo installation, containing but not limited to the following
- Postgres as stated to the Hardware requirements
- Java 8 or later
- OS as stated on Hardware requirements
- Dump the Master File into the SD card
4.2 Phase 2
This section assumes that the integrator/Line of Business Supplier has the hardware from the Acquirer and is ready to install at the merchant’s store or simulated environment. This phase usually involves a collaboration between the Network Manager, the merchant & Integrator/Line of business.
4.2.1 Installing necessary hardware in-store
- The Integrator/Line of Business supplier will need to install the necessary hardware in the merchant’s store.
4.2.2 Set up the environment configurations
- Firewall rules to protect the Indigo server environment
- Assign permissions for the Indigo server to download updates
4.2.3 Outbound Access
Allow outbound access to the remote machine responsible for backing up Indigo
Indigorsync.iveri.com on Port 22
Whitelist the Gateway and Port to which Indigo will be sending transactions to.
- Portal.nedsecure.co.za on Port 443
- Portal.host.iveri.com on Port 22
Note: Check with iVeri for the appropriate one to use
- Allow SSH forward which will give access to the Indigo server
- Whitelist DynDNS domain: host.dyndns-remote.com on Port 80/443
- Access to the Indigo server, credentials should be communicated to iVeri Support
4.2.4 Ports and IP address
- The integrator has to supply iVeri with an IP address, gateway address and subnet Mask
- Supply to iVeri the Port to which the integrator will be listening on
- Test that Indigo is searchable within the network
- Test the WIFI connection between the devices and the Indigo host
4.3 Phase 3
When the integrator/merchant has completed phase 2, iVeri should be contacted so as merchant specific configurations should be performed. The following are some of the items which iVeri has to action.
4.3.1 Channels/Services for Indigo
- All the necessary channels/ services required in Indigo should be started and enabled
- Configure all the Ports in which the services/channels are listening on
4.3.2 Configure Indigo to use the merchant profile created in the Gateway
- Configuring the Indigo installation to use the specific user group ID created on the Gateway
4.3.3 Capture and configure the devices in Indigo
- Each device to be deployed at the merchants store must be captured on the indigo server.
- Depending on an integrator the IP addresses of the devices or Pos Serial numbers can be used
4.3.4 Setting up a static IP address on the Indigo server.
- A static IP address must be configured in the Indigo server. This is a unique IP assigned for each Indigo installation.
- The Pos Till//Server or devices must be configured to connect with the same IP address specified in the Indigo machine. Failure to configured the devices appropriately may lead to the devices or POS Till/Server not being able to communicate and connect to the Indigo server
4.3.6 Remote backups using rSync should be set to the correct back up host
- Each Indigo installation must be configured with rSync, allowing for Indigo backups to be performed to a remoted machine
- Performing a handshake from the Indigo server to the remote machine will need to be performed to ascertain that the two servers can communicate. This sort of test will only succeed when the generated keys from Indigo have been uploaded to the backup sever
4.3.7 Set up the Indigo server for Sentry monitoring
- Each Indigo installation must be configured for Sentry monitoring
- The Time Zone should match the one in which the Indigo is deployed in.
5. Architectural Structure for Indigo
The following diagram illustrates the POS till directly connecting to an Indigo server
The 2nd illustration shows the POS till connecting to the Indigo server via a POS server
6. Muira 010 & Ingenico Pin Pads/Devices
As earlier mentioned the hardware to be used is largely dependent on the region in which the Acquirer operates in. The device used can be either be an Ingenico or Muira device. This section only depicts the M010 which can connect via WIFI and the Ingenico IPP350 which connects using an Ethernet Cable.
6.1 Muira M010
6.2 Ingenico IPP350
7. Sign off Procedure
The sign off process serves as a last mile in the integration stage where all the parties concerned qualify the project as integrated successfully .The sign off process pertains to the functionality developed by an Integrator on behalf of the merchant and the signatories of the sign off document should be representative from the Acquiring bank, Integrator & iVeri. The functionality to be signed off on is detailed in 8. APPENDIX A
- During the sign off process it assumed that the integrator has completed the development as per the “Generic PoS API Channel specification” provided by iVeri
- Performed all the test cases described in the comfort testing with iVeri
8. Integrator / Merchant Signoff
iVeri Indigo Software Version
Integrator / Merchant Software Version
- Indigo - Transaction Types & Risk
- Authorisation (Initial) / pre-authorisation - reservation of funds on the cardholders account. This is a temporary "hold" on the funds that lasts for 5 days or more dependent on the issuers’ pre-authorisation policy on the merchant classification code (MCC code).
- Authorisation Reversal - Unreserve the funds previously reserved on the cardholders account.
- (Authorisation) Debit – Settles previously reserved funds (authorisation) into the merchants account.
- (Authorisation) Credit – Refunds’ settled funds that were previously credited to the merchant’s account.
- Debit (Initial / Purchase) – A transaction processed by the merchant when good and services are exchanged. This transaction type gives a debit instruction to the card holder’s bank account while crediting the merchants’ account.
- Debit Refund / Credit – A transaction processed by the merchant reversing a previous Debit (Purchase) transaction. This transaction should only be processed by privileged administrators of the integrated solution as it is seen as one of the high-risk transactions.
- Payment (Initial Credit) – A transaction processed by the merchant taking money from the merchant’s bank account and paying the card. This transaction is sometimes referred to Initial credit. This transaction should only be processed by privileged administrators of the integrated solution as it is seen as one of the high-risk transactions which cannot be reversed or undone.
- Cash Back - The portion of the total value that is to be dispensed to the cardholder as cash.
- Cash Advance - The total value is to be dispensed to the cardholder as cash i.e. the cashback portion of the transaction is equal to the amount of the transaction being performed with no exchange of good or services.
- Void – This is a cancelation request for a previously performed transaction and must be processed immediately should the integrated solution not receive a response (Time Out) or faces a technical error (Exception). The merchant / integrator needs to ensure that no goods and services or cash will be exchanged should this transaction be processed by the integrated solution.
- Application Functionality
- Prior to [Insert] (“the Merchant”), deploying Indigo (“the Software”) confirms that:
- the Merchant has elected the following transaction types as the ones that its integration will process and proceeds with the implementation on this basis;
- The Merchant will satisfy themselves that they have done test transactions and that the results of the transactions meet with their requirements.
Indigo Pi or Machine in a restricted area
Indigo Pi/Server on a UPS
Centrally located Indigo Server managed by the integrator
Locally Deployed Indigo server per store/property/ site
8.1.1 Sign Off
For and on behalf of the Nedbank
For and on behalf of the Integrator( name of the Integrator or Merchant name)
9. Indigo Implementation Process
An overall summary of all the tasks required in order to implement the solution.
Line of Business
Integrate Indigo into the merchants Till Software system or Line of business
Perform test transactions on the test environment
Develop or Set up an Indigo channel
Place an order for hardware(Test and Live Units)
Deliver the appropriate hardware
Key injection into the devices
in-store installation i.e. stands, devices, WIFI/Ethernet set up
Give remote access to the Indigo Server to the iVeri Support Team
Test the WIFI/Ethernet connection between POS Till and Indigo Server
Configuring Indigo channels, services, devices etc.
Perform end to end testing: Handshakes between Indigo host and Gateway; Transaction types etc.
Sign off on the functionality implemented in the Indigo Solution