Anda di halaman 1dari 143

ENTERPRISE TERMINAL INTERFACE

MANAGER (ETIM)
USERS MANUAL
V E R S I O N 2 . 0 0 . 0 0 . 4 6 A N D H I G HE R
OCTOBER 18, 2013

Notice
VeriFone, the VeriFone logo, PAYware PC, PAYware SIM, PAYware Transact, PAYware Mobile, PAYware
Connect, and PCCharge and are registered trademarks of VeriFone. Other brand names or trademarks
associated with VeriFone products and services are trademarks of VeriFone, Inc. All other brand names
and trademarks appearing in this manual are the property of their respective holders.
NO WARRANTY
VeriFone has attempted to ensure the accuracy of the contents of this Program Guide. However, this
Program Guide may contain errors or omissions. This Program Guide is supplied as-is, without any
warranty of any kind, either expressed or implied, including the implied warranties of merchantability
and fitness for a particular purpose.
LIMITED LIABILITY
In no event shall VeriFone be liable for any indirect, special, incidental, or consequential damages,
including without limitation damages for loss of business, profits, or the like, even if VeriFone or its
representatives have been advised of the possibility of such damages.
Mailing Address
VeriFone, Inc.
8001 Chatham Center Drive
Suite 500
Savannah, GA 31405
Telephone
Savannah Sales Office: (800) 725-9264
Savannah Office Fax: (912) 527-4533
Web Site
www.verifone.com
Advanced Product Support
Advanced Product Support is available to those developers who will integrate their application with
Enterprise Terminal Interface Manager and implement that stand-alone product as an in-house
transaction processing solution.
(888) 764-1764
APSupport@verifone.com
VeriFone Integration Support
VeriFone Integration Support is available to those developers who will integrate their application with
PAYware Connect and implement that stand-alone product as an in-house transaction processing
solution.
DevSupport@verifone.com
(877) 659-8983

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


2

Revision History
Revision

Date

Author

Revision Description

1.00a

08-19-2011

Shawn_P2

New document

1.00b

03-23-2012

Shawn_P2

Updated Security Notice


Formatting changes throughout
New screen shots: BIN range, BIN range config, BIN manager
conversion utility (all)
Client ID Global Settings: Added Max Bad Swipe Count
Troubleshooting: Added Testing MX Pass Thru Commands section

2.00a

06-27-2012

Shawn_P2

New document for eTIM 2.00

2.00b

08-02-2012

Shawn_P2

Client ID Global Settings: Added Store Sgnature Files


MX Series Device Global Settings: Added Read Block Timeout
MX Series Device Transaction Processing: Updated Enter PIN form
section.

2.00c

09-27-2012

Shawn_P2

Added Appendix A Error Handling


Added Appendix B - Standalone Device Commands
Updated screen shot: PAYware Global Configuration
Revisions to Legacy MX Passthru Test section
Added Reference Document to Overview
Updates to Client ID Global Settings - Credit Settings

2.00d

10-05-2012

Shawn_P2

Updates to Chapter 7 Signature Capture using MX Series Devices


Updates to Client ID Global Settings, Require Signature Capture
Added Payment Transaction Flow section to Chapter 4.
Updates to eTIM Overview.
Added Store Signature Files save directory.
Formatting changes throughout.
Updated Security Notice.

2.00e

03-25-2013

Shawn_P2

Updated installation screen shots. Updated configuration screen shots.


Minor edit to System I Setting up a Separate Subsystem note. Updates
to Client ID Global Settings. Including adding Signature Status in
Response. Added descriptions to MX Series Device Configuration table.
New TCP server test SS. Added Integration Chapter and moved
Appendix B (Standalone Device Commands) into it. Renumbered
chapters accordingly. Added PAYware Connect Store Portal manual to
Reference Documents.
Removed DEVICEIP and DEVICEPORT elements from Credit Card
Return/Void (TROUTD Token) transaction examples.

2.00f

04-15-2013

Shawn_P2

Device Inventory new screen shot , sub-sections, and verbiage.


PAYware Global Configuration new screen shot and added Payment
Transaction Flow. Updates to TCP Server Test, Direct Device Test.
Added Configuration Saved heading.
Added Rules for Payment Flows Note to Payment Transaction Flow
Overview section. Updates to Configuration and Transaction Stages
sections. Additions to Client ID Local Configuration section. Added
note about enabling MX 900 series devices for TCP/IP to Config
section.

2.00g

07-26-2013

Shawn_P2

Added Debit REVERSAL to eTIM Overview supported transactions list.


Added Prompt for Swipe on Reversal with TROUTD or CTROUTD option
to global configuration and local client ID configuration sections.
Added description for Prompt for Payment Type option of MX Series
Device configuration. Updates to back cover (Tested Terminal SW
Versions).

2.00h

08-09-2013

Shawn_P2

Added Bypass Exp Date Private Label option to global configuration


and local client ID configuration sections. Updated screenshots and
associated verbiage for TCP Server Test and Direct Device Test.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


3

Revision

Date

Author

Revision Description

2.00i

10-18-2013

Shawn_p2

Added EBT Prompt for Swipe on Void option to global configuration


and local client ID configuration sections. Updated Debit Prompt for
Swipe on Void option where existing. Minor updates to Payment
Transaction Flow section. Updates to Select Payment Type and Enter
PIN sections of MX Series Device Transaction Processing.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


4

Table of Contents
Notice ................................................................................................. 2
Revision History ..................................................................................... 3
Welcome .............................................................................................. 7
eTIM Overview ........................................................................................................ 7
Reference Documents .......................................................................................... 8

Important Security Notice ........................................................................ 9


Introduction and Scope ......................................................................................... 9
Applicability...................................................................................................... 9
Distributions and Updates ..................................................................................... 9
What does PA-DSS mean to you? ............................................................................ 10
Third Party Applications ..................................................................................... 11
PA-DSS Guidelines ............................................................................................. 11
More Information.............................................................................................. 17

Documentation Notes ............................................................................ 19


Chapter 1 -- Installation ......................................................................... 21
eTIM Installation: Windows .......................................................................................
Installation Prerequisites ....................................................................................
Installation .....................................................................................................
Whats Next? ...................................................................................................
eTIM Installation: Linux/Unix ....................................................................................
Installation Prerequisites ....................................................................................
Installation .....................................................................................................
Whats Next? ...................................................................................................
eTIM Installation: i5/OS ...........................................................................................
Installation Prerequisites ....................................................................................
Installation .....................................................................................................
Whats Next? ...................................................................................................

23
23
23
30
31
31
32
39
40
40
43
49

Chapter 2 Configuration ....................................................................... 51


Starting the eTIM Configuration Utility...................................................................
Server Configuration ...............................................................................................
PAYware Host Configuration......................................................................................
Device Result Settings .............................................................................................
Device Inventory ....................................................................................................
BIN Range Configuration ..........................................................................................
Receipt Settings ....................................................................................................
Configuration Saved................................................................................................

52
54
56
73
74
78
80
82

Chapter 3 Launching eTIM .................................................................... 83


Launching eTIM using the command line scripts .............................................................. 84
Launching eTIM using the GUI based launcher ................................................................ 85

Chapter 4 Transaction Processing........................................................... 87


Payment Transaction Flow........................................................................................ 88
Overview ........................................................................................................ 88
Transaction Stages ............................................................................................ 88
Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.
5

Payment Processing Workflow Diagram ........................................................................ 92


MX Series Device Transaction Processing....................................................................... 93

Chapter 5 Integration .........................................................................105


Sample PAYware Connect Transactions ....................................................................... 106
VSP Activate Card ............................................................................................ 106
Credit Card Sale .............................................................................................. 106
Credit Card Sale (Manual Entry on Payment Device) .................................................. 108
Credit Card Pre-Authorization ............................................................................. 109
Credit Card Voice Authorization .......................................................................... 109
Credit Card Completion ..................................................................................... 110
Credit Card Post-Authorization............................................................................ 111
Credit Card Return (Swiped) ............................................................................... 112
Credit Card Return (TROUTD Token) ..................................................................... 112
Credit Card Void (TROUTD Token) ........................................................................ 113
Signature Capture ............................................................................................ 114
Device Information........................................................................................... 115
Passthru ........................................................................................................ 116

Chapter 6 Troubleshooting ..................................................................119


eTIM Testing Suite................................................................................................. 120
Starting the eTIM Testing Suite ........................................................................... 120
TCP Server Test .................................................................................................... 121
PAYware Connect Test ........................................................................................... 122
BIN Lookup Test.................................................................................................... 123
Direct Device Test ................................................................................................. 124
Legacy MX Passthru Test ......................................................................................... 126

Chapter 7 eTIM Utilities ......................................................................129


BIN Manager Conversion Utility ................................................................................. 130

Chapter 8 Signature Capture using MX Series Devices ................................137


Prompted Signature Capture .................................................................................... 138

Appendix A Error Handling...................................................................139


eTIM Error Handling ............................................................................................... 140
Result Code .................................................................................................... 140
Result ........................................................................................................... 140
Response Text................................................................................................. 141
PAYware Connect Result Codes ................................................................................. 142

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


6

Welcome
Congratulations on your selection of VeriFones Enterprise Terminal Interface Manager (eTIM)!
VeriFone is one of the industrys leading suppliers of payment processing products designed for small,
medium, and large sized businesses.
eTIM is designed to support the connection of selected VeriFone terminals to PAYware Connect.
PAYware Connect is a fast, reliable, and cost effective product that can easily be integrated into any
brick and mortar, MOTO (Mail Order/Telephone Order), e-Commerce, or restaurant application-regardless of the operating system or development platform used. PAYware Connect enables merchants
to process secure payment transactions in a real time environment over the Internet and supports all
major credit and debit card payment types, EBT, and gift.

eTIM Overview
eTIM is a server designed and developed by VeriFone, Inc. to work between PAYware Connect and
selected VeriFone Point of Sale devices such as the VeriFone MX Series. It is written in Java, so it can
run on multiple platforms, including Windows, Linux, and OS/400 (or i5/OS) for the IBM System i.
eTIM works in conjunction with PAYware Connects API so merchants with existing PAYware Connect
interfaces will not have to change their API to take advantage of eTIM. Highly configurable and easy to
use, eTIM provides a utility to configure all of the global and device settings for the supported
terminals on a Local Area Network (LAN) and is capable of managing a large number of terminals per
store. An optional BIN Management feature supports debit encouragement.
eTIM supports Credit Card, Debit Card, EBT, and Gift Card transactions. The commands supported
include:
Credit Cards: SALE, PRE_AUTH, POST_AUTH, CREDIT, RETURN (processor dependent). Other
transactions are available using passthrough to PAYware Connect.
Debit Cards: SALE, RETURN, BALANCE, VOID, CREDIT, REVERSAL, PRE_AUTH. The use of SALE with
CASHBACK_AMNT is supported (processor dependent)
EBT Cards: SALE,RETURN,POST_AUTH (voucher), VOID, BALANCE. The use of SALE with
CASHBACK_AMNT is supported (CASH_BENEFITS only)
Gift Cards (processor dependent): SALE, PRE_AUTH, CREDIT, RETURN, BALANCE, ADD_VALUE,
REMOVE_VALUE, ACTIVATE, DEACTIVATE, REACTIVATE, REGISTER, GIFT_CLOSE
Sample XML Request set:
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>SALE</COMMAND>
<TRANS_AMOUNT>5.00</TRANS_AMOUNT>
<INVOICE>123456</INVOICE>
<CLIENT_ID>1100010001</CLIENT_ID>
<DEVICEIP>192.168.0.20</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
</TRANSACTION>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


7

Note that card data is not included in the transaction. This will prompt the terminal to request a card
swipe. If card data is provided, the terminal will be bypassed, and eTIM will send the transaction
directly to PAYware Connect.
If the DEVICEIP and DEVICEPORT are not present in the transaction, eTIM will authenticate to
PAYware Connect and attempt to process the transaction on behalf of the POS. In this manner, eTIM
supports all transactions available in the PAYware Connect Integration Guide.
This manual is your guide to the installation, configuration, integration, and usage of eTIM for PAYware
Connect. Additionally, VeriFones Integration Support team is available to answer your questions about
all aspects of the PAYware Transact, PAYware Connect, and eTIM products. If you cannot find the
answers to your questions within the pages of this manual, please contact our team at (877) 659-8983.
We want to know your thoughts about eTIM. If you have any comments or suggestions about the eTIM
product or this manual, please e-mail us at feedback@verifone.com.

Reference Documents

PAYware Connect Integration Guide


PAYware Connect Store Portal Manual

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


8

Important Security Notice


Introduction and Scope
The Payment Card Industry Payment Application Data Security Standard (PCI PA-DSS) is comprised of
fourteen requirements that support the Payment Card Industry Data Security Standard (PCI DSS). The
PCI Security Standards Council (PCI SSC), which was founded by the major card brands in June 2005,
set these requirements in order to protect cardholder payment information. The standards set by the
council are enforced by the payment card companies who established the Council: American Express,
Discover Financial Services, JCB International, MasterCard Worldwide, and Visa, Inc.
PCI PA-DSS is an evolution of Visas Payment Application Best Practices (PABP), which was based on the
Visa Cardholder Information Security Program (CISP). In addition to Visa CISP, PCI DSS combines
American Express Data Security Operating Policy (DSOP), Discover Networks Information Security and
Compliance (DISC), and MasterCards Site Data Protection (SDP) into a single comprehensive set of
security standards. The transition to PCI PA-DSS was announced in April 2008. In early October 2008,
PCI PA-DSS Version 1.2 was released to align with the PCI DSS Version 1.2 which was released on
October 1, 2008. On January 1, 2011, PCI PA-DSS Version 2.0 was released. This extends the PCI DSS
Version 1.2 which was released on October 1, 2008 and is effective as of 01/01/2011.

Applicability
The PCI PA-DSS applies to any payment application which stores, processes, or transmits cardholder
data as part of authorization or settlement, unless the application would fall under the merchants PCI
DSS validation. PAYware PC, PAYware Transact, PAYware SIM, and PCCharge (collectively the
PAYware NA Payment Applications) were developed by VeriFone for use by third parties, and
therefore are subject to PA-DSS validation. PAYware Connect (also included under PAYware NA
Payment Applications) falls under PCI DSS. See the PCI PA-DSS Program Guide to determine if PCI PADSS validation is required for any other payment applications used at the merchant location.It is
important to note that PA-DSS or PCI DSS validated payment applications alone do not guarantee PCI
DSS compliance for the merchant. The validated payment application must be implemented in a PCI
DSS compliant environment. If your application is ran on Windows XP, you are required to turn off
Windows XP System Restore Points.

Distributions and Updates


This guide will be provided to VeriFones customers including processors, resellers, ISOs, and
integrators along with the PAYware NA payment applications. It is the responsibility of these parties to
ensure the information contained in this guide is passed on to their customers (the merchant), in order
to illustrate the requirements for complying with PCI DSS.
Additional information about PA-DSS and VeriFones PA-DSS Training can be found on our website at
www.verifone.com/padss.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


9

What does PA-DSS mean to you?


