Skip to main content

How To Configure Givex Gift Cards

Introduction

There are numerous elements involved in configuring the gift card solution. This guide describes the configuration that will enable identification and authorisation of gift cards using the external service provider Givex.

The purpose of this guide is to demonstrate the steps required to configure the Enactor Estate Manager so that gift cards can be authorised through the Givex gift card service. The guide covers Acquirer setup, Acquirer Connection, Authorisation Server Config, Service Definition, Card Type, Gift Card Type, and IIN Range configuration.

note

This guide does not cover the complete configuration of gift cards. For full gift card configuration, refer to the Enactor Gift Card configuration guide.


Pre-requisites

The following must be in place before starting this configuration:

  • The Enactor Web Card Authorisation service must be deployed and configured on the Estate Manager.
  • The enactor.xml on the POS must be configured to use the Enactor EFT authorisation service.
  • Enactor Standard Configuration has been imported into the Estate Manager and has been broadcast to the POS.

Overview

For gift cards to operate successfully in the POS application, the following entities must be configured in this order:

  1. Acquirer - Define a Givex Gift Card acquirer for each country.
  2. Acquirer Connection - Link the acquirer to the Givex host with connection protocols and timeouts.
  3. Authorisation Server Config - Assign the Givex acquirer to the authorisation server.
  4. Service Definition - Enable the Card Authorisation Server service.
  5. Card Type - Create a Gift Card card type.
  6. Gift Card Type - Configure the gift card type with region, currency, and acquirer.
  7. IIN Ranges - Define the card number ranges used to identify Givex gift cards at the POS.

Configuration

Acquirer

Within the standard configuration, several gift card acquirers are already defined. For the purposes of this guide, we will define a new acquirer for Givex Gift Cards.

Navigate to Configuration > Financial > Acquirers and the Acquirer Maintenance application will open.

Select Create a new Acquirer.

Acquirer Maintenance - Create new acquirer dialog showing Region, Acquirer Type, and Acquirer ID fields

Here the Region, Type, and ID of the acquirer can be defined.

tip

A new acquirer should be defined for each country. The simplest way to complete this task is to copy an existing acquirer and modify it for each new country that is required.

The following parameters should be set:

FieldValue
RegionSelect from defined regions (Groups - Region)
Acquirer TypeGift Card
Acquirer IDGIVEX_UK

Then select the Create button.

Select the General tab. Set the Description field to 'Givex Gift Cards (UK)'. Set the Authorisation Merchant ID, if provided.

Acquirer Maintenance - General tab showing Description and Authorisation Merchant ID fields

Select the Gift Card Details tab. Check the box for Validate Online on Issue or TopUp. Check the box for Check Balance Online on Redemption. Set the Server User Name. Select the Change Server Password button and provide the Givex user's password.

Acquirer Maintenance - Gift Card Details tab showing online validation and server credential fields

FieldDescription
Validate Online on Issue or TopUpEnsures gift card issue and top-up operations are validated with Givex online
Check Balance Online on RedemptionChecks the card balance with Givex before allowing redemption
Server User NameThe Givex user account for authentication
Change Server PasswordSets the password for the Givex user account

Select the Save button.


Acquirer Connection

Acquirer Connections link the Acquirer to the host and define connection protocols and timeouts.

Navigate to Configuration > Financial > Acquirer Connections and the Acquirer Connections Maintenance application will open.

Select Create a new Acquirer Connection.

Acquirer Connection Maintenance - Create new connection dialog showing Region, Acquirer Type, and Connection ID fields

tip

An Acquirer Connection should be defined for each country. The simplest way to complete this task is to copy an existing Acquirer Connection and modify it for each new country that is required.

The following parameters should be set:

FieldValue
RegionSelect from defined regions (Groups - Region)
Acquirer TypeGivex Dataconnect Gift Card TCP/IP
Acquirer IDGIVEX_CONN_UK

Then select the Create button.

Select the General tab. Set the Description. Set the Timeout. Set the Connect Timeout.

Acquirer Connection Maintenance - General tab showing Description, Timeout, and Connect Timeout fields

Select the TCP/IP Details tab. Set the Max Connections. Uncheck the Add Header box. Check the Use SSL box. Select KeyStore Type = JKS. Provide a KeyStore File Name and password.

Acquirer Connection Maintenance - TCP/IP Details tab showing Max Connections, SSL, and KeyStore configuration

FieldDescription
Max ConnectionsMaximum number of concurrent connections to the Givex host
Add HeaderWhether to add a header to the connection request (uncheck for Givex)
Use SSLEnables SSL encryption for the connection
KeyStore TypeThe type of SSL keystore (JKS)
KeyStore File NamePath to the SSL keystore file

Select Save.


Authorisation Server Config

Authorisation Server configuration is provided as part of the Enactor standard configuration. The application can be accessed from Configuration > Financial > Authorisation Server Config.

Select the Edit icon against your defined server configuration. This page allows numerous Acquirers to be assigned to an Authorisation Server.

Authorisation Server Config - Edit page showing list of assigned acquirers

Select the Givex Gift Card (UK) acquirer defined earlier and select the + icon.

The connection configuration page will display.

Select the Primary Connection tab. Select Givex Connection UK from the Acquirer Connections. Enter the hostname and port for your Givex service.

Authorisation Server Config - Primary Connection tab showing Acquirer Connection, hostname, and port fields

info

If you have a secondary Givex server, select the Secondary Connection tab and set the same details for the backup host.

Select Save to save the Givex Gift Card (UK) acquirer to the supported acquirers list.