VeriFone submits its PAYware NA payment applications to an annual PA-DSS audit in order to maintain
PA-DSS validation. In addition, if any major version change is made in any PAYware NA payment
applications, VeriFone submits that application for a full PA-DSS audit again. An example of a major
version change would be PCCharge 5.8 moving to PCCharge 5.9. For minor changes, such as PCCharge
5.8.1 to 5.8.2, an attestation form for minor change revisions is required. These minor change revisions
are submitted to VeriFones Qualified Security Assessor (QSA) which creates a report to submit to PCI
SSC. All validated applications are listed on the PCI SSC web site at
https://www.pcisecuritystandards.org/security_standards/vpa/. Always review the full PCI and PADSS compliance requirements at the PCIsecuritystandards.org website. Summary PA-DSS requirements
material given by VeriFone is not intended to be viewed/used as the full PCI/PA-DSS compliance
requirement.
The following table provides opening points to cover in any discussion with merchants on data storage
and why a merchant should use PAYware PC, PAYware Transact, PAYware SIM, PAYware Connect or
PCCharge to assist in maintaining PCI-DSS compliance.

Cardholder Data

Data Element

Storage
Permitted

Protection
Required

PCI DSS Req. 3, 4

Primary Account Number

Yes

Yes

Yes

Yes

Yes

No

Yes

Yes

No

Yes

Yes

No

Full Magnetic Stripe Data3

No

N/A

N/A

CAV2/CID/CVC2/CVV2

No

N/A

N/A

PIN/PIN Block

No

N/A

N/A

Cardholder Name

Service Code 1
Expiration Date
Sensitive
Authentication
Data 2

2
3

These data elements must be protected if stored in conjunction with the PAN. This protection should be per
PCI DSS requirements for general protection of the cardholder environment. Additionally, other legislation
(for example, related to consumer personal data protection, privacy, identity theft, or data security) may
require specific protection of this data, or proper disclosure of a company's practices if consumer-related
personal data is being collected during the course of business. PCI DSS, however, does not apply if PANs are
not stored, processed, or transmitted.
Do not store sensitive authentication data after authorization (even if encrypted).
Full track data from the magnetic stripe, magnetic-stripe image on the chip, or elsewhere.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


10

Third Party Applications


A PAYware NA payment application validation does not extend to any external third party application
that has integrated such PAYware NA payment application as the payment engine. The end-to-end
transaction process, beginning with entry into the third party application until the response from the
payment engine is returned, must meet the same level of compliance. In order to claim the third party
application is end-to-end compliant, the application would need to be submitted to a QSA for a full PADSS audit.
The use of a PAYware NA payment application also does not exempt a third party integrators
application from a PA-DSS audit. The end user and/or P.O.S. developer can integrate and be compliant
in the processing portion of a payment transaction. A brief review (given below) of the PA-DSS
environmental variables that impact the end user merchant can help the end user merchant obtain
and/or maintain PA-DSS compliance. Environmental variables that could prevent passing an audit
include without limitation issues involving a secure network connection(s), end user setup location
security, users, logging and assigned rights. Remove all testing configurations, samples, and data prior
to going into production on your application.

PA-DSS Guidelines
The following PA-DSS Guidelines are being provided by VeriFone as a convenience to its customers.
Customers should not rely on these PA-DSS Guidelines, but should instead always refer to the most
recent PCI DSS Program Guide published by PCI SSC.

1. Sensitive Date Storage Guidelines


Do not retain full magnetic stripe, card validation code or value (CAV2, CID, CVC2, CVV2), or PIN block
data.
1.1
Do not store sensitive authentication data after authorization (even if encrypted):
Sensitive authentication data includes the data as cited in the following Requirements
1.1.1 through 1.1.3.
PCI Data Security Standard Requirement 3.2
Note: By prohibiting storage of sensitive authentication data after authorization, the
assumption is that the transaction has completed the authorization process and the customer
has received the final transaction approval. After authorization has completed, this sensitive
authentication data cannot be stored.
1.1.1 After authorization, do not store the full contents of any track from the magnetic
stripe (located on the back of a card, contained in a chip, or elsewhere). This data is
alternatively called full track, track, track 1, track 2, and magnetic-stripe data.
In the normal course of business, the following data elements from the magnetic stripe may
need to be retained:
The accountholders name,
Primary account number (PAN),
Expiration date, and
Service code
To minimize risk, store only those data elements needed for business.
Note: See PCI DSS and PA-DSS Glossary of Terms, Abbreviations, and Acronyms for additional
information. PCI Data Security Standard Requirement 3.2.1

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


11

1.1.2 After authorization, do not store the card-validation value or code (three-digit or fourdigit number printed on the front or back of a payment card) used to verify card-not-present
transactions.
Note: See PCI DSS and PA-DSS Glossary of Terms, Abbreviations, and Acronyms for additional
information.
PCI Data Security Standard Requirement 3.2.2
1.1.3 After authorization, do not store the personal identification number (PIN) or the
encrypted PIN block.
Note: See PCI DSS and PA-DSS Glossary of Terms, Abbreviations, and Acronyms for additional
information.
PCI Data Security Standard Requirement 3.2.3
1.1.4 Securely delete any magnetic stripe data, card validation values or codes, and PINs or
PIN block data stored by previous versions of the payment application, in accordance with
industry-accepted standards for secure deletion, as defined, for example by the list of
approved products maintained by the National Security Agency, or by other State or National
standards or regulations.
PCI Data Security Standard Requirement 3.2
Note: This requirement only applies if previous versions of the payment application stored
sensitive authentication data.
1.1.5 Securely delete any sensitive authentication data (pre-authorization data) used for
debugging or troubleshooting purposes from log files, debugging files, and other data sources
received from customers, to ensure that magnetic stripe data, card validation codes or values,
and PINs or PIN block data are not stored on software vendor systems. These data sources must
be collected in limited amounts and only when necessary to resolve a problem, encrypted
while stored, and deleted immediately after use. PCI Data Security Standard Requirement 3.2

2. Protect stored cardholder data


2.1
Software vendor must provide guidance to customers regarding purging of cardholder
data after expiration of customer-defined retention period. PCI Data Security Standard
Requirement 3.1
2.2
Mask PAN when displayed (the first six and last four digits are the maximum number of
digits to be displayed).
Notes:
This requirement does not apply to those employees and other parties with a
legitimate business need to see full PAN;
This requirement does not supersede stricter requirements in place for displays of
cardholder datafor example, for point-of-sale (POS) receipts.PCI Data Security
Standard Requirement 3.3
2.3
Render PAN, at a minimum, unreadable anywhere it is stored, (including data on
portable digital media, backup media, and in logs) by using any of the following approaches:
One-way hashes based on strong cryptography with associated key management
processes and procedures.
Truncation
Index tokens and pads (pads must be securely stored)
Strong cryptography with associated key management processes and procedures.
The MINIMUM account information that must be rendered unreadable is the PAN. PCI Data
Security Standard Requirement 3.4
Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.
12

The PAN must be rendered unreadable anywhere it is stored, even outside the payment
application.
Note: Strong cryptography is defined in the PCI DSS and PA-DSS Glossary of Terms,
Abbreviations, and Acronyms.
2.4
If disk encryption is used (rather than file- or column-level database encryption),
logical access must be managed independently of native operating system access control
mechanisms (for example, by not using local user account databases). Decryption keys must not
be tied to user accounts. PCI Data Security Standard Requirement 3.4.2
2.5
Payment application must protect cryptographic keys used for encryption of cardholder
data against disclosure and misuse. PCI Data Security Standard Requirement 3.5
2.6
Payment application must implement key management processes and procedures for
cryptographic keys used for encryption of cardholder data. PCI Data Security Standard
Requirement 3.6
2.7
Securely delete any cryptographic key material or cryptogram stored by previous
versions of the payment application, in accordance with industry-accepted standards for secure
deletion, as defined, for example the list of approved products maintained by the National
Security Agency, or by other State or National standards or regulations. These are
cryptographic keys used to encrypt or verify cardholder data. PCI Data Security Standard
Requirement 3.6
Note: This requirement only applies if previous versions of the payment application used
cryptographic key materials or cryptograms to encrypt cardholder data.

3. Provide secure authentication features


3.1 The payment application must support and enforce unique user IDs and secure
authentication for all administrative access and for all access to cardholder data. Secure
authentication must be enforced to all accounts, generated or managed by the application, by
the completion of installation and for subsequent changes after the out of the box
installation (defined at PCI DSS Requirements 8.1, 8.2, and 8.5.88.5.15) for all administrative
access and for all access to cardholder data. PCI Data Security Standard Requirements 8.1, 8.2,
and 8.5.88.5.15
Note: These password controls are not intended to apply to employees who only have access to
one card number at a time to facilitate a single transaction. These controls are applicable for
access by employees with administrative capabilities, for access to servers with cardholder
data, and for access controlled by the payment application. This requirement applies to the
payment application and all associated tools used to view or access cardholder data.
3.1.10 If a payment application session has been idle for more than 15 minutes, the
application requires the user to re-authenticate. PCI Data Security Standard
Requirement 8.5.15.
3.2
Software vendors must provide guidance to customers that all access to PCs, servers
and database with payment applications must require a unique user ID and secure
authentication. PCI Data Security Standard Requirements 8.1 and 8.2
3.3
Render payment application passwords unreadable during transmission and storage,
using strong cryptography based on approved standards

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


13

Note: Strong cryptography is defined in PCI DSS and PA-DSS Glossary of Terms, Abbreviations,
and Acronyms. PCI Data Security Standard Requirement 8.4

4. Log payment application activity


4.1
At the completion of the installation process, the out of the box default installation
of the payment application must log all user access (especially users with administrative
privileges), and be able to link all activities to individual users. PCI Data Security Standard
Requirement 10.1
4.2
Payment application must implement an automated audit trail to track and monitor
access. PCI Data Security Standard Requirements 10.2 and 10.3
4.3
Payment application must record at least the following audit trail entries for each
event: User identification. Type of event. Date and time. Success or failure indication.
Origination of event. Identity or name of affected data, system component, or resource.
4.4
PAYware PC uses XML files for centralized logging. Log files are Client.log, Server.log
and Engine.log. PC Charge uses generated text files for centralized logging. Log files are
Logfile.pcc, IODebug.log and ErrLog.pcc. PAYware Transact uses a generated text file for
centralized logging. The log file is System.log.

5. Develop secure payment applications


5.1
Develop all payment applications in accordance with PCI DSS (for example, secure
authentication and logging) and based on industry best practices and incorporate information
security throughout the software development life cycle. These processes must include the
following: PCI Data Security Standard Requirement 6.3
5.1.1 Live PANs are not used for testing or development PCI Data
Security Standard Requirements 6.4.4.
5.1.1.1 Validation of all input (to prevent cross-site scripting, injection flaws,
malicious file execution, etc.)
5.1.1.2 Validation of proper error handling
5.1.1.3 Validation of secure cryptographic storage
5.1.1.4 Validation of secure communications
5.1.1.5 Validation of proper role-based access control (RBAC)
5.1.2
5.1.3
5.1.4

Separate development/test, and production environments


Removal of test data and accounts before production systems become
active development PCI Data Security Standard Requirements 6.44.
Review of all payment application code prior to release to customers
after any significant change, to identify any potential coding vulnerability.
Removal of custom payment application accounts, user IDs, and
passwords before payment applications are released to customers .

Note: This requirement for code reviews applies to all payment application components (both
internal and public-facing web applications), as part of the system development life cycle
required by PA-DSS Requirement 5.1 and PCI DSS Requirement 6.3. Code reviews can be
conducted by knowledgeable internal personnel or third parties.
5.2
Develop all web payment applications (internal and external, and including web
administrative access to product) based on secure coding guidelines such as the Open Web
Application Security Project Guide. Cover prevention of common coding vulnerabilities in
software development processes, to include:

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


14

5.2.1 Injection flaws, with particular emphasis on SQL injection. Cross-site


scripting (XSS). OS Command Injection, LDAP and Xpath injection flaws,
as well as other
injection flaws.
5.2.2 Buffer Overflow.
5.2.3 Insecure cryptographic storage.
5.2.4 Insecure communications.
5.2.5 Improper error handling.
5.2.6 All HIGH vulnerabilities as identified in the vulnerability identification
process at PA-DSS Requirement 7.1.
5.2.7 Cross-site scripting (XSS)
5.2.8 Improper Access Control such as insecure direct object references, failure
to restrict URL access and directory traversal.
5.2.9 Cross-site request forgery (CSRF)
Note: The vulnerabilities listed in PA-DSS Requirements 5.2.1 through 5.2.9 and in PCI DSS at
6.5.1 through 6.5.9 were current in the OWASP guide when PCI DSS v1.2 / PCI DSS v2.0
(01/01/10) was published. However, if and when the OWASP guide is updated, the current
version must be used for these requirements.
5.3
Software vendor must follow change control procedures for all product software
configuration changes. PCI Data Security Standard Requirement 6.4.5. The procedures must
include the following:
5.3.1
5.3.2
5.3.3
5.3.4

Documentation of impact.
Management sign-off by appropriate parties
Testing functionality to verify the new change(s) does not adversely
impact the security of the system. Remove all testing configurations, samples,
and data before finalizing the product for production.
Back-out or product de-installation procedures.

5.4
The payment application must not use or require use of unnecessary and insecure
services and protocols (for example, NetBIOS, file-sharing, Telnet, unencrypted FTP, must be
secured via SSH, S-FTP, SSL, IPSec and other technology to implement end to end security.).
PCI Data Security Standard Requirement 2.2.2

6. Protect wireless transmissions


6.1 For payment applications using wireless technology, the wireless technology must be
implemented securely. Payment applications using wireless technology must facilitate use of
industry best practices (for example, IEEE 802.11i) to implement strong encryption for
authentication and transmission. Controls must be in place to protect the implemented
wireless network from unknown wireless access points and clients. This includes testing the end
users wireless deployment on a quarterly basis to detect unauthorized access points within the
system. Change wireless vendor defaults, including but not limited to default wireless
encryption keys, passwords, and SNMP community strings. Maintain a detailed updated
hardware list. The end to end wireless implementation must be end to end secure. The use of
WEP as a security control was prohibited as of 30 June 2010. PCI Data Security Standard
Requirements 1.2.3, 2.1.1, 4.1.1, 6.2, 11.1a-e and 11.4a-c.

7. Test payment applications to address vulnerabilities


7.1
Software vendors must establish a process to identify newly discovered security
vulnerabilities (for example, subscribe to alert services freely available on the Internet) and to
test their payment applications for vulnerabilities. Any underlying software or systems that are
Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.
15

provided with or required by the payment application (for example, web servers, third-party
libraries and programs) must be included in this process. PCI Data Security Standard
Requirement 6.2
7.2
Software vendors must establish a process for timely development and deployment of
security patches and upgrades, which includes delivery of updates and patches in a secure
manner with a known chain-of-trust, and maintenance of the integrity of patch and update
code during delivery and deployment.

8. Facilitate secure network implementation


8.1
The payment application must be able to be implemented into a secure network
environment. Application must not interfere with use of devices, applications, or
configurations required for PCI DSS compliance (for example, payment application cannot
interfere with anti-virus protection, firewall configurations, or any other device, application,
or configuration required for PCI DSS compliance). PCI Data Security Standard Requirements 1,
3, 4, 5, and 6.

9. Cardholder data must never be stored on a server connected to the Internet


9.1
The payment application must be developed such that the database server and web
server are not required to be on the same server, nor is the database server required to be in
the DMZ with the web server.
PCI Data Security Standard Requirement 1.3.7.

10. Facilitate secure remote software updates


10.1
If payment application updates are delivered securely via remote access into
customers systems, software vendors must tell customers to turn on remote-access
technologies only when needed for downloads from vendor, and to turn off immediately after
download completes. Alternatively, if delivered via VPN or other high-speed connection,
software vendors must advise customers to properly configure a firewall or a personal firewall
product to secure authentication using a two factor authentication mechanism. PCI Data
Security Standard Requirements 8.3.
10.2 If payment application may be accessed remotely, remote access to the payment
application using a two factor authentication mechanism. PCI Data Security Standard
Requirements 8.3.
10.3
Any remote access into the payment application must be done securely. If vendors,
resellers / integrators or customers can access customers payment applications remotely, the
remote access must be implemented securely. PCI Data Security Standard Requirements 1, 8.3
and 12.3.9.

11. Encrypt sensitive traffic over public networks


11.1
If the payment application sends, or facilitates sending, cardholder data over public
networks, the payment application must support use of strong cryptography and security
protocols such as SSL/TLS and Internet protocol security (IPSEC) to safeguard sensitive
cardholder data during transmission over open, public networks.
Examples of open, public networks that are in scope of the PCI DSS are:
The Internet
Wireless technologies
Global System for Mobile Communications (GSM)

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


16

General Packet Radio Service (GPRS)


PCI Data Security Standard Requirement 4.1
11.2
The payment application must never send unencrypted PANs by end-user messaging
technologies (for example, e-mail, instant messaging, chat). PCI Data Security Standard
Requirement 4.2

12. Encrypt all non-console administrative access


12.1
Instruct customers to encrypt all non-console administrative access using technologies
such as SSH, VPN, or SSL/TLS for web-based management and other non-console administrative
access. Telnet or remote login must never be used for administrative access. PCI Data Security
Standard Requirement 2.3

13. Maintain instructional documentation and training programs for customers,


resellers, and integrators
13.1
Develop, maintain, and disseminate a PA-DSS Implementation Guide(s) for customers,
resellers, and integrators that accomplishes the following:
13.1.1 Addresses all requirements in this document wherever the PA-DSS
Implementation Guide is referenced.
13.1.2 Includes a review at least annually and updates to keep the documentation
current with all major and minor software changes as well as with changes to the
requirements in this document.
13.2
Develop and implement training and communication programs to ensure payment
application resellers and integrators know how to implement the payment application and
related systems and networks according to the PA-DSS Implementation Guide and in a PCI DSScompliant manner.
13.2.1 Update the training materials on an annual basis and whenever new payment
application versions are released.

More Information
VeriFone, Inc. highly recommends that merchants contact the card association(s) or their processing
company and find out exactly what they mandate and/or recommend. Doing so may help merchants
protect themselves from fines and fraud.
For more information related to security, visit:

http://www.pcisecuritystandards.org
http://www.visa.com/cisp
http://www.sans.org/resources
http://www.microsoft.com/security/default.asp
https://sdp.mastercardintl.com/
http://www.americanexpress.com/merchantspecs

CAPN questions: mailto:capninfocenter@aexp.com

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


17

THIS PAGE INTENTIONALLY LEFT BLANK

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


18

Documentation Notes
This manual provides documentation on the installation and usage of eTIM on three major operating
system families: Microsoft Windows, various Linux/Unix flavors, and IBMs i5/OS (which runs
exclusively on the System i). If you are using an operating system that is not covered in this manual,
you should consult your operating systems user guide for specifics on the installation and usage of
Java-based products.

Symbols and Conventions


This manual uses the following symbols to denote information that is specific to a particular operating
system.

For Windows Users


Information pertaining specifically to Windows users will be contained within a box like
this. Users of other systems can safely ignore information contained within in these
sections.

For Linux/Unix Users


Information pertaining specifically to Linux/Unix users will be contained within a box like
this. Users of other systems can safely ignore information contained within in these
sections.

For i5/OS Users


Information pertaining specifically to OS/400 and i5/OS (OS/400 V5R3 and higher) users
will be contained within a box like this. Users of other systems can safely ignore
information contained within in these sections.
The term i5/OS is used in this document to refer to OS/400, i5/OS , and IBM i operating
systems. The terms System i and iSeries 400 may be used interchangeably.
This manual uses the following symbols to denote warnings and notes that are not specific to any
particular operating system.

WARNING
Warnings contain information vital to the subject being discussed. Failure to address the
concepts described in these warnings may result in downgraded per-transaction rates,
serious program errors, unsuccessful transactions, etc.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


19

Note
Notes contain important information separated from the normal flow of information in
order to draw your attention to a concept and/or further clarify an idea.

eTIM Directory
The eTIM default installation directory will be referred to as \<eTIM>\ in this documentation, with
<eTIM> referring to the installation directory that you specify during installation. Unless you provide
an alternate directory path and name, eTIM will be installed in C:\VeriFone\etim on Windows and
in /root/verifone/etim on Linux. You should change the base install directory to /opt so that
eTIM is not installed in the /root directory. On i5/OS, eTIM will be installed on the mapped drive in
/verifone/etim. There is no option to change the install directory for i5/OS.

Slash Style Convention


The back slash (\) will often be used when referring to directories in this documentation. If you are
using a platform that uses a forward slash (/) as a directory indicator (such as Unix or Linux), substitute
the forward slash for the back slash when necessary.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


20

Chapter 1 -- Installation

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


21

Installation Recommendations
We recommend that a System Administrator assists with or performs the eTIM installation. Although
this manual goes into detail about all of aspects of the eTIM installation, it is assumed that the person
performing the installation has a certain amount of knowledge (see the list below) and administrative
rights on the server.
The person installing eTIM will need to perform the following task prior to and during the installation:

Download and install the Java Virtual Machine on the server that will run eTIM. The Java
Virtual Machine is included with the Java 2 Platform, Standard Edition.

Basic Prerequisites
eTIM has the following prerequisites. Detailed information is provided in the installation section for
each operating system.
1. Java 2 Platform, Standard Edition (J2SE) SDK version 1.6 or later
2. TCP/IP support

Initial Teleconference
Prior to performing the installation, it is recommended that you contact VeriFone, Inc. to set up an
initial installation and integration teleconference. This teleconference is designed to familiarize you
with the installation procedure and the integration aspects of eTIM. For VeriFone, Inc. contact
information, refer to the Notice section (see page 2).

Platform Specific Installation Instructions


This chapter provides platform specific installation instructions. See the boxes below for more
information.

For Windows Users


To install eTIM in a Windows environment, follow the instructions starting on page 23.

For Linux/Unix Users


To install eTIM in a Linux/Unix environment, follow the instructions starting on page 31.

For i5/OS Users


To install eTIM in an i5/OS environment, follow the instructions starting on page 40.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


22

eTIM Installation: Windows


For Windows Users
This section outlines the steps necessary to install eTIM on a windows-based server.

Installation Prerequisites
Perform the following prerequisite steps to prepare your Windows server for eTIM. Once the
prerequisites have been met, the eTIM installation, configuration, and integration can begin.
1) Log on to the server as Administrator or equivalent.
The user performing the installation must have permissions to create directory structures on the
server.
2) Install the Java 2 Platform, Standard Edition (J2SE) SDK version 1.6 or later.
The Java Virtual Machine (JVM) version 1.6 or later is required to run eTIM. The JVM is included in
the J2SE SDK.
To find out if you already have the correct JVM installed, go to a command prompt (click Start /
Run and type cmd) and then type:
java version
If the JVM is installed and the executable is in your path, the version of the JVM will be returned. If
you do not have the JVM installed or have an older version, you should download and install the
latest stable J2SE SDK (version 1.6 or later).
The J2SE SDK is available for download from Oracle's web site:
http://www.oracle.com/technetwork/java/javase/downloads/index.html.
After downloading the file, install the J2SE SDK by executing the installation program and following
the default installation prompts. If necessary, refer to the online Java documentation and your
operating systems documentation for help with the installation.

Installation
A GUI-based program called the eTIM Setup is provided to install eTIM. The eTIM Setup is a Java-based
program and requires that Java is installed and is in the servers path.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


23

Starting the eTIM Setup Wizard


1. To start the eTIM Installer, use Windows Explorer or My Computer to browse to the eTIM Setups
root directory. Double-click the file installer.bat.
2. Once the eTIM Setup Wizard has been launched, it prompts to select the Type of Installation: New
Installation or Upgrade Installation
3. Click to select the appropriate Type of Installation.
4. Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


24

5. After selecting the Type of Installation, you will be prompted to Select an Operating System. Click
to select Windows and click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


25

6. One of the following two screens will appear:


a) If you have selected the installation type as New Installation, the Installation Location
screen will appear. eTIM's default installation directory is C:\VeriFone\etim. We
recommend that you install eTIM in the default installation directory. However, if you want to
install to a different directory, use the Browse button. Click Next. The eTIM Installer will now
install eTIM into the directory specified in the box labeled Destination Folder. Throughout this
manual, this directory will be referred to as \<etim>\.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


26

b) If you have selected the installation type as Upgrade Installation, the Upgrade Location
screen appears. The Destination Directory should be the location where you had installed eTIM
previously. Use the Browse button to locate, and Click Next to continue.

Note
The upgrade installation will copy the entire \<etim>\ folder to \<etim_backup>\ and
zip it with the current date as the file name. Your configuration information will be
retrieved for the new installation.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


27

7. After a few moments, the Java Runtime Environment screen will appear with the default JRE path
in the text field. In the event that you want to use a different JRE, use the Browse button to
locate it. Once you have selected the JRE, Click Next to continue.

Note
Sometimes the JRE installs to a directory where the name includes spaces. Long filenames
with spaces do not work properly in scripts. If this is the case, use the DOS 8.3 name of the
directory.
Example: C:\Program Files\ should be referenced as C:\progra~1\.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


28

8. The Confirm Installation screen allows you to review the details of your installation. To change any
of the options, use the Back button. Once you are ready to initiate the installation, click Install.

Once you have initiated the installation, the Setup program will start copying the necessary files to
the selected installation directory. A progress bar will appear, indicating the status of the
installation process, and a text area will display the details of the current process. Note that the
Finish button is disabled during installation.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


29

9. When the installation is complete, a status message will display stating Installation Successful.
Click Finish.

Whats Next?
Now that eTIM is installed on your Windows computer, you are ready to configure eTIM. Skip to
Chapter 2 -- Configuration for information on configuring eTIM.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


30

eTIM Installation: Linux/Unix


For Linux/Unix Users
This section outlines the steps necessary to install eTIM on a Linux-based or Unix-based
server.

Installation Prerequisites
Perform the following prerequisite steps to prepare your Linux/Unix server for eTIM. Once the
prerequisites have been met, the eTIM installation, configuration, and integration can begin.
1. Log on to the server as root or equivalent.
The user performing the installation must have permissions to create directory structures on the
server.
2. Install the Java 2 Platform, Standard Edition (J2SE) SDK version 1.6 or later.
The Java Virtual Machine (JVM) version 1.6 or later is required to run eTIM. The JVM is included in
the J2SE SDK.
To find out if you already have the correct JVM installed, go to a terminal window and then type:
java version
If the JVM is installed and the executable is in your path, the version of the JVM will be returned. If
you do not have the JVM installed or have an older version, you should download and install the
latest stable J2SE SDK (version 1.6 or later).
The J2SE SDK is available for download from Oracle's web site:
http://www.oracle.com/technetwork/java/javase/downloads/index.html.
After downloading the file, install the J2SE SDK by executing the installation program and following
the default installation prompts. If necessary, refer to the online Java documentation and your
operating systems documentation for help with the installation.
Once the J2SE SDK is installed, add the Java bin directory to your path. By default, the J2SE
SDK is installed in the /usr/java/j2sdk1.6.x_xx directory. If necessary, consult your operating
systems documentation for information on adding directories to your path.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


31

Installation
A GUI-based program called the eTIM Setup is provided to install eTIM. The eTIM Setup is a Java-based
program and requires that Java is installed and is in the servers path.

Starting the eTIM Setup Wizard

Note
All commands are case-sensitive.

1. To start the eTIM Installer, change your path to the eTIM Setups root directory.
Next, start the eTIM Setup Wizard by executing the following script file:
./installer.sh
2. Once the eTIM Setup Wizard has been launched, it prompts to select the Type of Installation: New
Installation or Upgrade Installation
3. Click to select the appropriate Type of Installation.
4. Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


32

5. After selecting the Type of Installation, you will be prompted to Select an Operating System, Click
to select Linux and click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


33

6. One of the following two screens will appear:


a) If you have selected the installation type as New Installation, the Installation Location
screen will appear. eTIM's default installation directory is /opt/VeriFone/etim.. However, if
you want to install to a different directory, enter a new directory path or use the Browse
button. Click Next. The eTIM Installer will now install eTIM into the directory specified in the
box labeled Destination Folder. Throughout this manual, this directory will be referred to as
\<etim>\.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


34

b) If you have selected the installation type as Upgrade Installation, the Upgrade Location
screen appears. The Destination Directory should be the location where you had installed eTIM
previously. Use the Browse button to locate.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


35

7. After a few moments, the Java Runtime Environment screen will appear with the default JRE path
in the text field. In the event that you want to use a different JRE, use the Browse button to
locate it. Once you have selected the JRE, Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


36

8. The Confirm Installation screen allows you to review the details of your installation. To change any
of the options, use the Back button. If you are ready to initiate the installation, click Install.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


37

9. Once you have initiated the installation, the Setup program will start copying the necessary files to
the select installation directory. A progress bar will appear, indicating the status of the
installation process, and a text area will display the details of the current process. Note that the
Finish button is disabled during installation.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


38

10. When the installation is complete, a status message will be displayed stating Installation
Successful and the progress bar will be at 100%. At that point, the Finish button will be enabled.

11. Setup has now finished installing eTIM to your computer. Click on Finish.

Whats Next?
Now that eTIM is installed on your Linux/Unix computer, you are ready to configure eTIM. Skip to
Chapter 2 -- Configuration for information on configuring eTIM.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


39

eTIM Installation: i5/OS


For i5/OS Users
This section outlines the steps necessary to install eTIM on a System i server.

Note
The eTIM Setup program must be executed from a Windows workstation. The installation
program will install eTIM Server to the System i Integrated File System (IFS) via the
network. To perform the installation, the Windows workstation must have read/write
access to the System i IFS. Make sure a Windows workstation is available and is set up to
access the System i IFS prior to beginning the steps outlined in this section.

Installation Prerequisites
Perform the following prerequisite steps to prepare your System i server for eTIM. Once the
prerequisites have been met, the installation, configuration, and integration can begin.
1. Log on to the System i as QSECOFR or equivalent.
Although the majority of the installation occurs from a Windows workstation, several commands
must be executed on the System i. The person installing eTIM must have access to the System i
(either via a terminal session or direct access to the System i). This user must be logged in as
QSECOFR or equivalent.
2. Map a drive from Windows to the System i.
You must map a drive from Windows to the System i in order to use the eTIM Setup
programs GUI application (See Step 6).
3. Verify and configure the TCP/IP settings on the System i. TCP/IP must be configured properly if
payment processing will be conducted via the Internet. To verify that TCP/IP is configured
properly, type CFGTCP from the i5/OS command line. Choose option 12, Change TCP/IP
domain information and verify the following:

The Host name and Domain name settings must be properly set.

The Host name search priority must be set to *LOCAL.

The Domain name server (DNS) settings must be set properly. Contact your ISP to obtain the
IP address(es) of your DNS Server(s) and enter them on this screen. Alternatively, if a Windows
workstation on the same network as the System i is configured for Internet connectivity, go to
a command prompt on the Windows workstation and enter the following command:
ipconfig /all
The output from this command will indicate which DNS Server(s) are currently being used on
your network.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


40

4. Verify that Java 1.6 is installed and configured properly on the System i. The Java runtime
environment is installed as part of the licensed programs. To check if the Java runtime
environment is installed properly and to make sure you are running at least version 1.6, type the
following from the command line:
java *version
If the Java runtime environment is installed properly, a message indicating the version should
appear at the bottom of the screen.
If a message does not appear, or the message indicates a version prior to 1.6, make sure that Java
1.6 is installed. If Java 1.6 is installed, and the java *version command returns an earlier
version, use a text editor to update the SystemDefault.properties file that appears in the
/home/<username>/ directory to indicate the following:
java.version=1.6
After updating this file, execute the java *version command again to verify that the proper
version of Java is configured and running properly on the System i.
5. Install the J2SE SDK version 1.6 on a Windows workstation. To run the eTIM Setup program, you
must install the J2SE SDK (which includes the JVM) on the Windows workstation. The eTIM Setup
program is a Java program and requires the JVM to run.
To find out if you already have the JVM installed, go to a command prompt (click Start / Run and
type cmd) and then type:
java version
If the JVM is installed and the executable is in your path, the version of the JVM will be returned. If
you do not have the JVM installed or have an older version, you should download and install the
latest stable J2SE SDK (version 1.6 or later).
The J2SE SDK is available for download from Oracle's web site:
http://www.oracle.com/technetwork/java/javase/downloads/index.html.
After downloading the file, install the J2SE SDK by executing the installation program and following
the default installation prompts. If necessary, refer to the online Java documentation and your
operating systems documentation for help with the installation.
6. On the Windows workstation, map a drive to the System i IFS root directory. Use Windows
Explorer to map the network drive.
a. From Windows Explorer, click Tools | Map Network Drive...
b. Choose a drive letter from the Drive: drop down box (Example: X:).
c. Type in the System is IFS root directorys network address in the Folder: box.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


41

The network address will be in the following format:


\\<400IPAddressOrName>\root
Substitute <400IPAddressOrName> with the IP address or host name of your System i.
Examples:
\\10.127.1.2\root
\\400DevBox\root
d. Click Finish
e. When prompted for your username and password, enter your System i username and
password and then click OK.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


42

Installation
A GUI-based program called eTIM Setup is provided to install eTIM. The eTIM Setup is a Java-based
program and requires that Java is installed and is in the servers path.

Starting the eTIM Setup Wizard


1. To start the eTIM Installer, use Windows Explorer or My Computer to browse to the eTIM Setups
root directory. Double-click the file installer.bat.
2. Once the eTIM Setup Wizard has been launched, it prompts to select the Type of Installation: New
Installation or Upgrade Installation
3. Click to select the appropriate Type of Installation.
4. Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


43

5. After selecting the Type of Installation, you will be prompted to Select the Operating System.
Click to select OS/400 and click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


44

6. The Java Version and Mapped Drive screen will appear. Select the Java Version of your System i
and select the Mapped Drive that is used to connect the System i to Windows. Click Next to
continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


45

7. The Confirm Installation screen allows you to review the details of your installation. To change any
of the options, use the Back button. Once you are ready to initiate the installation, Click Install.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


46

8. Once you have initiated the installation, the Setup program will start copying the necessary files to
the selected installation directory. A progress bar will appear, indicating the status of the
installation process, and a text area will display the details of the current process. Note that the
Finish button is disabled during installation.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


47

9. When the installation is complete, a status message will be displayed stating Installation
Successful and the progress bar will be at 100%. At that point, the Finish button will be enabled.

10. Setup has now finished installing eTIM to your System i computer. Click on Finish.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


48

Note
Setting up a Separate Subsystem from QBATCH
We strongly recommend that you run eTIM and any Device servers in a separate
subsystem from QBATCH:
From the i5/OS command line, type the following to set up the #VFeTIM subsystem
environment:
qsh
<Enter>
cd /VeriFone/etim/utils
iSbuildTIAS400Environment.sh
This will create the following:
VFETIM library
#VFETIM subsystem
VFETIM job queue

Whats Next?
Now that eTIM is installed on your System i computer, you are ready to configure your eTIM. Proceed to
Chapter 2 -- Configuration for information on configuring eTIM.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


49

THIS PAGE INTENTIONALLY LEFT BLANK

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


50

Chapter 2 Configuration

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


51

PAYware Connect eTIM Configuration


The eTIM Configuration Utility is a GUI application that allows integrators and merchants to configure
eTIM for processing transactions. The eTIM Configuration Utility will allow you to input configuration
details such as the Port number to run eTIM, the Primary URL, Secondary URL and Admin URL of
PAYware Connect Server, IP address and Port numbers of the devices, the BIN range for Debit cards,
and other general settings.

Starting the eTIM Configuration Utility


For Windows Users
From your \<eTIM>\ directory, double-click the file wnconfig.bat.

For Linux/Unix Users


Open a terminal session.
Browse to your installation directory (e.g., \<eTIM>\).
Execute the file lxconfig.sh to launch the application.
Note: Ensure that you have execute permission for lxconfig.sh and other lx*.sh
script files.

For i5/OS Users


You must execute the eTIM Configurator from a Windows workstation that is on the same
network as the System i.
To start the eTIM Configurator, in Windows Explorer, browse to the X:\VeriFone\etim
directory (substitute X: with the driver letter of the drive mapped to the System is IFS
root directory) and double-click the following file:
isconfig.bat

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


52

Welcome

The Welcome screen provides basic instruction on how to use the configuration utility. Click on Help to
display the current version of eTIM.
Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


53

Server Configuration

The Server Configuration screen configures the socket server in eTIM.


eTIM allows the user to select the certificate file. This file provides the default SSL keystore and
certificate for the eTIM Server Application's implementation of SSL. To use SSL, a copy of certificate
file selected from the server must also be used by the client program integrating into the server.
If you are attempting to use SSL and don't have a copy of the certificate file in the proper directory,
the following error will appear when trying to start the client:
Couldn't get I/O for the connection to: IPADDRESS:PORT
The eTIM server installation ships with a default Certificate file. We recommend that you change the
keystore and/or certificate distributed with eTIM. To do this, you will need to acquire a certificate and
use the Java keytool application to generate a new keystore. Refer to Sun's web site for more
information on the Java keytool.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


54

Server Configuration Settings


Property Name

Description

Listening Port

Type the TCP port where eTIM server will wait for connections from the POS.
Default = 5015

Monitor Port

Type the TCP port that the GUI launcher utility can use to monitor eTIM servers status.
Default = 5016

Use SSL

Check to enable SSL on the Listening Port.


Default = Unchecked

SSL Certificate File Path

Enter or browse to select the relative path to the .cer or .jks used to enable SSL
connectivity.
Default = blank or ./certs/etimcert.cer

SSL Certificate Algorithm

Type the algorithm used to secure connections to eTIM server.


Default = SunX509

Key Pair Entry Password

Type the password used to open the certificate for SSL.

Key Store Password

Type the password used to open the Key Store containing the certificates.

Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


55

PAYware Host Configuration

PAYware Host Configuration Settings

Note
Consult your PAYware Connect validation letter to obtain the URL Settings required.

Primary URL Settings - Enter the PAYware Connect URL that will be used to process regular
transactions.

Secondary URL Settings Enter the PAYware Connect Secondary URL. The Secondary URL is
used when Primary URL is not able to connect to the host.

Admin URL Settings Enter the Admin URL. The Admin URL is used to load SERIAL_NUM and
DEVICEKEY of the Client ID.

Connection Timeout: Enter Connection Timeout for each URL. The Connection Timeout is the
time interval within which the connection with the host should be established.

Response Timeout: Enter Response Timeout for each URL. The Response Timeout is the time
interval in which the response from the host should happen before the Response Timeout.

Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


56

PAYware Global Configuration

Scroll Down to display more optional fields.


If you wish to set the Properties for all payment transactions for all Client IDs, they may be set here.
Example: If you wish to allow Cashback for all of your Client IDs, you can set Allow Cashback to true.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


57

Client ID Global Settings

Note
Most of the Global settings will default and do not need to be entered.

Property Name

Description
Payment Settings

Allow Manual Data Entry

Select TRUE if you wish to allow manual entry of the account number. You will also be
prompted for expiration date and zip code. Refer to BadMagReadMsgBox=<value>
setting in config.usr1 on MX Series device.

Show Negative Amount for


Refund

Select TRUE if Credit/Refund amount should display as a negative value on the MX Series
device.

Payment Transaction Flow

Select to re-order payment steps. See section Payment Transaction Flow (page 88).

WARNING: Contact Support before making changes to payment transaction flow.


Credit Settings
Accept POS Payment Type
Setting

Select FALSE to prompt cardholder to select payment type. Select TRUE to prompt
cardholder to confirm amount.

Track Data Order Preferences

Select track order preference to send to PAYware Connect. If using VeriShield Protect,
TRACK2-TRACK1 (2-1) is recommended for VeriShield Protect activation.

Require Signature Capture

Select TRUE to enable eTIM to prompt for signature on all approved / captured credit
card transactions.

VOID on Signature Cancel

Select TRUE to enable eTIM to send a void request when customer cancels at the signature
prompt.
NOTE: Credit card VOIDs must be enabled in the API application validation configuration; if
not, it will result in error.
NOTE: The following apply to Payment Transaction Flow steps.
If Submit Payment is before Prompt for Signature and Void on Signature Cancel is TRUE:
When customer cancels, eTIM sends void request (the transaction already submitted).
If Submit Payment is after Prompt for Signature and Void on Signature Cancel is TRUE:
When customer cancels, it is just a cancellation. No VOID is sent (or required).

Signature Status in Response

Select TRUE to include status of signature upload in transaction response.

Store Signature Files

Select FALSE to turn off storing signatures. Default is TRUE. If TRUE, signature files will be
stored as .bmp files in \html\signatures.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


58

Property Name

Description

Manual Entry requires ZipCode

Select TRUE to require entry of cardholder billing postal code for all keyed payment card
transactions.

Bypass Exp Date Private Label

Select TRUE to bypass expiration date prompt when doing Private Label manual sale
transactions.
Debit Settings

Allow Cashback

Select TRUE if you wish to allow Debit cardholders to request Cashback amount from the
Device. See example on next page.

Cashback Entry Mode

Select CARDHOLDER or PRE_CONFIGURED

Cashback Max Amount

Enter if CARDHOLDER is selected as Cash Back Entry Mode and you wish to configure a
maximum cash back amount.

Cashback Amount 1

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. Five values must be
configured and will be presented as selectable options (buttons) from which the cardholder
can select the desired cash back amount.

Cashback Amount 2

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 3

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 4

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 5

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Debit Lookup Floor Amt

Enter the minimum transaction amount required for a BIN lookup to change the transaction
type from CREDIT to DEBIT.

Prompt for Swipe on Reversal

Select TRUE to prompt the user to swipe card and enter PIN for debit REVERSAL transactions
that include the TROUTD or CTROUTD tag.
EBT Settings

Allow Cashback

Select TRUE if you wish to allow Debit cardholders to request Cashback amount from the
Device. See example on next page.

Cashback Entry Mode

Select CARDHOLDER or PRE_CONFIGURED

Cashback Max Amount

Enter if CARDHOLDER is selected as Cash Back Entry Mode and you wish to configure a
maximum cash back amount.

Cashback Amount 1

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. Five values must be
configured and will be presented as selectable options (buttons) from which the cardholder
can select the desired cash back amount.

Cashback Amount 2

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 3

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 4

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 5

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Prompt for Swipe on Void

Select TRUE to prompt the user to swipe card on an EBT VOID transaction.
Gift Settings

Track Data Order Preferences

Select track order preference to send to PAYware Connect

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


59

Allow Cashback Example (CARDHOLDER Cash Back Entry Mode)

Allow Cashback Example (PRE_CONFIGURED Cash Back Entry Mode)

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


60

Once you have configured the Global Settings for all of your Client IDs, click Next to add all of the
Client IDs.

Client ID Configuration
To Configure a Client ID, click Add.
To Edit a Client ID configuration, select the complete row of the device that you want to edit and click
Edit to start editing.
To Delete a Client ID, select the complete row and click Delete to delete the device configuration.
The Client ID Settings screen will allow you to configure your PAYware Connect Client IDs.
Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


61

Enter your Client ID.


Click Show Local Settings to configure local settings for your Client ID.

Note
This local settings configuration should only be used when your Client ID needs a
configuration that is different from the global (or default) configuration.

Now you can configure your local settings for that particular Client ID (see table next page). The fields
that are marked as (use global) will use the configured values within the global settings.
Example:
If Allow Cashback is set to true in the global settings and if the value here is (use global) then
the Client ID will use the global setting and allow Cashback.
At this point, the configurator will require a Device key load.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


62

Client ID Local Settings

Note
This local settings configuration should only be used when your Client ID needs a
configuration that is different from the global (or default) configuration. The fields that
are marked as (use global) will use the configured values within the global settings

Property Name

Description
Payment Settings

Allow Manual Data Entry

Select TRUE if you wish to allow manual entry of the account number. You will also be
prompted for expiration date and zip code. Refer to BadMagReadMsgBox=<value>
setting in config.usr1 on MX Series device.

Show Negative Amount for


Refund

Select TRUE if Credit/Refund amount should display as a negative value on the MX Series
device.

Payment Transaction Flow

Select to re-order payment steps. See section Payment Transaction Flow (page 88).

WARNING: Contact Support before making changes to payment transaction flow.


Credit Settings
Accept POS Payment Type
Setting

Select FALSE to prompt cardholder to select payment type. Select TRUE to prompt
cardholder to confirm amount.

Track Data Order Preferences

Select track order preference to send to PAYware Connect. If using VeriShield Protect,
TRACK2-TRACK1 is required for VeriShield Protect activation.

Require Signature Capture

Select TRUE to enable eTIM to prompt for signature on all approved / captured credit
card transactions.

VOID on Signature Cancel

Select TRUE to enable eTIM to send a void request when customer cancels at the signature
prompt.
NOTE: Credit card VOIDs must be enabled in the API application validation configuration; if
not, it will result in error.
NOTE: The following apply to Payment Transaction Flow steps.
If Submit Payment is before Prompt for Signature and Void on Signature Cancel is TRUE:
When customer cancels, eTIM sends void request (the transaction already submitted).
If Submit Payment is after Prompt for Signature and Void on Signature Cancel is TRUE:
When customer cancels, it is just a cancellation. No VOID is sent (or required).

Signature Status in Response

Select TRUE to include status of signature upload in transaction response.

Store Signature Files

Select FALSE to turn off storing signatures. Default is TRUE. If TRUE, signature files will be
stored as .bmp files in \html\signatures.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