Select Save to save the CARD_AUTH_SERVER configuration.


Service Definition

Included in the Enactor reference configuration is a Service Definition for 'Card Authorisation Server'. This defines the service that will process card requests from the POS.

Navigate to Administration > Services > Service Definitions.

Select 'Card Authorisation Server' from the Service Type. Select 'Card Authorisation Server' from Device Type. Select Apply Filters.

Service Definitions - Filtered list showing Card Authorisation Server service

Select the Edit icon against the service that is displayed.

This shows various parameters which are defined when the Service Definition is created. Only the following parameters are editable:

FieldDescription
DisabledSelecting this parameter will disable the service (takes effect on next restart)
NameAllows the name description of the service to be changed
Auto StartDefines whether the service will automatically start when the Enactor services are started

Check/tick Auto Start.

Service Definition - Edit page showing Disabled, Name, and Auto Start fields

Select the Card Auth tab.

Service Definition - Card Auth tab showing Queue Name, Server Configuration, and Number of Threads fields

note

Queue Name and Server Configuration should only be specified when it is necessary to override the defaults, for example if running more than one authorisation service on one machine. The default queue name is enactor.cardAuthorisation.RequestResponseQueue. Server configuration is normally obtained from AuthorisationServer or POSTerminal devices. Number of Threads represents the number of requests the service can handle simultaneously.

In the case of gift card configuration, it is not necessary to amend either the Queue Name or Server Configuration.

Number of Threads may be increased as required, depending on the size of the estate and number of requests.

Select Save.


Card Type

Navigate to Configuration > Financial > Card Types.

Select Create a new Card Type.

Card Type Maintenance - Create new card type dialog showing Region, Type, and Card Type ID fields

The following parameters should be set:

FieldValue
RegionAll Regions
TypeGift Card
Card Type IDGIFT_CARD
note

A single Card Type is defined for Gift Card for all regions.

Select Create.

Card Type Maintenance - General tab showing Description field

Set Description to 'Givex Gift Card'. No other fields are required.

Select Save.


Gift Card Type

Gift Card Type can be accessed from Configuration > Financial > Gift Card Types.

Select Create a new Gift Card Card Type.

Gift Card Type Maintenance - Create new gift card type dialog showing Gift Card Type ID field

Set Gift Card Type ID to GIVEX_UK.

Select Create.

Gift Card Type Maintenance - General tab showing Description, Region, Currency, Processing Service, Acquirer, and Redemption Tender fields

FieldDescription
DescriptionA descriptive name for this gift card type
RegionThe region this gift card type applies to
CurrencyThe currency used for this gift card
Processing ServiceSet to 'Auth Service'
AcquirerSet to 'Givex Gift Cards (UK)' created in the earlier steps
Redemption TenderThe gift card tender configured for this region

Select the Values tab.

Gift Card Type Maintenance - Values tab showing gift card value configuration options

There are numerous gift card configuration options presented in this tab. These are self-explanatory per their descriptions.

Select the Behaviour tab.

Gift Card Type Maintenance - Behaviour tab showing gift card behaviour configuration options including offline redemption

There are numerous gift card configuration options presented in this tab. These are self-explanatory per their descriptions.

warning

Use caution when enabling the redemption offline option. In an offline scenario, this could enable a tender greater than the value of credit held on the card.

tip

If additional regional gift cards are needed, the Gift Card Type above can be copied, and the Region, Currency, Acquirer, and Redemption Tender amended.


IIN Ranges

IIN (Issuer Identification Number) ranges allow the POS to identify what type of card is being captured. Generally, the first six or eight digits of the card range is specified - for example, one of the IIN ranges for American Express is 340000 to 349999 with a PAN (Primary Account Number) length of 15.

This functionality is also used for gift cards, and some example IIN ranges are included as part of Enactor's standard configuration. Many of the available options in IIN ranges are not applicable or used for gift cards.

Navigate to Configuration > Financial > IIN Ranges.

IIN Range Maintenance - List view showing pre-defined IIN ranges

The IIN Range Maintenance application will open, showing some of the pre-defined IIN ranges.

The example range provided for Givex Gift Card UK is 633887 to 633887.

Select Create a new IIN Range.

The following parameters should be set:

FieldValue
Range Start633887
Range End633887
Minimum PAN Length22
Maximum PAN Length22

IIN Range Maintenance - Create new IIN range dialog showing Range Start, Range End, and PAN Length fields

Select Create.

Set Card Description to 'Givex Gift Card UK'. Check/tick No Luhn Check Digit. Set Country. Set Currency.

IIN Range Maintenance - General tab showing Card Description, No Luhn Check Digit, Country, and Currency fields

FieldDescription
Card DescriptionDescriptive name for this IIN range
No Luhn Check DigitDisables Luhn algorithm validation for this card range
CountryThe country this IIN range applies to
CurrencyThe currency for this IIN range

Select the Track Data tab.

IIN Range Maintenance - Track Data tab showing PAN Attributes with Track 2 setting and track length

note

On the PAN Attributes field, Track is defined as 2. For almost all mag cards, the PAN is stored on track 2. The track length is also defined here, as is whether the card number is allowed to be keyed.

Select the Applicable Cards tab.

IIN Range Maintenance - Applicable Cards tab showing Payment Card, Gift Card, and Gift Card Type fields

Check/tick Payment Card. Check/tick Gift Card. Set Gift Card Type to 'Givex Gift Card UK' which was created earlier.

tip

For additional countries, copy this IIN range, and set the Card Description, Country, Currency, and Gift Card Type.

Select Save.