63

Property Name

Description

Manual Entry requires ZipCode

Select TRUE to require entry of cardholder billing postal code for all keyed payment card
transactions.

Bypass Exp Date Private Label

Select TRUE to bypass expiration date prompt when doing Private Label manual sale
transactions.
Debit Settings

Allow Cashback

Select TRUE if you wish to allow Debit cardholders to request Cashback amount from the
Device. See example on next page.

Cashback Entry Mode

Select CARDHOLDER or PRE_CONFIGURED

Cashback Max Amount

Enter if CARDHOLDER is selected as Cash Back Entry Mode and you wish to configure a
maximum cash back amount.

Cashback Amount 1

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. Five values must be
configured and will be presented as selectable options (buttons) from which the cardholder
can select the desired cash back amount.

Cashback Amount 2

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 3

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 4

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 5

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Debit Lookup Floor Amt

Enter the minimum transaction amount required for a BIN lookup to change the transaction
type from CREDIT to DEBIT.

Prompt For Swipe on Reversal


with TROUTD or CTROUTD

Select TRUE to prompt the user to swipe card and enter PIN for debit REVERSAL transactions
that include the TROUTD or CTROUTD tag.
EBT Settings

Allow Cashback

Select TRUE if you wish to allow Debit cardholders to request Cashback amount from the
Device. See example on next page.

Cashback Entry Mode

Select CARDHOLDER or PRE_CONFIGURED

Cashback Max Amount

Enter if CARDHOLDER is selected as Cash Back Entry Mode and you wish to configure a
maximum cash back amount.

Cashback Amount 1

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. Five values must be
configured and will be presented as selectable options (buttons) from which the cardholder
can select the desired cash back amount.

Cashback Amount 2

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 3

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 4

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Cashback Amount 5

Enter if PRE_CONFIGURED is selected as Cash Back Entry Mode. See above.

Prompt For Swipe on Void

Select TRUE to prompt the user to swipe card on an EBT VOID transaction.
Gift Settings

Track Data Order Preferences

Select track order preference to send to PAYware Connect

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


64

Click Device Key.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


65

Enter User ID and User Password.


Click Load Key.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


66

If key load is successful, a screen similar to the following will display:

You have now registered your device with PAYware Connect.


If you wish to enable VSP with the device, you must log in to the PAYware Connect Store Portal.
See PAYware Connect Store Portal Manual, Appendix A POS Devices for more information.
Click Next.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


67

Device Global Settings

Click to select device type for which you wish to change configuration settings.
Click Next to continue to Device Result Settings.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


68

MX Series Device Configuration

Note

Note

The term MX Series device, as it is used in this documentation, applies to the MX 880, MX
870, MX 860, MX 850, MX 830, MX 760, MX 915, and MX 925. Examples shown for the MX 880
device are for illustration purposes and would apply to all MX Series devices.

The MX Series device must be configured as a TCP/IP Client using an editor like Unix VI.
Two files in the MX 870/MX 850/MX 830 must be edited.
To enable the TCP/IP setting, ensure the config.usr1 file in /mnt/sram has the
following five parameter settings:
1.
2.
3.
4.
5.

commtype=TCPIP
formnameinevent=1
server=1
termprt=9001
ifconfig=eth0 <ip-address> netmask <net-mask>
Example:

ifconfig=eth0 010.064.080.170 netmask 255.255.0.0


One parameter must be set in /home/usr1/.profile:
export BUTTON_ACTION_ON_RELEASE=1

Note
Follow the steps below to enable TCP/IP on MX 915 and MX 925 devices.
Tap the Administration tab on the System Mode screen. Tap the Communication tab. Tap
Network and then Ethernet. Choose DHCP or StaticIP.
If you choose DHCP, then the device will automatically go and get an IP address.
commtype=TCPIP should be selected by default in the FORMAgent/ETIM Forms load.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


69

<Scroll Down> to display more fields.


If you wish to set the Properties for all MX 880 Devices, they may be set here.
Example: If you wish to allow VSP Enabled for all of your MX 880 Devices, you can set VSP Enabled to
true.

Note
Newly configured Global Settings are not loaded by the Direct Device Test (see page 124).
They only apply when running transactions through the eTIM server.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


70

MX Series Device Global Settings

Note
Most of the Global settings will default and do not need to be entered.

Property Name

Description
Card Swipe Settings

VSP Enabled

Select TRUE to enable VSP

Max Bad Card Swipes

The maximum amount of times a card swipe can fail

Track1 Start Sentinel

The sentinel that indicates the start of the Track1 Data

Track1 Format Code

The Track1 format code

Track1 End Sentinel

The sentinel that indicates the end of the Track1 Data

Track1 Account Separator

The separator that indicates the start of the account number in Track1 Data

Track1 Cardholder Name


Separator

The separator that indicates the start of the card holder name in Track1 Data

Track2 Start Sentinel

The sentinel that indicates the start of the Track2 Data

Track2 End Sentinel

The sentinel that indicates the end of the Track2 Data

Track2 Account Separator

The separator that indicates the start of the account number in Track2 Data
Device Application Settings

Show Result Timeout

The maximum time (in seconds) to display the result on the device

Read Block Timeout

The time (in seconds) eTIM will wait for an event from the MX Series device. Min 30 and
Max 180 (default). BLOCK_TIMEOUT in the request will override this setting.

Prompt for Payment Type

Select from Debit, EBT, Gift, and Priv Lbl


Signature Settings

Start X Co-ordinates

Change default signature box area for display. Here you can set merchants preferred
settings that will apply to all devices of this type. These settings take priority over
default/general settings that are contained in the devicetype.properties file. The
new settings would be contained in the device.properties file.
NOTE: Start X Co-ordinates = top left position of signature area

Start Y Co-ordinates

Change default signature box area for display. Here you can set merchants preferred
settings that will apply to all devices of this type. These settings take priority over
default/general settings that are contained in the devicetype.properties file. The
new settings would be contained in the device.properties file.
NOTE: Start Y Co-ordinates = top left position of signature area

End X Co-ordinates

Change default signature box area for display. Here you can set merchants preferred
settings that will apply to all devices of this type. These settings take priority over
default/general settings that are contained in the devicetype.properties file. The
new settings would be contained in the device.properties file.
NOTE: End X Co-ordinates = top right position of signature area

End Y Co-ordinates

Change default signature box area for display. Here you can set merchants preferred
settings that will apply to all devices of this type. These settings take priority over
default/general settings that are contained in the devicetype.properties file. The
new settings would be contained in the device.properties file.
NOTE: End Y Co-ordinates = lower left position of signature area

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


71

Once you have configured the Global Settings for all of your MX Series devices, click Close to return to
the Device Global Settings screen.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


72

Device Result Settings


When you click Next from the Device Global Settings screen, the following Device Result Settings
screen appears:

Here you can configure Actual Result Text with user-friendly custom Device Displayed Text responses.
The custom responses will be shown on the device Result Form.
Example: If the merchant wishes to display TRANSACTION APPROVED instead of the RESULT response
CAPTURED, that translation would be configured here.
Click Next.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


73

Device Inventory

To Add a new device, click Add (see page 75).


To Edit a device configuration, click to select its row and click Edit (see page 76).
To Delete a device configuration, click to select its row and click Delete.
To Convert a device, click to select its row and click Convert (see page 77).
Click Next to proceed to Bin Range Configuration (see page 78).

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


74

Add Device
If you choose to Add a device, you will be presented with the following:

Using the drop-down arrow, choose the device type. Next, type your device IP Address and its TCP
Port number.
Click Create to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


75

Edit Device
To edit device settings, click to highlight the row of the device you wish to edit in the Device
Inventory. Click Edit.
If you choose to Edit a device, you will be presented with the following:

Note
This device configuration should only be used when your device needs settings that differ
from the global (or default) configuration.

You will be presented with Device Settings.


Now you can configure your optional fields for that particular device and use it. The fields that are
marked as (use global) will use the configured values within the global settings.
Example:
If VSP Enabled is set to false in the global settings and if the value here is (use global) then the
device will use the global setting of VSP not enabled.
Click Update to update the device configuration and return to Device Inventory.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


76

Convert Device
To Convert from one device type to another, click on the Convert button. A dialog box appears. Select
the target device type from the drop-down box.

WARNING
Configure the target device type to avoid undesired behavior. Settings do not carry over
automatically from Global Device Type settings. For example, if VSP is enabled on the
current device type, users need to configure Global settings for the new device type to
enable VSP.

Click Convert.
A Confirmation dialogue box will appear if the target device types global configuration is at Default
settings.

Click Yes to continue conversion and configure later, or click No to return to Device Inventory.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


77

BIN Range Configuration

BIN Range configuration encourages Debit transactions. Once a debit range is configured, eTIM will no
longer prompt the user to select the Payment Type (e.g., CREDIT or DEBIT). Instead, it prompts for
the PIN directly, hence benefiting the merchant by Debit Encouragement.
To Add a debit range, click Add.
To Edit a range, select the complete row of the debit range that you want to edit and click Edit.
To Delete a range, select the complete row and click Delete to delete the debit range.
Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


78

If you choose to Add a BIN Range Configuration, you will be presented with the following:

BIN Range Configuration

Low Prefix - The starting few numbers of the card

High Prefix - The ending few numbers of the card

PAN Length - The length of the card

Card Type Label Select Card Type Label from drop-down list. Example: Visa Purchasing

Card Type Select Card Type from drop-down list. Example: VI - P

Click Add, and then Click Next.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


79

Receipt Settings
The following Receipt Settings screen appears:

To configure the receipt format, select one of the options provided on this panel.

Note
The receipt template selected will be used for all accounts.

Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


80

If the template you have selected can be customized, a Receipt Template Configuration screen
similar to one of the following is displayed:

Configure the respective settings for the receipt.

Note
You are required to enter all three of the receipt template settings.

Click Save to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


81

Configuration Saved
The following Confirmation panel displays to overwrite configuration data:

Click Yes if you wish to save the configuration data.


Once the configuration is saved, the eTIM Configuration Utility shows the configuration completed in a
text area for review.

Click Finish to begin processing transactions through the configured devices.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


82

Chapter 3 Launching eTIM

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


83

Launching eTIM using the command line scripts


eTIM can be started using the command line scripts that are generated during the installation. To
launch the server and process transactions, the following must be started:

eTIM (MX Series devices will be included in the startup of eTIM.)

For Windows Users


To start eTIM:
From your \<eTIM>\ directory:
Double-click the file wnstarteTIMserver.bat (to start eTIM PAYware Connect)

For Linux/Unix Users


Open a terminal session.
Browse to your installation directory (e.g., \<eTIM>\)
eTIM should be started individually under Linux.
Execute the file lxstarteTIMserver.sh (to start eTIM PAYware Connect)

For i5/OS Users


We strongly recommend that you run eTIM and any Device servers in a separate
subsystem from QBATCH. The instructions for setting up the #VFeTIM subsystem
environment can be found in Chapter 1 Installation (See page 49).
The isstarteTIMcmd.sh script is used to:
Start the #VFeTIM subsystem on the System i
Submit the eTIM job, eTIM_SERV
o When the eTIM Server job starts, it connects to the configured devices such as
MX 870
qsh
<Enter>
cd /VeriFone/eTIM
isstarteTIMcmd.sh (to start eTIM PAYware Connect)
The isstopeTIMserver.sh script is used to:
Stop and Exit the eTIM server
End the #VFeTIM subsystem
qsh <Enter>
cd /VeriFone/eTIM
isstopeTIMserver.sh
Alternative option:
isstarteTIMserver.sh: This script starts the eTIM Server. Merchants can submit this
script to a subsystem of their choice. This script is available to all merchants.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


84

Launching eTIM using the GUI based launcher


The eTIM GUI Launcher is a GUI based application used to start eTIM - with the click of a button. This
launcher also enables the user to shut down the servers gracefully and to edit the classpath if
additional jars are needed for execution.

For Windows Users


From your \<eTIM>\utils directory, double-click the file wnlauncher.bat.

For Linux/Unix Users


Open a terminal session.
Browse to your \<eTIM>\utils directory.
Execute the file lxlauncher.sh.
Note: Ensure that you have execute permission for lxlauncher.sh.
A sample screen shot of the eTIM Launcher GUI is shown below. Note that the classpaths for eTIM
Server are automatically populated:

The text area will serve as console windows to eTIM server. The user may use the Launch eTIMServer
button to start eTIM .The respective Stop button can be used to terminate the server.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


85

THIS PAGE INTENTIONALLY LEFT BLANK

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


86

Chapter 4 Transaction Processing

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


87

Payment Transaction Flow


Overview
An eTIM PAYMENT transaction potentially has nine stages:

Borrow Device
Payment Media
Payment Type
Payment Details
Confirm Amount
Submit Payment
Capture Signature
Upload Signature
Return Device

etimsystem.log identifies these actions when in DEBUG mode.

Note
The current rules for payment flow are as follows:
Payment Details must be before Confirm Amount
Payment Media must be before Payment Details
Payment Type, Payment Media, Confirm Amount, and Payment Details must be
before Submit Payment
Payment Type must be before Capture Signature
Capture Signature and Submit Payment must be before Upload Signature

Transaction Stages
Borrow Device
eTIM will borrow the requested device from its internal device pool. If the device configuration has
changed since the last transaction, eTIM will reload this information before proceeding.
If the DEVICEIP and DEVICEPORT are not present, eTIM will short-circuit the payment transaction
flow by immediately submitting the transaction to PAYware Connect and returning the response.

Payment Media
eTIM collects the Payment Media if it is not present. During this stage, eTIM will determine if the
command requires a Card Swipe/Tap and collects it if not present. If BIN management is set up, eTIM
will attempt to determine the Payment Type based on the card BIN range.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


88

If ETIM_MODIFIER MANUAL_ENTER has been included in the transaction, eTIM will attempt to collect
the account number and expiration date on the device.
The following Payment Type/Command combinations will prompt for a Card Swipe on the device:
Credit / Unknown

SALE
CREDIT
PRE_AUTH
POST_AUTH
VOICE_AUTH

Debit

SALE
CREDIT
BALANCE
PRE_AUTH
VOID (if set in configuration)

SALE
CREDIT
RETURN
VOID (if set in configuration)
POST_AUTH
BALANCE

SALE
CREDIT
RETURN
PRE_AUTH
BALANCE
ADD_VALUE
REMOVE_VALUE
ACTIVATE
DEACTIVATE
REACTIVATE
REGISTER
GIFT_CLOSE

EBT

Gift

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


89

Payment Type
eTIM prompts the customer for the Payment Type if it is not known or if eTIM has been configured not
to Accept POS Payment Type of Credit.

Payment Details
eTIM will attempt to collect additional details about the payment method such as the EBT Type, PIN,
and Cashback Amount. The actions taken here differ by Payment Type.
Credit
eTIM will prompt for the Customer Zip code.
Debit
eTIM will prompt for the PIN on the device. If the Payment Type was determined through a card BIN
range lookup, the customer can press the Cancel key on the device to select Credit.
If Cashback is configured, eTIM will prompt for the Cashback Amount on the device.
EBT
If the transaction is not a POST_AUTH, eTIM will prompt for the EBT Type. If Cash Benefits is selected,
eTIM will prompt for the Cashback Amount.
Gift
eTIM takes no additional actions.

Confirm Amount
eTIM prompts the customer to confirm the amount.
The following commands will never prompt to Confirm Amount:

BALANCE
ACTIVATE
DEACTIVATE
COMPLETION
GIFT_CLOSE
REACTIVATE
REGISTER

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


90

REVERSAL
VOID

Submit Payment
eTIM adds authentication information to the transaction and submits the transaction to PAYware
Connect.

Capture Signature
eTIM prompts the customer for signature on the device if the follow conditions are true:

Device is capable of signature capture


Signature Capture is enabled in the configuration
Payment Type is Credit
Result from PAYware Connect is APPROVED or CAPTURED

Note
eTIM can be configured to automatically attempt a VOID transaction when the customer
presses Cancel on the device.

Upload Signature
eTIM will send the captured signature data and the TROUTD of the transaction to PAYware Connect. If
no signature data was captured, eTIM will skip this step.

Return Device
eTIM will return the requested device to its internal device pool. If the device configuration has
changed since the beginning of the transaction, eTIM will reload this information. eTIM will also
initialize the device to its idle screen, at this time, prior to making it available for subsequent
transactions.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


91

Payment Processing Workflow Diagram

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


92

MX Series Device Transaction Processing


The transaction processing with MX Devices for Enterprise Terminal Interface Manager is as follows:
The MX device moves automatically to the Please Swipe Card form as soon as the cashier/POS
application sends the transaction to eTIM.

Please Swipe Card

If the Cancel button is clicked:


Cancels the transaction that has been initiated by the cashier/POS.
If the Cardholder swipes the card:
BIN lookup is performed if BIN management feature is enabled.
o Displays the Enter PIN form if account number falls in the configured Debit BIN range.
o Displays the Select Payment Type form if account number doesnt fall in the
configured BIN range.

If the BIN manager feature is not enabled, displays Select Payment Type form

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


93

Manually Keyed Entry

The above form appears when there is a bad card read:


If the CANCEL button is clicked:
Cancels the transaction that has been initiated by the cashier/POS.
Type the account number on the key pad and click ENTER:
Displays the Enter Expiration Date form.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


94

Enter Expiration Date

The above form appears when the account number is manually keyed:
If the CANCEL button is clicked:
Cancels the transaction that has been initiated by the cashier/POS.
Type the expiration date in MMYY format on the key pad and click ENTER:
Displays the Enter Zip Code form.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


95

Enter Zip Code

The above form appears when the account number is manually keyed:
If the CANCEL button is clicked:
Cancels the transaction that has been initiated by the cashier/POS.
Type the zip code in MMYY format on the key pad:
Displays the Is Amount Correct? form.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


96

Select Payment Type

The above form appears when the cardholder swipes the card on the Please Swipe Card form:
If Gift card option is not enabled.
If the Cancel button is clicked:
Cancels the transaction that has been initiated by the cashier/POS.
If the Debit button is clicked:
Displays the Enter PIN form.
If the EBT button is clicked:
Displays the Enter PIN form.
If the Credit button is clicked:
Displays the Is Amount Correct? form.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


97

Select Payment Type (Gift Enabled)

The above form appears when the cardholder swipes the card in Please Swipe Card form:
If Gift card option is enabled.
If the Cancel button is clicked:
Cancels the transaction that has been initiated by the cashier/POS.
If the Debit button is clicked:
Displays the Enter PIN form.
If the EBT button is clicked:
Displays the Enter PIN form.
If the Credit button is clicked:
Displays the Is Amount Correct? form.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


98

Enter PIN

The above form displays:


If the transaction sent from the POS is Credit and BIN manager (if enabled) determines the card
number received from the swipe data is Debit.
If the transaction sent from the POS is Debit
If the transaction sent from the POS is EBT

Note

The PIN number may be 4 12 digits.

If the cardholder hits the red CANCEL button before entering a PIN:
If the transaction sent from the POS was Credit and BIN manager prompted for a PIN, the
device prompts for CREDIT or DEBIT. The buyer has the option of choosing a payment type of
CREDIT rather than DEBIT for the purchase, or the buyer can re-select DEBIT and continue with
the purchase. The buyer also has the option to press the red CANCEL button again to cancel the
transaction.
If the transaction sent from the POS was Debit or EBT, it cancels the transaction initiated by
the cashier/POS.
Once the cardholder begins entering the PIN number, the CLEAR button will appear, which allows
the cardholder to clear and re-enter the PIN if needed.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


99

Do you Want Cashback?

The above form is displayed:


When the cardholder enters the PIN on the Enter PIN form and hits the ENTER button.
If the device is configured to allow Cashback.
If Yes button is clicked:
Enter Cashback Amount form is displayed.
If No button is clicked:
Displays the Is Amount Correct? form if the cashier/POS has set the transaction amount.
If Cancel button is clicked:
Cancels the transaction that has been initiated by the cashier/POS.
Returns to Please Swipe Card form

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


100

Enter Cashback Amount

The above form is displayed:


If the cardholder selects Yes in Do you want Cashback? form.
Allow Cashback is true in Client ID Global Settings
Cash Back Entry Mode is CARDHOLDER in Client ID Global Settings
If the cardholder hits the CLEAR button:
Clears the amount entered (similar to <Backspace>)
If the cardholder reaches this form and does not wish to enter cashback:
Leave amount at 0.00 and click ENTER

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


101

Select Cashback Amount

Note

The Select Cashback Amount form applies to pre-configured cashback amounts.

The above form is displayed:


If the cardholder selects Yes in Do you want Cashback? form.
Allow Cashback is true in Client ID Global Settings
Cash Back Entry Mode is PRE_CONFIGURED in Client ID Global Settings
If the cardholder reaches this form and does not wish to enter cashback:
Click the NONE button.
To cancel the transaction initiated by the cashier/POS:
Click the Cancel button.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


102

Is Amount Correct?

If Yes button is clicked:


The device moves to Result form.
If No button is clicked:
Cancels the transaction that has been initiated by the cashier/POS.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


103

Result
After the transaction is processed, the result is displayed in the following form.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


104

Chapter 5 Integration

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


105

Sample PAYware Connect Transactions


VSP Activate Card
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>SALE</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<DEVICEIP>10.64.106.82</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<CMRCL_FLAG>P</CMRCL_FLAG>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<ACCT_NUM>5***********6398</ACCT_NUM>
<CARDHOLDER>CMD GenNewKeys
H0))K1</CARDHOLDER>
<ENTRY_MODE>SWIPED</ENTRY_MODE>
<PRESENT_FLAG>3</PRESENT_FLAG>
<RESPONSE_TEXT>New Keys Posted</RESPONSE_TEXT>
<RESULT>DECLINE</RESULT>
<RESULT_CODE>904</RESULT_CODE>
<TERMINATION_STATUS>NOT_PROCESSED</TERMINATION_STATUS>
<VSP_CODE>904</VSP_CODE>
<VSP_RESULTDESC>New Keys Posted</VSP_RESULTDESC>
<VSP_TRXID>634774520553436788</VSP_TRXID>
</RESPONSE>

Credit Card Sale


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>SALE</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<DEVICEIP>10.64.106.82</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<CMRCL_FLAG>P</CMRCL_FLAG>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<ACCT_NUM>5***********4507</ACCT_NUM>
<AUTH_CODE>TAS036</AUTH_CODE>
<CARDHOLDER>SUPPLIED/NOT
</CARDHOLDER>
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>SALE</COMMAND>
<CTROUTD>219</CTROUTD>
<ENTRY_MODE>SWIPED</ENTRY_MODE>
<INTRN_SEQ_NUM>2996700</INTRN_SEQ_NUM>
<LPTOKEN>7342</LPTOKEN>
<MIMETYPE>image/tiff</MIMETYPE>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


106

<PAYMENT_MEDIA>MC</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PRESENT_FLAG>3</PRESENT_FLAG>
<REFERENCE>219117502542</REFERENCE>
<RESPONSE_TEXT>APPROVAL TAS036 </RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<SIGNATUREDATA>Qk1eBQAAAAAAAD4AAAAoAAAA6AAAACkAAAABAAEAAAAAACAFAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAP///wD///////////////////////////////////////////8
AH/////////////wH////////////////////////+P/h////////////g/gf//////////
/////////////n//4f//////////x//+H//////////////////////9///+P/////////+
////h//////////////////////v////H/////////3////4f//////AD////////////+/
////P////////+/////+P/////j/wP///////////7/////x////////7//////H////9//
/A///////////v/////5////////v//////n////v///8P/////////+//////z///////9
///////j///+/////H/////////7//////8f//////3///////z///9/////j/////////v
//////+f//////f///////x///3/////z/////////f//////+f/////9////////5///f/
////x////////9///////+f/////3////////5//+//////5////////7///////+f/////
v////////5//7//////5////////v///////+P////+/////////5//3//////z////////
f////////P////7/////////5//f//////8f//////+/////////P////v/////////5/+/
//////+P//////7/////////P////f/////////5/7////////P//////3/////////P///
9//////////5/3////////P//////v/////////P///7//////////5/f////////P/////
+//////////P///v//////////5+/////////P/////9//////////P///f//////////59
/////////f/////3//////////P//+///////////57////////+//////v//////////P/
/7///////////5v////////9//////f//////////P//3///////////7f/////////////
/+///////////P//f///////////y///////////////9///////////P/+////////////
w///////////////7///////////P/7////////////x///////////////3///////////
P/3////////////z///////////////v///////////P/f////////////n////////////
///f///////////P+/////////////H//////////////+////////////P9///////////
/+v//////////////9////////////P3////////////9f//////////////7//////////
//fv////////////4///////////////z///////////+ff////////////5///////////
////z///////////8//////////////z///////////////z///////////+b//////////
///////////////////////////////+X//////////////////////////////////////
///+P//////////////////////////////////////////////////////////////////
/</SIGNATUREDATA>
<SIGNATURE_FILE>signatures/2996700.bmp</SIGNATURE_FILE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2012.07.09</TRANS_DATE>
<TRANS_SEQ_NUM>4</TRANS_SEQ_NUM>
<TRANS_TIME>13:30:56</TRANS_TIME>
<TROUTD>2996700</TROUTD>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>634774521473099794</VSP_TRXID>
</RESPONSE>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


107

Credit Card Sale (Manual Entry on Payment Device)


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>SALE</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<DEVICEIP>10.64.106.82</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<ETIM_MODIFIER>MANUAL_ENTER</ETIM_MODIFIER>
<CMRCL_FLAG>P</CMRCL_FLAG>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<ACCT_NUM>4********8881</ACCT_NUM>
<AUTH_CODE>TAS044</AUTH_CODE>
<AVS_CODE>Z</AVS_CODE>
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>SALE</COMMAND>
<CTROUTD>220</CTROUTD>
<ENTRY_MODE>KEYED</ENTRY_MODE>
<INTRN_SEQ_NUM>2996725</INTRN_SEQ_NUM>
<LPTOKEN>64</LPTOKEN>
<MIMETYPE>image/tiff</MIMETYPE>
<PAYMENT_MEDIA>VISA</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PRESENT_FLAG>2</PRESENT_FLAG>
<REFERENCE>219117502558</REFERENCE>
<RESPONSE_TEXT>ZIP MATCH </RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<SIGNATUREDATA><<See Example Above>></SIGNATUREDATA>
<SIGNATURE_FILE>signatures/2996725.bmp</SIGNATURE_FILE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2012.07.09</TRANS_DATE>
<TRANS_SEQ_NUM>5</TRANS_SEQ_NUM>
<TRANS_TIME>13:32:21</TRANS_TIME>
<TROUTD>2996725</TROUTD>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>634774522316314921</VSP_TRXID>
</RESPONSE>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


108

Credit Card Pre-Authorization


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>PRE_AUTH</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<DEVICEIP>10.64.106.82</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<ACCT_NUM>5***********4507</ACCT_NUM>
<AUTH_CODE>TAS053</AUTH_CODE>
<CARDHOLDER>SUPPLIED/NOT
</CARDHOLDER>
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>PRE_AUTH</COMMAND>
<CTROUTD>221</CTROUTD>
<ENTRY_MODE>SWIPED</ENTRY_MODE>
<INTRN_SEQ_NUM>2996736</INTRN_SEQ_NUM>
<LPTOKEN>7342</LPTOKEN>
<MIMETYPE>image/tiff</MIMETYPE>
<PAYMENT_MEDIA>MC</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PRESENT_FLAG>3</PRESENT_FLAG>
<REFERENCE>219117502570</REFERENCE>
<RESPONSE_TEXT>APPROVAL TAS053 </RESPONSE_TEXT>
<RESULT>APPROVED</RESULT>
<RESULT_CODE>5</RESULT_CODE>
<SIGNATUREDATA><<See Example Above>></SIGNATUREDATA>
<SIGNATURE_FILE>signatures/2996736.bmp</SIGNATURE_FILE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2012.07.09</TRANS_DATE>
<TRANS_SEQ_NUM>6</TRANS_SEQ_NUM>
<TRANS_TIME>13:33:41</TRANS_TIME>
<TROUTD>2996736</TROUTD>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>634774523123022658</VSP_TRXID>
</RESPONSE>

Credit Card Voice Authorization


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>VOICE_AUTH</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<DEVICEIP>10.64.106.82</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<AUTH_CODE>456456</AUTH_CODE>
</TRANSACTION>
Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.
109

<RESPONSE RSV="0" RSA="1">


<ACCT_NUM>5***********4507</ACCT_NUM>
<AUTH_CODE>456456</AUTH_CODE>
<CARDHOLDER>SUPPLIED/NOT
</CARDHOLDER>
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>VOICE_AUTH</COMMAND>
<CTROUTD>222</CTROUTD>
<ENTRY_MODE>SWIPED</ENTRY_MODE>
<INTRN_SEQ_NUM>2996782</INTRN_SEQ_NUM>
<LPTOKEN>7342</LPTOKEN>
<MIMETYPE>image/tiff</MIMETYPE>
<PAYMENT_MEDIA>MC</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PRESENT_FLAG>3</PRESENT_FLAG>
<RESPONSE_TEXT>APPROVED</RESPONSE_TEXT>
<RESULT>APPROVED</RESULT>
<RESULT_CODE>5</RESULT_CODE>
<SIGNATUREDATA><<See Example Above>></SIGNATUREDATA>
<SIGNATURE_FILE>signatures/2996782.bmp</SIGNATURE_FILE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2012.07.09</TRANS_DATE>
<TRANS_SEQ_NUM>7</TRANS_SEQ_NUM>
<TRANS_TIME>13:36:08</TRANS_TIME>
<TROUTD>2996782</TROUTD>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>634774524588405093</VSP_TRXID>
</RESPONSE>

Credit Card Completion


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>COMPLETION</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<DEVICEIP>10.64.106.82</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<TROUTD>2996700</TROUTD>
<CMRCL_FLAG>P</CMRCL_FLAG>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<AUTH_CODE>TAS036</AUTH_CODE>
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>COMPLETION</COMMAND>
<CTROUTD>219</CTROUTD>
<INTRN_SEQ_NUM>2996783</INTRN_SEQ_NUM>
<MIMETYPE>image/tiff</MIMETYPE>
<PAYMENT_MEDIA>MC</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


110

<SIGNATUREDATA><<See Example Above>></SIGNATUREDATA>


<SIGNATURE_FILE>signatures/2996783.bmp</SIGNATURE_FILE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_SEQ_NUM>8</TRANS_SEQ_NUM>
<TROUTD>2996700</TROUTD>
<VSP_CODE>910</VSP_CODE>
<VSP_RESULTDESC>VSP NOT APPLICABLE</VSP_RESULTDESC>
<VSP_TRXID>0</VSP_TRXID>
</RESPONSE>

Credit Card Post-Authorization


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>POST_AUTH</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<DEVICEIP>10.64.106.82</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<AUTH_CODE>456456</AUTH_CODE>
<CMRCL_FLAG>P</CMRCL_FLAG>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<ACCT_NUM>5***********4507</ACCT_NUM>
<AUTH_CODE>456456</AUTH_CODE>
<CARDHOLDER>SUPPLIED/NOT
</CARDHOLDER>
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>POST_AUTH</COMMAND>
<CTROUTD>223</CTROUTD>
<ENTRY_MODE>SWIPED</ENTRY_MODE>
<INTRN_SEQ_NUM>2996793</INTRN_SEQ_NUM>
<LPTOKEN>7342</LPTOKEN>
<MIMETYPE>image/tiff</MIMETYPE>
<PAYMENT_MEDIA>MC</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PRESENT_FLAG>3</PRESENT_FLAG>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<SIGNATUREDATA><<See Example Above>></SIGNATUREDATA>
<SIGNATURE_FILE>signatures/2996793.bmp</SIGNATURE_FILE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2012.07.09</TRANS_DATE>
<TRANS_SEQ_NUM>9</TRANS_SEQ_NUM>
<TRANS_TIME>13:38:15</TRANS_TIME>
<TROUTD>2996793</TROUTD>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>634774525856773295</VSP_TRXID>
</RESPONSE>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


111

Credit Card Return (Swiped)


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>CREDIT</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<DEVICEIP>10.64.106.82</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<ACCT_NUM>5***********4507</ACCT_NUM>
<CARDHOLDER>SUPPLIED/NOT
</CARDHOLDER>
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>CREDIT</COMMAND>
<CTROUTD>224</CTROUTD>
<ENTRY_MODE>SWIPED</ENTRY_MODE>
<INTRN_SEQ_NUM>2996794</INTRN_SEQ_NUM>
<LPTOKEN>7342</LPTOKEN>
<MIMETYPE>image/tiff</MIMETYPE>
<PAYMENT_MEDIA>MC</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PRESENT_FLAG>3</PRESENT_FLAG>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<SIGNATUREDATA><<See Example Above>></SIGNATUREDATA>
<SIGNATURE_FILE>signatures/2996794.bmp</SIGNATURE_FILE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2012.07.09</TRANS_DATE>
<TRANS_SEQ_NUM>10</TRANS_SEQ_NUM>
<TRANS_TIME>13:39:03</TRANS_TIME>
<TROUTD>2996794</TROUTD>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>634774526337703272</VSP_TRXID>
</RESPONSE>

Credit Card Return (TROUTD Token)


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>CREDIT</COMMAND>
<TROUTD>2996725</TROUTD>
<CLIENT_ID>663100010001</CLIENT_ID>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>CREDIT</COMMAND>
<CTROUTD>225</CTROUTD>
Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.
112

<INTRN_SEQ_NUM>2996796</INTRN_SEQ_NUM>
<MIMETYPE>image/tiff</MIMETYPE>
<PAYMENT_MEDIA>VISA</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<SIGNATUREDATA><<See Example Above>></SIGNATUREDATA>
<SIGNATURE_FILE>signatures/2996796.bmp</SIGNATURE_FILE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2012.07.09</TRANS_DATE>
<TRANS_SEQ_NUM>11</TRANS_SEQ_NUM>
<TRANS_TIME>13:41:47</TRANS_TIME>
<TROUTD>2996796</TROUTD>
<VSP_CODE>910</VSP_CODE>
<VSP_RESULTDESC>VSP NOT APPLICABLE</VSP_RESULTDESC>
<VSP_TRXID>0</VSP_TRXID>
</RESPONSE>

Credit Card Void (TROUTD Token)


<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<COMMAND>VOID</COMMAND>
<CLIENT_ID>663100010001</CLIENT_ID>
<TROUTD>2996725</TROUTD>
</TRANSACTION>
<RESPONSE RSV="0" RSA="1">
<AUTH_CODE>TAS044</AUTH_CODE>
<CLIENT_ID>663100010001</CLIENT_ID>
<COMMAND>VOID</COMMAND>
<CTROUTD>220</CTROUTD>
<INTRN_SEQ_NUM>2996799</INTRN_SEQ_NUM>
<PAYMENT_MEDIA>VISA</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<REFERENCE>219117502558</REFERENCE>
<RESPONSE_TEXT>APPROVAL TAS044 </RESPONSE_TEXT>
<RESULT>VOIDED</RESULT>
<RESULT_CODE>7</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2012.07.09</TRANS_DATE>
<TRANS_SEQ_NUM>13</TRANS_SEQ_NUM>
<TRANS_TIME>13:43:01</TRANS_TIME>
<TROUTD>2996725</TROUTD>
<VSP_CODE>910</VSP_CODE>
<VSP_RESULTDESC>VSP NOT APPLICABLE</VSP_RESULTDESC>
<VSP_TRXID>0</VSP_TRXID>
</RESPONSE>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


113

Direct Device Transactions

Note
eTIM includes commands to perform direct device operations.
Do not perform direct device operations during PAYMENT requests to eTIM.

Signature Capture
The SIGNATURE command performs a signature capture and returns the data back to the POS. No data
is submitted to PAYware Connect. If Store Signature Files is set to TRUE in the Global or Local
Settings configuration, the signatures will be stored as .bmp files in \html\signatures.

Signature Capture Request


Field

Value

Comments
ETIM_SYSTEM can also be used (with no
change in functionality)

FUNCTION_TYPE

DEVICE

COMMAND

SIGNATURE

DEVICEIP

Ex: 192.168.2.110

Device IP address

DEVICEPORT

Ex: 9001

Device TCP port

Signature Capture Response


Field

Value

Comments

MIMETYPE

Ex: image/tiff

RESPONSE_TEXT

Ex: Session Started

Error condition/description

RESULT

Ex: OK

Valid values:
OK
ERROR

RESULT_CODE

Ex: -1

Valid values:
-1 (successful execution)
990099

SIGNATUREDATA

Base 64 encoded image data

TERMINATION_STATUS

Ex: SUCCESS

Example Request:
<TRANSACTION>
<FUNCTION_TYPE>DEVICE</FUNCTION_TYPE>
<COMMAND>SIGNATURE</COMMAND>
<DEVICEIP>192.168.2.110</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
</TRANSACTION>
Example Response:
<RESPONSE>
<MIMETYPE>image/tiff</MIMETYPE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<RESULT_CODE>-1</RESULT_CODE>
<SIGNATUREDATA> base 64 encoded data </SIGNATUREDATA>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


114

<RESULT>SUCCESS</RESULT>
</RESPONSE>

Device Information
The DEVICE_INFO command allows the POS to retrieve device version levels and serial number. The
actual data is device-specific.

Device Information Request


Field

Value

Comments
ETIM_SYSTEM can also be used (with no
change in functionality)

FUNCTION_TYPE

DEVICE

COMMAND

DEVICE_INFO

DEVICEIP

Ex: 192.168.2.110

Device IP address

DEVICEPORT

Ex: 9001

Device TCP port

Device Information Response


Field

Value

Comments

RESULT

Ex: OK

Valid values:
OK
ERROR

RESULT_CODE

Ex: -1

Valid values:
-1 (successful execution)
990099

TERMINATION_STATUS

Ex: SUCCESS

(Device-specific fields)

Example Request:
<TRANSACTION>
<FUNCTION_TYPE>DEVICE</FUNCTION_TYPE>
<COMMAND>DEVICE_INFO</COMMAND>
<DEVICEIP>192.168.2.110</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
</TRANSACTION>
Example Response:
<RESPONSE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<RESULT_CODE>-1</RESULT_CODE>
<RESULT>SUCCESS</RESULT>
additional key-value pairs are device specific

</RESPONSE>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


115

Passthru
The PASSTHRU command allows the POS to perform device level commands by brokering the
connection and passing the data back and forth between the POS and the device.

Note
This feature is available only for Legacy Support with other VeriFone systems. It is
recommended that POS systems make a direct connection to the device whenever
possible.

Passthru Request
Field

Value

Comments

FUNCTION_TYPE

DEVICE

ETIM_SYSTEM can also be used (with no


change in functionality)

COMMAND

PASSTHRU

MX_PASSTHRU can also be used (with no


change in functionality)

DEVICEIP

Ex: 192.168.2.110

Device IP address

DEVICEPORT

Ex: 9001

Device TCP port

Ex: TRUE

When TRUE, eTIM waits for device to


respond

Ex: FALSE

When TRUE, eTIM resets device to its


initial state

Ex: FALSE

When TRUE, eTIM will wait for an XEVT


packet

Ex: 180

This is the amount of time, in seconds,


that eTIM will wait for a response. Min: 30
Max: 180

Ex: 9001

a hex-encoded comma-delimited string


containing the device request or
FETCH_REQUEST to get the next device
response

HAS_RESPONSE
RESET
BLOCK

BLOCK_TIMEOUT

DEVICE_REQUEST_HEX

Passthru Response
Field

Value

Comments

DEVICE_RESPONSE_HEX

Ex: image/tiff

If HAS_RESPONSE = TRUE
A hex-encoded comma delimited string
containing the device request
If HAS_RESPONSE = FALSE
COMMAND executed successfully

RESULT

Ex: OK

Valid values:
OK
ERROR

RESULT_CODE

Ex: -1

Valid values:
-1 (successful execution)
990099

TERMINATION_STATUS

Ex: SUCCESS

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


116

The following example displays the initial screen for MX devices.


For MX request: <STX>XBATCH<FS>72<RS>XIFM<FS>ET_INIT<RS>XSFM<ETX>{LRC}
Example Request: (MX)
<TRANSACTION>
<FUNCTION_TYPE>DEVICE</FUNCTION_TYPE>
<COMMAND>PASSTHRU</COMMAND>
<DEVICEIP>192.168.2.110</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<DEVICE_REQUEST_HEX>02,58,42,41,54,43,48,1C,37,32,1E,58,49,46,4D,1C,45,
54,5F,49,4E,49,54,1E,58,53,46,4D,03,4C</DEVICE_REQUEST_HEX>
<RESET>FALSE</RESET>
<BLOCK>FALSE</BLOCK>
<BLOCK_TIMEOUT>180</BLOCK_TIMEOUT>
<HAS_RESPONSE>TRUE</HAS_RESPONSE>
</TRANSACTION>
Example Response: (MX)
<RESPONSE>
<BLOCK_TIMEOUT>180</BLOCK_TIMEOUT>
<DEVICE_RESPONSE_HEX>02,58,42,41,54,43,48,1C,1E,58,49,46,4D,1C,31,1E,58
,53,46,4D,1C,31,03,01</DEVICE_RESPONSE_HEX>
<DEVICEPORT>9001</DEVICEPORT>
<DEVICEIP>192.168.2.110</DEVICEIP>
<FUNCTION_TYPE>ETIM_SYSTEM</FUNCTION_TYPE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<RESULT_CODE>-1</RESULT_CODE>
<COMMAND>MX_PASSTHRU</COMMAND>
<BLOCK>FALSE</BLOCK>
<RESULT>SUCCESS</RESULT>
</RESPONSE>
The decoded DEVICE_RESPONSE_HEX is
<STX>XBATCH<FS><RS>XIFM<FS>1<RS>XSFM<FS>1<ETX><SOH>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


117

THIS PAGE INTENTIONALLY LEFT BLANK

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


118

Chapter 6 Troubleshooting

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


119

eTIM Testing Suite


The diagnostic tool can be used to check connections with PAYware Connect, the devices connected to
eTIM, and also test other functions shipped with eTIM. This tool will assist in troubleshooting by helping
to identify the root of the problem.

Starting the eTIM Testing Suite

Note
Before running the Diagnostic utility, please ensure that PAYware Connect Server (if
testing the connection to PAYware Connect) is running and that eTIM is not.

For Windows Users


From your \<eTIM>\utils directory, double-click the file wndiagnosticutil.bat.

For Linux/Unix Users


Open a terminal session.
Browse to your \<eTIM>\utils directory.
Execute the file lxdiagnosticutil.sh to launch the application.
Note: Ensure that you have execute permission for lxdiagnosticutil.sh and other
lx*.sh script files.

For i5/OS Users


Browse to the X:\VeriFone\etim\utils directory (substitute X: with the driver letter
of the drive mapped to the System is IFS root directory)
Double-click the following:
isdiagnosticutil.bat

The eTIM Diagnostic Tool will help you carry out the following diagnostic tests:

Check eTIM Server Connectivity


Check PAYware Connect Server Connectivity
Check MX 880 Device Connectivity
Check MX 870 Device Connectivity
Check MX 860 Device Connectivity
Check MX 850 Device Connectivity
Check MX 830 Device Connectivity
Check MX 760 Device Connectivity
Check MX 915 Device Connectivity
Check MX 925 Device Connectivity
Review BIN Data
Test Pass-Thru Commands to MX Devices
Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.
120

TCP Server Test


From the eTIM Testing Suite, click on TCP Server Test tab.

Enter the eTIM IP, eTIM Port, Device IP, Device Port and the Client ID in their respective text boxes.
You can change the Connection Timeout (secs) if you wish. Click on the desired transaction type to
generate a request transaction for eTIM.
Sample request:
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<CLIENT_ID>1000010001</CLIENT_ID>
<COMMAND>SALE</COMMAND>
<DEVICEIP>192.168.000.020</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
</TRANSACTION>
Click Process, found at the bottom of the screen, to send the request to eTIM Server and check the
connection. (Note that setting a Connection Timeout of 0 will maintain connection indefinitely.)
If a connection is successfully established with eTIM Server, the response message from eTIM Server
will populate the Response Message text area of the eTIM Connection Utility. If there is a problem
with the connection, or anything else, the error will be reported by the Utility.
Click Reset to clear the last request transaction.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


121

PAYware Connect Test


From the eTIM Testing Suite, click on the PAYware Connect Test tab.

Enter the PAYware Connect URLS, Merchant Key, User ID, User Pwd and the Client ID in their
respective text boxes. You may increase the Connection Timeout (secs) to a value greater than the
default of 60. Click on the desired transaction type to generate a request transaction for PAYware
Connect.
Click Test Connection, found at the bottom of the screen, to send the request to PAYware Connect
Server and check the connection.
If a connection is successfully established with PAYware Connect Server, the response message from
PAYware Connect Server will populate the Response Message text area of the PAYware Connect
Connection Utility. If there is a problem with the connection, or anything else, the error will be
reported by the Utility.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


122

BIN Lookup Test


From the eTIM Testing Suite, click on the BIN Lookup Test tab.

If BIN data is configured:


Type a Card Number and click Look Up to locate a matching card BIN record.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


123

Direct Device Test


From the eTIM Testing Suite, click the Direct Device Test tab.

Direct device tests allow a merchant to perform quick tests on each of the capabilities of a device.
Most of device behavior for eTIM is available for testing in this standalone way.

Note
Direct Device Test uses default and hardcoded settings. The utility does not recognize
eTIM configuration values.

Card Swipe Attempts to capture track data from the device. Depending on device capability, this may
originate from the magnetic stripe reader, the RFID, or be manually entered.
Cashback Yes/No Prompts Yes/No/Cancel for cashback
Cashback Cardholder Prompts to enter cashback amount
Cashback Preconfig Prompts to select from (4 or 6) pre-configured cash amount options
Confirm Amount Prompts Yes/No/Cancel for $1.00 amount
Device Information Returns system information. Depending on the device, system information may
also display on the device screen.
Device Variables Returns variables of special interest (when supported). These are hardcoded and
typically considered important configuration variables.
EBT Type Prompts for Food Stamp or Cash Benefits
Enter PIN Prompts for PIN on the device
Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.
124

Enter Postal Code Prompts for 5-digit or 9-digit US postal code


eTIM manual entry Prompts for manual entry (VSP is not used; this is typically for non-VSP or gift
payments)
VSP manual entry Prompts for manual entry using VSP capabilities (non-VSP may still use this)
VSP manual entry bypass expdate Bypasses expiration date entry for private label manual sale
transactions using VSP capabilities (non-VSP may still use this)
Payment Type Prompts for payment type (Credit/Debit/EBT/Gift)
Reset Device State Sends reset command to the device. This happens automatically on all device
actions, placing the device in a ready state.
Signature Capture Prompts for signature capture
Show Signature Upload Displays Uploading Signature message
Show Initial Displays initial device screen
Show Progress Displays In Progress message
Show Result Displays result of See Cashier
Show Shutdown Displays shutdown message screen
Select Device Type from the drop-down list. Enter the Device IP address and Device Port. Choose a
test from the Actions box and click on Test Device. Note that setting Read Block Timeout(s) of 0 will
maintain connection indefinitely.
Click Test Device.
If the eTIM Testing Suite can communicate with the device, then it gets the response and populates it
in the Log text area. The log message will have the result. If the eTIM Testing Suite cannot
communicate with the device, the Utility will report the error.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


125

Legacy MX Passthru Test


From the eTIM Testing Suite, click on the Legacy MX PassThru Test tab.

eTIM requires that the integrator build the MX command, including STX, ETX, and LRC, and then encode
the string in a hex comma delimited string. The eTIM Testing Suite will build the full string, given just
the MX command.
For instance, if you fill in the input fields and enter the desired MX command in the MX PassThru
Command field then click the Generate Request button, the Diagnostic Tool will build the full request
in the Request Message area. The actual DEVICE_REQUEST_HEX value will include the required STX,
ETX, and LRC.
Example:
Modify and paste this string in the MX PassThru Command field:

XBATCH<FS>72<RS>XIFM<FS>ET_INIT<RS>XSFM
Click Generate Request. The Request should appear as follows.
Example Request:
<TRANSACTION>
<FUNCTION_TYPE>ETIM_SYSTEM</FUNCTION_TYPE>
<COMMAND>MX_PASSTHRU</COMMAND>
Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.
126

<DEVICEIP>192.168.2.110</DEVICEIP>
<DEVICEPORT>9001</DEVICEPORT>
<DEVICE_REQUEST_HEX>02,58,42,41,54,43,48,1C,37,32,1E,58,49,46,4D,1C,45,
54,5F,49,4E,49,54,1E,58,53,46,4D,03,4C</DEVICE_REQUEST_HEX>
<RESET>FALSE</RESET>
<BLOCK>FALSE</BLOCK>
<BLOCK_TIMEOUT>180</BLOCK_TIMEOUT>
<HAS_RESPONSE>TRUE</HAS_RESPONSE>
</TRANSACTION>
Example Response:
<RESPONSE>
<BLOCK_TIMEOUT>180</BLOCK_TIMEOUT>
<DEVICE_RESPONSE_HEX>02,58,42,41,54,43,48,1C,1E,58,49,46,4D,1C,31,1E,58
,53,46,4D,1C,31,03,01</DEVICE_RESPONSE_HEX>
<DEVICEPORT>9001</DEVICEPORT>
<DEVICEIP>192.168.2.110</DEVICEIP>
<FUNCTION_TYPE>ETIM_SYSTEM</FUNCTION_TYPE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<RESULT_CODE>-1</RESULT_CODE>
<COMMAND>MX_PASSTHRU</COMMAND>
<BLOCK>FALSE</BLOCK>
<RESULT>SUCCESS</RESULT>
</RESPONSE>
The decoded DEVICE_RESPONSE_HEX is
<STX>XBATCH<FS><RS>XIFM<FS>1<RS>XSFM<FS>1<ETX><SOH>

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


127

THIS PAGE INTENTIONALLY LEFT BLANK

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


128

Chapter 7 eTIM Utilities

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


129

BIN Manager Conversion Utility


The BIN Manager Conversion Utility can be used to convert BIN file tables from the following providers:
Bank Of America
Chase Paymentech
Fifth Third Debit Card (Vantiv)
First Data
First Data (v3.4)

Starting the eTIM BIN Manager Conversion Utility


For Windows Users
From your \<eTIM>\utils directory, double-click the file wnbinconversionutil.bat

For Linux/Unix Users


Open a terminal session.
Browse to your \<eTIM>\utils directory.
Execute the file lxbinconversionutil.sh to launch the application.
Note: Ensure that you have execute permission for lxbinconversionutil.sh and
other lx*.sh script files.

For i5/OS Users


Make sure a Windows workstation is available and is set up to access the System is IFS
prior to beginning the steps outlined in this section. When retrieving a file via FTP, the FTP
connection is also on the Windows system.
Browse to the X:\VeriFone\etim\utils directory (substitute X: with the driver letter
of the drive mapped to the System is IFS root directory)
Double-click the following:
isbinconversionutil.bat

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


130

Select Provider
1. Once the BIN Conversion Utility has been launched, it prompts to select the Type of Provider:
Bank Of America or Paymentech or Fifth Third Debit Card or First Data.
2. Click to select the appropriate Type of Provider.
3. Click Next to continue.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


131

Select the Provider BIN File


1. After selecting the Type of Provider, you will be prompted to Select a BIN File.
2. Browse to select the file to be converted.
3. If you leave the Skip duplicate records checkbox unchecked, records that have the same low
prefix, high prefix, and PAN length will trigger a pop-up message window to alert the user. If
the Skip duplicate records checkbox is checked, the user is not alerted and the conversion
utility skips the duplicate records.
4. Click Next to continue.

If you chose First Data as your provider in the previous step, you will be prompted to select the source
of your BIN file: FTP or Local System.
If you select Local System you will see the screen above.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


132

FTP Settings
If you did not choose First Data as your provider, or if you chose First Data as your provider and
selected the Local System option, skip to the next page.
If you chose First Data as your provider and selected the FTP option for the source of your BIN file, you
will be prompted to enter the following FTP settings:
FTP Server FTP Server name or IP
FTP User Name Valid FTP user name
FTP Password Valid FTP password
Port The FTP Port. The conventional FTP port is 21. Please check with the BIN data provider before
changing the default value
File Name The BIN Data file name to be downloaded from the FTP Server
FTP Connect Timeout The timeout value. (IMPORTANT NOTE: The default value is 60 seconds. For
larger files, or on slower data connections, please increase the timeout value.)
Click Next to continue.
After the file is downloaded from First Data, you can go back and use the Local System option to run
the conversion.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


133

Convert Provider BIN File


1. After selecting the BIN File, you will be prompted to start conversion of the BIN file.
2. Click Next to start the conversion.

If an error is displayed, there may be HTML or other unnecessary data that was not stripped from the
file. Verify this, and select Ignore to continue.
Some files may have three or more of these types of records at the beginning and at the end of the
file. It is best to edit the file before passing it to the BIN Conversion Utility in order to avoid these
errors.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


134

The following screen appears while the conversion operation is in progress:

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


135

Select Save Location


After the conversion is successful, the tool prompts for a Save Location for the converted BIN data.
Enter or Browse to select the path for the Save Location.
When launched from eTIM, and if the <eTIM>/props directory exists, the default save location is
<eTIM>/props/
The file is saved as CardTable.xml.
Click Save to save the converted BIN data.

A Saved screen will appear, listing the Number of Records Added, Number of Duplicate Records Found,
and Number of Invalid Records Found. Click Finish to exit.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


136

Chapter 8 Signature Capture using MX


Series Devices

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


137

Prompted Signature Capture


The MX Series devices can be used to capture the Cardholder Signature as Base 64 encoded BMP format
data.
To enable this feature, the Allow Signature Capture option for the Client ID must be set to true.
eTIM prompts the Cardholder to enter a signature on the device for any credit card transaction that
returns a RESULT of CAPTURED or APPROVED. Listed below are the most common commands that
prompt for signature:
1. Sale
2. Credit
3. Pre-Authorization
4. Voice Authorization
5. Completion
6. Post-Authorization
The Cardholder is prompted to sign after the Approved or Captured response is received from the
host (i.e., after the transaction has been processed by the host).

Note

Note

Note

After a SALE transaction is captured, the cardholder is prompted to enter a signature on


the MX Series device.
If the cardholder chooses to Cancel, eTIM sends a VOID transaction to PAYware Connect
for the TROUTD that was processed. To enable this feature, the Void on Txn on Signature
Cancel option for the MX Series device must be set to true.

There may be cases when you do not want signature capture prompted on the terminal
for example, a COMPLETION done in shipping when customer is not present or a
REF_TROUTD transaction. In these cases, simply do not include device IP address or Port
with the transaction.

If you wish to prompt for signature capture outside of a payment transaction (e.g., to
waive a warranty), you can send the prompt as a standalone device command. See Chapter
5 Integration, Direct Device Transactions for more information.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


138

Appendix A Error Handling

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


139

Note
Generally, the errors originating from eTIM develop from configuration, environment, or
integration issues requiring operator intervention (see section eTIM Error Handling).
eTIM allows PAYware Connect to handle most errors (see section PAYware Connect Result
Codes).

eTIM Error Handling

Note
You must review error results in conjunction with RESPONSE_TEXT (see below).

Result Code
eTIM generates one of two RESULT_CODEs:

-1 (Success - commands that do not require a message to PWC return a RESULT_CODE = -1,
RESULT = SUCCESS upon successful execution)
990099 (Error originating from eTIM see RESPONSE_TEXT for specifics)

Result
eTIM generates the following RESULTs:

SUCCESS = Success
ERROR = General error (may be from PAYware Connect or from eTIM)
CANCELED = Cancelation
DEVICE_ERROR = Error passed from the device
INTERNAL_ERROR = Unexpected execution route in eTIM (things that should not happen)
UNKNOWN = Unknown (last ditch effort to return a response to the POS)
PARAM_ERROR = Parameter error or unsupported command

See RESPONSE_TEXT for additional information.

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


140

Response Text
The RESPONSE_TEXT should give a clear indication of the problem (also recorded in the logs).
The most common RESPONSE_TEXT responses include:

SUCCESS
SUCCESS (operation-specific text)

CANCELED
- CANCELED BY %1 (Example: customer canceled at signature screen)

DEVICE_ERROR
- DEVICE IS BUSY (Example: device had two requeststhis is second)
- Device configuration error: %1
- Device connection failed/lost
- Device is required
- Device operation failed while %1
- Configuration error: %1
- UNABLE to connect to %1

ERROR
- {environmental}
- Client ID Exception: %1

INTERNAL_ERROR
- Missing data while %1
- Received no data while %1
- Received too much data while %1
- Unexpected data while %1

PARAM_ERROR
- %1 not allowed for %2
- %1 is not a valid value (Example: DEVICEIP is not a valid value)
- %1 is required
- Expected %1 parameters received %2 while %3
- UNSUPPORTED COMMAND
- Received insufficient data while %1

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


141

PAYware Connect Result Codes

Note
The result codes listed below are the most common. For a full list of result/status codes,
refer to the PAYware Connect Integration Guide.

RESULT_CODE

RESULT

Comments

-2

XML Format Incorrect

-1

SUCCESS

Successful API call

UNKNOWN

Unknown result

SETTLED

CAPTURED

APPROVED

DECLINED

Transaction declined - see


RESPONSE_TEXT value

VOIDED

Transaction successfully voided

10

COMPLETED

Transaction completed successfully and


placed in the batch

16

PARTCOMP

Partial completion

17

TIP_MODIFIED

Tip modification

21

Settlement Scheduled

93

Invalid Card Number

97

Invalid Expiration Date

1010

Invalid Amount

2029999

Authentication Error

Transaction approved and captured in


batch

Authentication error or command not


authorized

Copyright 2013. VeriFone Systems, Inc. All Rights Reserved.


142

Enterprise Terminal Interface Manager v.2.0


Tested Terminal Software Versions
Updated July 26, 2013

Enterprise Terminal Interface Manager v.2.0


Tested Terminal Software Versions
MX Device

Kernel

Root File System

MX 760

MX0004US.c

RFS00020 (100616)

MX 830

MX0003US

MX 850

MX0004US

MX 860

MX0007US

RFS00016*
SP 016.05.01
RFS00017*
SP 017.01.01
RFS00018

MX 870

MX0007US

RFS00018

MX 880

MX0007US

RFS00018

MX 915

MX200001

MX 925

MX200001

RFS1.09
Build 2012065
RFS1.0.9.0104
Build 20120625-SC
3.0.1

Form Agent Version


openssl 0.9.8L-vfi.08*
FormAgent-release2.32.1S (non-SSL and SSL
0.9.8L-vfi.05)
FormAgent-release2.2.1W (SSL)
FormAgent-release2.2.1W (non-SSL)
FormAgent-release-2.3.2U
(non-SSL , SSL 0.9.8Lvfi.08)
FormAgent-release2.2.1W (SSL and non-SSL)
FormAgent-release-2.2.1S
(SSL and non-SSL)
FormAgent-release3.0.0D_120627
FormAgent-release3.0.0D_120627

Form Version 2.00


ET_MX760_FORMS_files.tgz
(01/20/2012)
ET_MX850_FORMS_files.tgz
(01/20/2012)
ET_MX850_FORMS_files.tgz
(01/20/2012)
ET_MX860_FORMS_files.tgz
(3/12/2012)
ET_MX870_FORMS_files.tgz
(1/20/2012)
ET_MX880_FORMS_files.tgz
(1/20/2012)
dl-Mx925eTIM_appFA3.0.0D3_120627.tgz
dl-Mx925eTIM_appFA3.0.0D3_120627.tgz

*RFS00016 requires service pack 4 for SSL


RFS00017 requires service pack 1 for SSL
* Requires Forms Agent 2.2.1S or 2.2.1W or later to support VSP with keyed card entry.
NOTE:
At the time of document publication:
SSL support is currently not available for MX 915/ MX 925
VSP support is currently not available for MX 760

2013 VeriFone, Inc. All rights reserved. VeriFone and the VeriFone logo are either trademarks or registered trademarks of VeriFone in the United States and/or other countries. All other trademarks or brand
names are the properties of their respective holders. All features and specifications are subject to change without notice. Reproduction or posting of this document without prior VeriFone approval is
prohibited.
5/11 00000 Rev A FS

Anda mungkin juga menyukai