PAYware Ocius Sentinel

Integration Guide
Author: ND Circulation: Public Date: 01/10/2012
PAYware Ocius Sentinel
Author ND
Phone 08444 828 200
Document name PAYware Ocius Sentinel Integration Guide Date 1st October 2012 Page number 2
Public
Version V1.15
Revision History
Ver. 1.15 Name ND Date Oct 2012 Comments - Reformatted the document - Added detail to Recovered Transaction (0040) modifier - CARDWAIT functionality added - Fexco DCC receipt examples added - Updated Transaction Response results with 8 (Comms Down) - Automatic Return Online Functionality detailed - Bill Lodging removed - Pennies XML receipt information documented - Updated document with the new format - WebCom Test URL updated - Updated error codes list - DCC fields in Transaction Response (Version 2) table updated
1.14
ND
April 2012
Introduction
This document has been produced to provide merchants, Point of Sale solution providers and other system integrators with the information necessary to integrate to PAYware Ocius Sentinel. Information about the product, background information on VeriFone and all integration messages are included. For step-by-step instructions on installing the product, please refer to the PAYware Ocius Sentinel Installation Guide.
Copyright 2012 VeriFone All rights reserved. Copying and/or redistribution of this information in whole or in part without the express permission of VeriFone prohibited.
Author ND
Phone 08444 828 200
Public
Version V1.15
Content
Revision History ......................................................................................................................... 2 Introduction ................................................................................................................................ 2 1. Solution Overview .................................................................................................................. 7 1.1. 1.2. Sentinel Software ....................................................................................................... 7 Supported PEDs ......................................................................................................... 8
1.2.1. Vx 810 ....................................................................................................................... 8 1.2.2. VX 820 ...................................................................................................................... 8 1.3. Operation Modes ...................................................................................................... 10
1.3.1. Screenless .............................................................................................................. 10 1.3.2. Semi Attended ........................................................................................................ 11 1.4. Backward Compatibility ............................................................................................ 11
1.4.1. Removed Features.................................................................................................. 11 1.5. PCI DSS Compliance ............................................................................................... 12
2. Solution Management .......................................................................................................... 13 2.1. 2.1. 2.2. EFT Merchant Account ............................................................................................. 13 Merchant Stores ....................................................................................................... 13 Testing Procedures .................................................................................................. 13
3. EFT Transaction Types ........................................................................................................ 14 3.1. 3.1. Customer Present..................................................................................................... 14 Customer Not Present .............................................................................................. 14
3.1.1. Account On File Transactions ................................................................................. 15 4. Integration ............................................................................................................................ 18 4.1. 4.2. 4.3. Integration Process................................................................................................... 18 Testing Values .......................................................................................................... 18 Integration Methods .................................................................................................. 19
4.3.1. Socket Connection .................................................................................................. 19 4.3.2. Text File .................................................................................................................. 19 4.4. 4.5. 4.6. Integration Version ................................................................................................... 20 Ocius.ini File ............................................................................................................. 21 Receipt Printing ........................................................................................................ 23
4.6.1. Text File .................................................................................................................. 23 4.6.2. XML File .................................................................................................................. 24

Author ND
Phone 08444 828 200
Public
Version V1.15
4.6.1. Receipt Format XML Mapping .............................................................................. 27 4.6.1. Dynamic Currency Conversion (DCC) ..................................................................... 38 4.6.2. Barclaycard Gift ...................................................................................................... 41 4.6.3. Transax SV ............................................................................................................. 43 4.6.4. Pennies ................................................................................................................... 44 4.7. Integration Messages ............................................................................................... 48
4.7.1. Transaction Request (T Record) ............................................................................. 48 4.7.2. Transaction Response (Initial) ................................................................................. 50 4.7.3. Transaction Response (Version2) ........................................................................... 51 4.7.4. Transaction Response (Version3) ........................................................................... 52 4.7.5. Transaction Response (Version4) ........................................................................... 52 4.7.6. Transaction Response (Version5) ........................................................................... 52 4.7.7. Transaction Response (Version6) ........................................................................... 52 4.7.8. Login Request (L2 Record) ..................................................................................... 53 4.7.9. Logout Request (O Record) .................................................................................... 56 4.7.10. POS Progress/Customer Facing ........................................................................... 56 4.7.11. Continue Transaction (CONTTXN Record) ........................................................... 63 4.7.12. Transaction Value Modification ............................................................................. 66 4.7.13. REQINFO.............................................................................................................. 69 4.7.14. Additional Integration Commands ......................................................................... 70 5. Value Added Services .......................................................................................................... 72 5.1. 5.2. 5.3. 5.4. 5.5. Barclaycard Gift ........................................................................................................ 72 Barclaycard Gift Request (BGIFT Record) ................................................................ 72 Barclays Gift Response ............................................................................................ 73 Dynamic Currency Conversion (DCC) ...................................................................... 74 Givex ........................................................................................................................ 74
5.5.1. Givex Request (GIVEX Record) .............................................................................. 75 5.5.2. Givex Response ...................................................................................................... 76 5.6. MiVoucher ................................................................................................................ 76
5.6.1. MiVoucher Request (M Record) .............................................................................. 77 5.6.2. MiVoucher Details ................................................................................................... 78 5.6.3. MiVoucher Response .............................................................................................. 80 5.7. Flexecash (Park Retail) ............................................................................................ 81
Author ND
Phone 08444 828 200
Public
Version V1.15
5.7.1. Park Retail Request (PRG Record) ......................................................................... 81 5.7.2. Park Retail Response ............................................................................................. 82 5.8. PayPoint ................................................................................................................... 84
5.8.1. PayPoint Request (PPOINT Record)....................................................................... 84 5.8.2. PayPoint Response................................................................................................. 86 5.9. 5.10. Pennies .................................................................................................................... 87 Stored Value Solutions (SVS) ................................................................................... 87
5.10.1. SVS Request (SVS Record) .................................................................................. 87 5.10.2. SVS Response...................................................................................................... 89 5.11. Transax SV (Stored Value) ....................................................................................... 90
5.11.1. Transax SV Request (TSV Record)....................................................................... 90 5.11.2. Transax SV Response .......................................................................................... 94 6. Additional Functionalities ..................................................................................................... 95 6.1. 6.2. 6.3. Discretional Data ...................................................................................................... 95 External Hashing ...................................................................................................... 95 Get Card Details ....................................................................................................... 96
6.3.1. Get Card Details Request (GDET Record) .............................................................. 96 6.3.2. Get Card Details Response..................................................................................... 96 6.4. 6.5. 6.6. 6.7. 6.8. PAN Masking ............................................................................................................ 98 PED Version Mapping .............................................................................................. 98 Procurement Card Processing .................................................................................. 98 Transaction Value Modification ................................................................................. 98 Card Wait ................................................................................................................100
6.8.1. Card Wait Request (CARDWAIT Record) ..............................................................100 6.8.2. Card Wait Cancel Request (CANCELCARDWAIT Record) ....................................102 6.8.3. Card Wait Response ..............................................................................................103 6.9. Contactless Payments .............................................................................................105
7. Offline Functionality and Floor Limits ..................................................................................106 7.1. 7.2. 7.3. 7.4. 7.5. EMV Floor Limit .......................................................................................................106 Voice Referral Floor Limit ........................................................................................107 Post Comms Floor Limit & Stand-In Authorisation ...................................................107 Offline Transaction Specifics ...................................................................................110 Offline Hash Generation ..........................................................................................110
Author ND
Phone 08444 828 200
Public
Version V1.15
7.6. 7.7.
Example EFT Scenarios ..........................................................................................111 SVS Offline Functionality .........................................................................................113
7.7.1. SVS Reversal Processing ......................................................................................113 7.8. 7.1. Transax Offline Functionality ...................................................................................114 Automatic Return Online Functionality .....................................................................114
APPENDIX..............................................................................................................................115 Contact Details ....................................................................................................................115 Currency Code ISO 4217 ....................................................................................................116 Country Codes ISO 3166 ....................................................................................................120 VeriFone Error Codes..........................................................................................................124 PAYware Ocius Sentinel FAQs ...........................................................................................131 Why do I get an EFT is not allowed integration response? ............................................131 Why do I get an integration service not allowed? .............................................................132 System.MissingMethodException in the log file................................................................133 What version of .NET is required? ...................................................................................133 No System ID available ....................................................................................................133 Why did the hosted login process fail? .............................................................................134 How do I allow PAYware Ocius Sentinel to be installed on more machines? ...................135 How do I move an PAYware Ocius Sentinel license to a new machine? ..........................135 When does the offline voice referral floor limit take into effect? ........................................135 Why is the offline voice referral floor limit process different? ............................................135
Author ND
Phone 08444 828 200
Public
Version V1.15
1. Solution Overview
This chapter provides brief details on all the components of the PAYware Ocius Sentinel solution; Sentinel software, supported PEDs, various operation modes and backward compatibility.
1.1. Sentinel Software

PAYware Ocius Sentinel is part of VeriFones PAYware Ocius Managed Service, a PCI DSS Level 1 certified payment solution provider. Developed by VeriFone, PAYware Ocius Sentinel is a software application that resides on a PIN Pad within a PCI PTS/APACS Common Criteria secure environment providing dual-layer data encryption from the point of card data capture. Sensitive cardholder data is encrypted within the PIN Pad using both 168-bit 3DES encryption (utilising a unique dynamic key system generated using transaction specific data elements) followed by further encryption using a 2048-bit RSA algorithm, before being sent to the Point of Sale for onward transmission to VeriFones managed service. As card data remains fully encrypted throughout this process, and the merchant has no ability to decrypt the data, cardholder information is effectively removed from the merchant's system, significantly reducing the scope and cost of achieving and maintaining the Payment Card Industry Data Security Standards (PCI DSS). Cardholder data is only decrypted once safely inside the secure (and certified) environment of VeriFone's ICP Managed Service prior to transmission to the acquiring bank. PAYware Ocius Sentinel is the final piece of the jigsaw to provide end-to-end encryption of cardholder data, significantly reducing the scope and associated costs of PCI DSS compliance for merchants and rendering cardholder data inaccessible to any potential cyber criminals. PAYware Ocius Sentinel goes beyond compliance, providing a range of additional features, addressing issues such as PED Asset Management, including PED serial number tracking and swap out/power on-off alerts to help thwart physical attacks on PED assets. PAYware Ocius Sentinel also incorporates secure remote downloads to verify that any updates delivered to PAYware Ocius Sentinel are from verified as being from VeriFones Managed Service. For full information on installation, configuration and registration of PAYware Ocius Sentinel please refer to the separate Installation Guide.
Author ND
Phone 08444 828 200
Public
Version V1.15
1.2. Supported PEDs

PAYware Ocius Sentinel software can be integrated with PEDs (PIN Entry Devices) to allow merchants to perform payments via POS systems. The following PIN pads are generically certified and supported to use with the PAYware Ocius Sentinel solution: 1.2.1. Vx 810 The Vx 810 provides the right combination of features and functions in a sleek, stylish device that fits in the palm of your hand. This includes a magnetic stripe card reader, smart card reader, and integrated PIN pad. The Vx 810 series supports both symmetric encryption algorithms (DES, 3DES, and AES) and asymmetric encryption (RSA). This device internally manages simultaneous multiple keys through either Master Session- or DUKPT-based processes, and offers high performance smart card processing, as well as support for the new generation of 3-volt cards. The Vx 810 is a programmable device, allowing a custom or EMV-approved transaction application to run from the VISA PCI-compliant PIN pad, either to meet local regulatory requirements or relieve the ECR or terminal of this task.
The single port connector allows for serial or USB connectivity as well as optional Ethernet connection which can be used as standalone terminal via IP connectivity (VX 810 IP). For more details on VX 810 IP solution, please refer to a separate guide PAYware Ocius manual. 1.2.2. VX 820 The VX 820 PIN pad is an advanced technology part of VeriFones VX Evolution Platform; enhanced with colour touch-screen display, a larger keypad and integrated contactless capability. Its advanced and intuitive technology provides reliable and robust customer facing PIN pad for ease of use in retail and hospitality environments.
Author ND
Phone 08444 828 200
Public
Version V1.15
The PIN pad provides merchants with a single-port connectivity offering the capability to install the terminal via USB, serial or Ethernet (for IP connectivity) connections using the appropriate cable. The VX 820 provides the right combination of features and functions in a sleek, stylish device that fits in the palm of your hand. VX 820 securely and efficiently handles all payment needs including magnetic stripe card reader, smart card reader, an integrated PIN pad, and optional integrated contactless for EFT transactions. Additional security - The optional privacy shield is available with both PIN pads; which can be easily inserted above the keypad to hide the keys when a user is pressing to enter the PIN for a transaction. Please contact your Account Manager for details on all accessories available with the PIN pads.
Author ND
Phone 08444 828 200
Public
Version V1.15
1.3. Operation Modes

The PAYware Ocius Sentinel application can be utilised in various operation modes, the following are available: Normal Minimised Screenless Semi-attended* Unattended*
* Currently unavailable, please speak to your Account Manager for more details. 1.3.1. Screenless PAYware Ocius Sentinel provides a Screenless mode of operation, providing POS solutions with the ability to retain focus whilst PAYware Ocius Sentinel silently processes transactions in the background. This results in the POS system being able to use the entire POS screen and removes any requirement to reserve screen space for PAYware Ocius Sentinel to occupy during a transaction; whilst also enabling the Point of Sale solution provider to effectively hide the application from their customer (the merchant). When processing transactions whilst using the Screenless mode, a progress status message will be exported for the POS for monitoring purposes. This information can be received by either a socket connection or text file; configuration options are included within the settings file. This configuration process is detailed within the Installation Guide. By default, the text file integration outputs a progress file named StatusFile.txt to the TIPath as defined within the settings. If using socket integration then the information will be exported on port 25001. One single mode of integration (socket or text) MUST be used throughout development for both transaction integration and status message retrieval. Please note that when utilising this mode that the Refund PIN will need to be disabled.
Author ND
Phone 08444 828 200
Public
Version V1.15
1.3.2. Semi Attended Semi Attended environments are those in which the payment is driven entirely by the POS, without any interaction from an operator. Should there be a problem, operators are on hand to help and resolve the issue. This is commonplace in supermarkets whereby one operator will be watching over several POS. PAYware Ocius Sentinel can be utilised in a Semi Attended environment using one of the standard PIN entry devices, without the need to utilise an Unattended PED. When integrating in this environment there are additional requirements in terms of the onscreen messages. The merchant must integrate utilising the Progress Messages and Continue Transaction functionality, ensuring that the cardholder can be updated on screen at each stage of the transaction.
1.4. Backward Compatibility

PAYware Ocius Sentinel provides full backward compatibility for most integrators who have previously supported a PAYware Ocius Chip & Pin solution, particularly those who have developed against the PAYware Ocius for PC V2 or V3 interface previously. There are, however, some optional additional fields in the PAYware Ocius Sentinel interface that would be required to take advantage of some new features. Whilst every effort has been made to ensure adequate backward compatibility, VeriFone insists that integration testing takes place prior to any upgrade. Please contact the Implementations Department to arrange for this integration testing. 1.4.1. Removed Features In order to support PAYware Ocius Sentinels overall security credentials, a small number of items have had to be removed from the previous PAYware Ocius for PC integration records. These predominately relate to the sending or receiving of sensitive cardholder data between PAYware Ocius and the Point of Sale under certain circumstances as defined below: CONTTXN,6,CARDNUMBER=X command removed, as card number must now be entered on the PED directly Direct transaction records (D-Records) Disabling of the integration logout message using an Ocius.ini parameter (NOINTLOGOUTMSG) E-Commerce transaction support, modifier removed. External swipe capture methods Keyed card number entry within the PAYware Ocius Sentinel application this can only be performed directly on the PED Provision of cashback as part of the integration transaction request record removed (can be defined within Continue Transaction Message in Screenless mode when a cashback enabled card is presented) Provision of gratuity as part of the integration transaction record Retrieval of scheme branded payment card data from the PED to the POS Update PED from the PED configuration screen
Author ND
Phone 08444 828 200
Public
Version V1.15
Retrieval of EFT swipe card data from the PED to the POS
1.5. PCI DSS Compliance

The Payment Card Industry Data Security Standard (PCI DSS) is an extremely important initiative driven by Card Schemes, Industry Bodies and Acquiring Banks worldwide. Its effect on merchants differs depending on a number of factors such as annual transaction volumes. As a Payment Service Provider (PSP), VeriFone have a responsibility to be fully accredited with all industry security protocols. The PCI DSS programme is in fact an amalgamation of both Visas AISP (Account Information Security Programme) and MasterCards SDP (Secure Data Programme). Both standards were combined to create a new worldwide security standard, to help secure confidential card information from otherwise vulnerable systems. As part of these newer security regulations, merchants also have a greater level of responsibility for security than ever before and, as a result, PSPs and Acquirers alike are advising merchants accordingly. Initially, the best advice is to ensure that operating systems used for the storage or processing of card data are maintained to the highest level of security and adopt other security measures such as: High security firewall protection for all public network access (internet) Strong authentication methods for all local network access Regularly updated antivirus protection Strong localised access restrictions Passwords should consist of a mixture of at least 8 alphanumeric characters, and where possible be changed at least every 90 days Passwords should not be obvious words like months, birthdays, pets names etc Passwords should be known by as few people as possible Where possible each user should have a unique password Passwords should not be written down Operating system patches should be applied within 30 days of release
Further information on PCI DSS compliance can be found on the Visa or MasterCard websites as shown below:
https://www.pcisecuritystandards.org http://www.visaeurope.com/aboutvisa/security/ais/resourcesanddownloads.jsp https://sdp.mastercardintl.com/documentation/index.shtml
For information regarding becoming compliant with the security rules and regulations of the card associations, including an online questionnaire, please visit: https://VeriFone.trustkeeper.net
Author ND
Phone 08444 828 200
Public
Version V1.15
2. Solution Management
This chapter provides pre-requisites to ensure the merchant has completed all the necessary procedures required prior to installing or integrating the PAYware Ocius Sentinel solution to their environment.
2.1. EFT Merchant Account

Merchants are required to setup an Electronic Funds Transfer (EFT) account in order to process payment transactions. To setup an EFT account, a Merchant ID (MID) is required from the Acquirer. Terminal IDs (TIDs) are then allocated to the Merchant ID and a merchant system ID is created. A merchant can have more than one system ID to setup multi-channel solutions, to ensure a merchant system is configured please speak to your Account Manager in Sales.
2.1. Merchant Stores

Merchant Stores enable merchants to remotely manage terminals across an entire estate. Each merchant store links PTIDs (Payment Terminal IDs) of each terminal onto a merchant store. Merchant stores contain information specific to the store/location that is required by the terminals to successfully perform their processing, e.g. customised receipt/voucher details. An advantage of a merchant store configured can be utilised to configure terminal with a country code to locate the terminal outside of the UK. This is implemented by associating the terminal with a given store and configuring the terminal country code based upon the country of the store. In addition, merchant stores support a variety of value adds as appropriate to ensure that value add specific information is held distinct from the core non-value add specific information. To configure a merchant store, please contact Helpdesk team.
2.2. Testing Procedures

In order to ensure that all credit and debit payments are processed as intended, VeriFone insist on a full testing procedure to be carried out by a VeriFone Implementations Engineer before live processing can take place. To fully test the system, VeriFone configure an exact replica of the credit card processing solution in test mode, which enables a wide range of different transaction types to be simulated in a controlled environment. Once the testing has been completed, VeriFone will issue a signoff certificate which shows that the system(s) tested have met the required standard and may be implemented on site as required. However, if any amendments are made to the third party software, re-testing will have to take place.
Author ND
Phone 08444 828 200
Public
Version V1.15
3. EFT Transaction Types

This section provides details on the various Customer Present (CP) and Customer Not Present (CNP) transaction types supported with PAYware Ocius Sentinel.
3.1. Customer Present

The following CP transaction types are supported with this solution:

Purchase the ability to process a sale Refund the ability to cancel a sale Cash Advance the ability to withdraw cash value from cardholders card
3.1. Customer Not Present

PAYware Ocius Sentinel provides the ability for merchants to process the following CNP transactions:

Mail Purchase the ability to process a sale received via mail Mail Refund - the ability to process a refund received via mail Telephone Purchase the ability to process a sale via telephone Telephone Refund - the ability to process a refund via telephone Account On File merchant stores the cardholders details and at the point of payment can retrieve them for the processing of the transaction
When processing a CNP transaction, the operator will be required to key the card number into the pin entry device (PED) to ensure that the sensitive cardholder data is encrypted on the PED before traversing the merchants network. The solution will also request Address Verification System (AVS) details in order to check the billing address of the card provided by the user with the address on file with the card issuer. The information requested by PAYware Ocius Sentinel for address verification is both the House Number and numbers from the Post Code (e.g. for TN25 4AZ these will be 254). The Card Security Code (CSC 1) will also be requested as part of the CNP process. Supplying the CSC during a transaction is intended to verify that the cardholder has the card in their possession, as the code is not contained within the magnetic swipe data or within the chip on ICC cards. The CSC is stored by the card issuer and verified as part of an authorisation request, as with the AVS details. For integrated merchants configured to utilise PAYware Ocius Sentinels Screenless Mode, the POS Progress Messages should be translated to provide instruction to the POS operator of the information required at each stage (e.g. Status IDs 39, 40, 41).
1 sometimes called Card Verification Data (CVD), Card Verification Value (CVV or CVV2), Card Verification Value Code (CVVC), Card Verification Code (CVC or CVC2), Verification Code (V-Code or V Code), or Card Code Verification (CCV)
Author ND
Phone 08444 828 200
Public
Version V1.15
PAYware Ocius Sentinel does not automatically accept AVS/CSC results, the card acceptor will be required to decide if they wish to confirm the transaction based upon the result of the verification performed, as defined within the APACS specification which VeriFone conforms to. The only exception to this is in the instance of where the transaction was authorised by the acquirer (not by voice referral) and the CSC result is Not Matched VeriFone is mandated by the card schemes to take this action. Card issuers should decline transactions where the CSC does not match, but this action is in place as a failsafe. Below is a table to show the results returned by PAYware Ocius Sentinel and the definition of each:
Result Address Match Only Data Matched Data Not Checked Data Not Matched Sec Code Match Definition AVS details valid, CSC data invalid Valid AVS and CSC details AVS nor CSC data supplied with transaction AVS and CSC data invalid CSC data are valid, but at least one of the AVS data was invalid
3.1.1. Account On File Transactions Account on File is a Cardholder Not Present payment method whereby the cardholder does not need to re-enter their card details in order to perform a payment. The merchant (or payment service provider) stores the cardholders details and at the point of payment can retrieve them for the processing of the transaction. Account on File transactions do not require any CSC or AVS details to be supplied. Stable Tokenisation As standard, VeriFone ensures that any card payment details being registered have not already been stored for the merchant in question. Should the details already have been stored then the token ID assigned will be returned, rather than creating a new token ID for the same details. Account On File Registration In order to perform an account on file transaction, the cardholders payment details must first be registered. PAYware Ocius Sentinel supports registering card details using two functions: Registration and Payment, or Registration only. Both functions capture the details using an EFT transaction flow via any capture method other than Contactless. Registration and Payment This registration mechanism allows the merchant to perform a standard transaction whilst also storing these details for future Account on File payment transactions.
Author ND
Phone 08444 828 200
Public
Version V1.15
The merchant performs a standard purchase or refund transaction in the normal fashion. If the merchant system is configured to support Account on File and PAYware Ocius Sentinel is operating in Online Mode, PAYware Ocius Sentinel will prompt the user to make for their decision on account registration. This prompt occurs after the Merchant Reference prompt (again, if configured). After the decision has been made, standard transaction processing will continue. When processing a transaction via integration, with Account on File enabled, the decision on registering the details can be specified within the transaction record using field 27. See the transaction record definition for full details on the options available. Prior to the transaction being sent for authorisation, PAYware Ocius Sentinel will submit the payment details for Account on File registration. After completion of the Account on File registration process, standard authorisation processing will continue. Upon completion of the authorisation processing, PAYware Ocius Sentinel will include the Account on File registration details on the receipts. Upon completion of the transaction, if the transaction is integrated, PAYware Ocius Sentinel will return the integration response with additional fields added providing the token registration result details. Registration Only This registration function allows the merchant to store the cardholders payment details for Account on File payment transactions without processing any form of authorisation. This registration mechanism is initiated by starting a modified transaction, either by selecting the customer present modifier or the customer not present modifier. PAYware Ocius Sentinel will then follow a standard transaction flow. However, PAYware Ocius Sentinel will automatically set the transaction value to 0.00, and skip the decision prompt for whether to perform the registration process. At the point where a transaction would normally be authorised, PAYware Ocius Sentinel will perform the registration process as defined in the Registration and Payment function. Instead of sending the transaction for authorisation, PAYware Ocius Sentinel will automatically decline the transaction locally, and complete as a registration only transaction. As the transaction is registration only, PAYware Ocius Sentinel will print receipts tailored for this type of transaction. At no point in this process are any payments attempted to be authorised and as such the card details are not validated in any way with the acquiring bank or card issuer. Upon completion, if the transaction is integrated, PAYware Ocius Sentinel will return the integration response with additional fields providing the Account on File registration result details.
Author ND
Phone 08444 828 200
Public
Version V1.15
Account on File Registration Validity Period Payment details registered using the Account on File mechanism will only be valid for a finite period of time. This time period is based upon Account on File Validity Period configured against the merchants system. The Account on File Validity Period is defined in days, by default this is configured to 365 days. Account On File Payment Account on File payment is a Cardholder Not Present transaction type. As such, it can be initiated by selecting the corresponding Purchase or Refund option on the Card Not Present transaction type screen. PAYware Ocius Sentinel will then process the transaction as normal. Upon processing the requested transaction, the attached PED will request the token ID rather than card details. Within an Integrated environment the token ID can be supplied within the Transaction Record (integration is highly recommended when utilising Token functionality). The transaction processing will continue by submitting the transaction to the ICP Service for authorisation. The ICP Service will retrieve the relevant cardholder details from its database of registered cards, using those details for the requested transaction. PAYware Ocius Sentinel will complete the transaction in a similar manner to a standard transaction, printing the appropriate merchant and cardholder receipts. Upon completion, if the transaction is integrated, PAYware Ocius Sentinel will return the integration response with additional fields added providing the Account on File payment details.
Author ND
Phone 08444 828 200
Public
Version V1.15
4. Integration
This section aims to inform the user of the options available to them to integrate into PAYware Ocius Sentinel, as well as detailing the process of achieving certification from VeriFone for the interface.
4.1. Integration Process

In order to ensure that all credit and debit payments are processed as intended, VeriFone insist on a full testing procedure to be carried out by a VeriFone Implementations Engineer before live processing can take place. Once the system integrator believes that the development is complete and is ready for a full integration test, a VeriFone on site engineer is booked to attend site to complete a full set of tests ensuring the system operates as required. To fully test the system, the engineer will test an exact replica of the completed credit card processing solution in test mode, which enables a wide range different transaction types to be simulated in a controlled environment. After the testing has been completed, VeriFone will issue an integration report which shows that the system(s) tested has met the required standard and may be implemented on site as required. Should there be any issues which result in sign off not being achieved during testing; full details of the outstanding issues will be provided. If any amendments are made to the third party software after certification has been issued, retesting will have to take place. Once live with PAYware Ocius Sentinel, merchants will be supported by the Merchant Helpdesk, contact details for which are provided within Appendix A.
4.2. Testing Values

To allow integrators to simulate responses which will need to be catered for within the integration, the following test values have been provided: Values ending in 2pence (e.g. 10.02) will simulate a Voice Referral Values ending in 5pence (e.g. 10.05) will simulate a Decline Values ending in 7pence (e.g. 10.07) will simulate Comms Down
Author ND
Phone 08444 828 200
Public
Version V1.15
4.3. Integration Methods

In an effort to provide a solution to suit a broad range of clients, PAYware Ocius Sentinel offers two integration methods. Please note: system integrators should select and utilise just one integration method for all message types. Mixed integrations can produce unexpected results and as such will not pass the integration testing process. 4.3.1. Socket Connection VeriFone recommend the use of IP Socket connections to integrate with PAYware Ocius Sentinel. The Point of Sale application must establish an IP socket connection with the PAYware Ocius Sentinel application via the appropriate port. Once established, the connection can be used to send and receive data during the transaction, providing the Point of Sale application with control over the transaction. The data sent by the POS is defined within Section 10 of this manual, for integration message details please see this section. The socket connection will be terminated by PAYware Ocius Sentinel once the requested operation has completed. The integrator should never break the socket connection as this will cause the transaction to be cancelled. If a socket connection is opened but no data transmitted within 20 seconds, PAYware Ocius will automatically disconnect the client. Each record sent to the terminal must be terminated by a carriage return line feed (CRLF), unless configured otherwise within the software. Each record received by PAYware Ocius will be acknowledged, by responding with an ASCII character of 0x06 (ACK). PAYware Ocius Sentinel is designed to communicate with one client at any one time; therefore, only a single integration client should be attached 4.3.2. Text File Text File integration is offered primarily for backward compatibility purposes. Whilst fully functional, VeriFone do advise use of the IP Socket interface. A text file should be created, or created and then placed, within a pre-defined shared directory. The filename will need to confirm with any filename mask pre-configured within the PAYware Ocius Sentinel settings and must be 8 characters long, the default being T0000001.in. The filename would either be incremented for each subsequent transaction (T0000001 T9999999), or the existing T0000001.in file would be moved or removed from the directory and the same filename used for each transaction.
Author ND
Phone 08444 828 200
Public
Version V1.15
VeriFone strongly recommend that integrators with several different POS allocate file names to each POS. Once the .in file has been processed, a response will be created in the folder allocated in the form of an .out file. This should then be read in and any necessary response sent using another .in file. It is essential that the same file name is used during the entire transaction processing cycle. Once in use the same file name must not be allocated to another transaction, failure to do so will result in incorrect operation. Therefore the response to a T0000001.in file will be T0000001.out.
4.4. Integration Version

When configuring PAYware Ocius Sentinel, within the program settings file (Program.Settings.ccf), there is an option to configure the Integration Version. This controls the format of the integrated response which will be returned to the POS. By default this is configured to 1 (Initial) and will need to be changed to 2 (Version2) should the POS require data to be returned to include any DCC or Account On File transaction details, such as token identifier. When making use of the ability to return the Card Number Hash as part of the transaction output message, the Version3 iteration will be required. This can be configured within the settings by amending the value to 3. Procurement Card Data can be passed as part of the transaction request message, and should this functionality be utilised the integration version will need to be amended. In this instance, the integration version value will need to be set to 4. Discretional Data can be returned within the transaction response message when the Integration Version is set as 5. When utilising the Pennies charity donation functionality, the Integration Version will need to be configured to 6. This will result in the Charity Donation Value, Charity Donation Merchant Number and Original Charity Donation Value being returned within the Transaction Response message. For more information on configuring the settings file, please consult the latest version of the PAYware Ocius Sentinel Installation Manual.
Author ND
Phone 08444 828 200
Public
Version V1.15
4.5. Ocius.ini File

To customise the integration it is possible to create an Ocius.ini file to supply startup parameters to PAYware Ocius Sentinel. Once launched, the contents of the file are interrogated and can trigger desired effects with regards to how the application behaves. This file is not built by the software installer, and will therefore need to be created by the integrator if required. It should be placed in the folder C:\Program Files\Commidea\Ocius Sentinel. Each parameter used should be separated by a carriage return and line feed.
Parameter /AL Usage Optional Description of effect Auto-Login The application will load straight into the Login ID screen, skipping the Press Enter To Start Communications and Setup F4 prompts. Disables the customer receipt screen and automatically completes processing. This option can only be used if the Integrator can show evidence that they can use the reprint command which is REP,101, else cardholder voucher reprints are not possible in any other way with this feature enabled. Where XXX is the ASCII representation of a printer control code used for paper cutting at the end of a voucher print. This may or may not be required depending on how the system is configured. Refer to printer manufactures guidelines for more information. Disables the function button on the PAYware Ocius Sentinel form (House Icon). Disables PED Polling when PAYware Ocius Sentinel is on the idle screen Forces PAYware Ocius Sentinel to become visible during the logout process when running in minimised mode. Configures PAYware Ocius Sentinel to produce extended log files. This should be used for trouble shooting purposes only, and will create extremely large log files. Enable extended voucher to be printed. Support for this functionality is Mandatory to pass Integration Testing as it may be required for troubleshooting purposes in both live and test environments. Allows for selecting the desired receipt printer, without the need to manually select the device from within the setup menus. If used, this setting will override any selected device, else that stored within the configuration files will be used. <Printer> = The full Printer Name as configured within windows e.g.: /PRINTER:EPSON TM-T88IIR Partial Cut This can also include the network path/IP address if its a shared device on the network: /PRINTER:\\10.0.0.1\Epson TM-T88IIR Partial Cut Specifies the path on the system where PAYware Ocius Sentinel will output a file to be used for POS voucher printing. The default is C:\. Please refer to the PAYware Ocius Sentinel Installation Guide for information on how configuring the voucher output location. Sets the RAW printing mode when printing to Windows Printers. This may significantly speed up the voucher printing process, but does remove all formatting (fonts, bold, size etc) as the data is passed as
/CRECNODISP
Optional
/CUTCMD:xxx
Optional
/DISABLEFUNCTION /DISABLEPEDPOLLING /ENABLEVISIBLELOGOUT /EXTENDLOG
Optional Optional Optional Optional
/EXTVCH
Mandatory
/PRINTER:<Printer>
Optional
/PRNPATH:<path>
Optional
/RAW
Optional
Author ND
Phone 08444 828 200
Public
Version V1.15
/SKIPSTARTCONNFAIL
Optional
/STARTMINIMISED
Optional
standard ASCII text. It is possible that auto-cutters on receipt printers may not work in this mode. Skips the connection failed message when PAYware Ocius Sentinel is launched if no internet connection is available for the updates to be performed. The result is that PAYware Ocius Sentinel logs into the Main Menu straightaway. PAYware Ocius Sentinel will start minimised to the taskbar when this parameter is used.
An example of an Ocius.ini file:
As with all changes made to settings files, any change made to this file will only take effect once the software has been restarted.
Author ND
Phone 08444 828 200
Public
Version V1.15
4.6. Receipt Printing

PAYware Ocius Terminals are generically certified within the UK and as such the receipts produced form part of the accreditation the contents and layout are all predetermined. Please note that when making changes to receipts, even from an existing integration which has been certified by VeriFone, that it is necessary to contact Implementations for re-approval. With PAYware Ocius Sentinel, there are various receipt printing options, which also includes the ability to output the receipts to a text file or an XML file. 4.6.1. Text File When printing to text file, PAYware Ocius Sentinel outputs the receipt to a text file on the point of sale in a preconfigured location. This is preferable in scenarios whereby merchants have requirements to produce receipts containing more information than that produced by PAYware Ocius, for example details of the product or service purchased. The entire contents of the text file are mandatory and the receipts produced by PAYware Ocius form part of the generic certification of the solution. The text file receipt produced by PAYware Ocius Sentinel is formatted and this should not be changed. If using the information within the file to build custom receipts then the information provided in this receipt should only be added to, and not amended.
Author ND
Phone 08444 828 200
Public
Version V1.15
4.6.2. XML File When printing to XML file with PAYware Ocius Sentinel, all information is exported and displayed in field elements. The XML data output contains a wide array of additional, option information. Mandatory fields are marked in the table below and are required in order to maintain acquirer certification for the solution. Please note: Acquirer accreditation will be required for any merchant wishing to use the XML receipt option. The only exception to this being; if the XML receipts are built to exactly represent the text file format. Please contact Implementations if you have any queries on this - no solution using XML receipts will be passed for live processing until the acquirer confirmation is gained. Changes to the content of the XML File are mandated by schemes at which time VeriFone will need to make amendments or additions to the file; for this reason the integrator must accept that updates to their application may be required in this regard in the future. The following table describes each field in the XML receipt layout; all required fields must be printed in order to pass integration testing.
Field AC AID AIP Amount AmtO AppEff AppExp AppSeq ATC AuthCode AuthOnly CAPK CaptureMethod CardAVN CardHolder CardScheme Cashback CID ContAuth CreditDebitMessage CryptoTxnType CurrencyAbbreviation CurrencySymbol CustomerPresent CVM CVMR DDOL DisableCurrencySymbol Duplicate Ecommerce Description Application cryptogram Correlates to AID used to process chip and PIN card Application interchange profile Transaction amount Amount other ICC app effective date ICC app expiry date ICC app sequence Application transaction counter Authorisation code If the transaction is auth only Certification Authority Public Key Capture method used to obtain card information Card Application Version Number The cardholder name Card scheme name Cashback value Cryptogram identifier If the transaction is continuous auth or not Credit debit message displayed on the receipt Cryptogram transaction type EUR/GBP/USD (See Appendix for further information) , , $ If the customer is present or not when the transaction was processed Cardholder verification method (text) Cardholder verification method (numbers) Dynamic data authentication data object list Duplicate receipt or not Txn is Ecommerce or not
Required Mandatory Mandatory Mandatory Mandatory (Or <ExpiryDate>) Mandatory Mandatory
Mandatory
Mandatory
Mandatory Mandatory Mandatory
Author ND
Phone 08444 828 200
Public
Version V1.15
EFTSN ExpiryDate ExtendedReceipt FloorLimit Footer Gratuity GratuityBoxRequired Header IACDef IACDen IACOnl IAD IssueNo KeepText1 KeepText2 MCC MID PAN PinEntered PTID ReceiptType Reference StartDate TACDef TACDen TACOnl TCtry TDOL TID Total TrainingMode TSI TVR TxnDateTime TxnType UN
The EFTSN The expiry date If extended receipt or not Scheme floor limit Receipt footer Gratuity value Whether to print the gratuity box for customer to fill in Receipt header (to contain Merchant Name and Address) Issuer Action Code Default Issuer Action Code Denial Issuer Action Code Online Issuer Application Data Card issue number This the text in the receipts centre (e.g. Please keep this for your records) This the text in the receipts centre (e.g. Please keep this for your records) Merchant Category Code Merchant ID Primary Account Number (card number) Whether the PIN was entered or not (PIN Verified) Permanent terminal identifier Merchant signature / Merchant declined / Merchant void Reference number Card start date Terminal action code Default Terminal action code denial Terminal action code online Terminal country code Transaction Certificate Data Object List Terminal Identifier Total transaction value Training mode transaction or not Transaction Status information Terminal verification result Transaction date / time Transaction type (Sale/Refund) Unpredictable number
Mandatory (Or <AppExp>)
Mandatory
Mandatory
Mandatory Mandatory Mandatory
Mandatory Mandatory Mandatory Mandatory
Mandatory Mandatory
Mandatory Mandatory
The below are a set of guidelines to be used for the layout for different cardholder interfaces (CVM Cardholder Verification Method): - Signature CVM Space for cardholder's signature. (merchant copy only) Cardholder declaration wording: (variable, both copies) Your account will be debited/credited with the above amount' Transaction confirmed' ------------------------' Cardholder signature' - PIN CVM Cardholder declaration wording: (variable) Your account will be debited/credited with the above amount' PIN verified
Author ND
Phone 08444 828 200
Public
Version V1.15
- No CVM Cardholder declaration wording: (variable) Your account will be debited/credited with the above amount' No Cardholder verification - Along with Information to advise cardholder to retain the receipt: (variable) Please keep this copy for your records Thank you message (optional to the merchant) In the event of a dual CVM (PIN & Signature) the line PIN verified should be inserted in the Signature CVM prior to the line Transaction confirmed. Transactions cancelled after the receipt or voucher has been printed should overprint the original voucher, or reprint the original receipt with the words CANCELLED, VOID or XXXXXXXXXs in a prominent position. For Mail Order / Telephone Order transactions where the customer is not present a receipt should still be produced and either Mail Order or Telephone Order written in the space for the customer signature. As detailed above, please note that all merchant owned terminals must truncate the PAN on the cardholder copy of the transaction receipt with immediate effect.
Author ND
Phone 08444 828 200
Public
Version V1.15
4.6.1. Receipt Format XML Mapping In order to provide guidance for integrators when producing receipts using the XML file, three different receipts type are detailed below, with the XML fields which contain the data outlined alongside each receipt:
Cashback:
<Header> --------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Cashback: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: AID: App Eff: App Seq: <AppExp>
<Amount> <Cashback> <Total>
<PTID> <MID> <TID> <TxnDateTime> <EFTSN> <AuthCode> <Reference> <AID> <AppEff> <AppSeq>
--------------------------------------------<Footer>
<Header> --------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Cashback: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: AID: App Eff: App Seq: <AppExp>
<Amount> <Cashback> <Total>
--------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
Chip & PIN:
<Header> --------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: AID: App Eff: App Seq: <AppExp>
<Amount> <Total>
--------------------------------------------<Footer>
<Amount> <Total>
--------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
Decline:
<Header> --------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Ref: AID: App Eff: App Seq: <AppExp>
<Amount> <Total>
<PTID> <MID> <TID> <TxnDateTime> <EFTSN> <Reference> <AID> <AppEff> <AppSeq>
--------------------------------------------<Footer>
<Header> --------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Ref: AID: App Eff: App Seq: <AppExp>
<Amount> <Total>
<PTID> <MID> <TID> <TxnDateTime> <EFTSN> <Reference> <AID> <AppEff> <AppSeq>
--------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
Gratuity:
<Header> --------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Gratuity: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: AID: App Eff: App Seq: <AppExp>
<Amount> <Gratuity> <Total>
--------------------------------------------<Footer>
<Header> --------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Gratuity: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: AID: App Eff: App Seq: <AppExp>
<Amount> <Gratuity> <Total>
--------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
ICC Signature:
<Header> --------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Total: PLEASE SIGN BELOW <AppExp>
<Amount> <Total>
-------------------------------------------------<KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: AID: App Eff: App Seq: <PTID> <MID> <TID> <TxnDateTime> <EFTSN> <AuthCode> <Reference> <AID> <AppEff> <AppSeq>
--------------------------------------------<Footer>
<Amount> <Total>
--------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
Keyed Cardholder Not Present:
<Header> -------------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: <ExpiryDate>
<Amount> <Total>
<PTID> <MID> <TID> <TxnDateTime> <EFTSN> <AuthCode> <Reference>
-------------------------------------------------<Footer>
<Header> -------------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: <ExpiryDate>
<Amount> <Total>
-------------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
No Cardholder Verification Method (CVM):
<Amount> <Total>
--------------------------------------------<Footer>
<Amount> <Total>
--------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
PIN & Signature:
<Amount> <Total>
--------------------------------------------<Footer>
<Amount> <Total>
--------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
Refund:
<Amount> <Total>
--------------------------------------------<Footer>
<Amount> <Total>
--------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
Swiped Cardholder Present:
<Header> -------------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Total: PLEASE SIGN BELOW <AppExp>
<Amount> <Total>
-------------------------------------------------<KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: <PTID> <MID> <TID> <TxnDateTime> <EFTSN> <AuthCode> <Reference>
-------------------------------------------------<Footer>
<Header> -------------------------------------------------<CardScheme> <PAN> Expiry: <CaptureMethod> <TxnType> <CreditDebitMessage> Amount: Total: <CVM> <KeepText1> <KeepText2> PTID: MID: TID: Date/Time: EFTSN: Authcode: Ref: <AppExp>
<Amount> <Total>
-------------------------------------------------<Footer>
Author ND
Phone 08444 828 200
Public
Version V1.15
VeriFone recommends that best practice when controlling receipt formatting would be to interrogate the <CaptureMethod> field and to amend the layout of the receipt accordingly. E.g. when the capture method is Swiped, the merchant receipt will need to include PLEASE SIGN BELOW and space for the cardholder to sign.
Author ND
Phone 08444 828 200
Public
Version V1.15
4.6.1. Dynamic Currency Conversion (DCC) When processing a DCC transaction, prior to authorisation, the cardholder is asked to confirm that they are happy with the rate of exchange being offered and are given the option to pay in the original currency or the transaction currency. A receipt is produced at this stage, as well as on-screen prompts being displayed for the cardholder to respond to (to select which currency is desired). When using Text Files to produce receipts, the currency rates information will be printed to text file and, once printed, should be passed to the cardholder along with their receipt. This currency printout is outputted to a Report.txt file within the preconfigured report output folder, and should be collected and printed from this location. An example of DCC text receipt is included below: Merchant Receipt
###################DefaultMerchantHeader################### P:PW001106 T:T:20420001 M:6819049 24/11/2011 11:54:39 ------------------------------Visa ************0006 Expiry: 12/12 KEYED CP SALE Please debit my account AMOUNT 10.00 TOTAL 10.00 ------------------------------Please Sign Below
------------------------------Please Keep This Receipt For your Records EFTSN: 1150 Auth Code: 789DE Ref: ###################DefaultMerchantFooter###################
Author ND
Phone 08444 828 200
Public
Version V1.15
Customer Receipt
###################DefaultCustomerHeader################### P:PW001106 T:****0001 M:**19049 24/11/2011 11:54:39 ------------------------------Visa ************0006 KEYED CP SALE Please debit my account AMOUNT 10.00 TOTAL 10.00 SIGNATURE VERIFIED ------------------------------Please Keep This Receipt For your Records Auth Code: 789DE Ref: ###################DefaultCustomerFooter###################
An example of DCC receipts in XML format is included below to aid integrations: Merchant Receipt
<?xml version="1.0" encoding="utf-8"?> <VoucherDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <TrainingMode>false</TrainingMode> <ReceiptType>Signature</ReceiptType> <Header>###################DefaultMerchantHeader###################</Header> <PTID>PW001106</PTID> <TID>20420001</TID> <MID>6819049</MID> <mkTransactionID>3977914</mkTransactionID> <TxnDateTime>2011-11-25T10:17:08.2775612+00:00</TxnDateTime> <CardScheme>Visa</CardScheme> <PAN>************0006</PAN> <ExpiryDate>12/12</ExpiryDate> <TxnType>Sale</TxnType> <CaptureMethod>KEYED</CaptureMethod> <CustomerPresent>true</CustomerPresent> <ECommerce>false</ECommerce> <ContAuth>false</ContAuth> <AccountOnFile>false</AccountOnFile> <PinEntered>false</PinEntered> <CreditDebitMessage>Please debit my account</CreditDebitMessage> <CurrencySymbol>JPY</CurrencySymbol> <CurrencyAbbreviation>JPY</CurrencyAbbreviation> <Amount>19100</Amount> <Total>19100</Total> <CVM>Please Sign Below</CVM> <KeepText1>Please Keep This Receipt</KeepText1> <KeepText2>For your Records</KeepText2> <EFTSN>1021</EFTSN> <AuthCode>789DE</AuthCode>
Author ND
Phone 08444 828 200
Public
Version V1.15
<Footer>###################DefaultMerchantFooter###################</Footer> <GratuityBoxRequired>false</GratuityBoxRequired> <ExtendedReceipt>false</ExtendedReceipt> <DisableCurrencySymbol>false</DisableCurrencySymbol> <AuthOnly>false</AuthOnly> <CardSchemePrintText /> <PrintAttempts>1</PrintAttempts> <ContactlessMSD>false</ContactlessMSD> <DCCDetails> <OriginalTransactionValue>100.00</OriginalTransactionValue> <OriginalGratuityValue>0.00</OriginalGratuityValue> <OriginalCashbackValue>0.00</OriginalCashbackValue> <OriginalTotalValue>100.00</OriginalTotalValue> <OriginalCurrencySymbol></OriginalCurrencySymbol> <OriginalCurrencyAbbreviation>GBP</OriginalCurrencyAbbreviation> <OriginalCurrencyDecimalPlaces>0</OriginalCurrencyDecimalPlaces> <DCCConversionRateApplied>191.00000</DCCConversionRateApplied> <DCCCommissionFee>0.00000</DCCCommissionFee> <DCCMarkUpFee>2.99000</DCCMarkUpFee> <ReceiptDisclaimer>CARDHOLDER HAS CHOSEN TO PAY IN JPY. THIS TRANSACTION IS BASED ON REUTERS WHOLESALE INTERBANK EXCHANGE RATE PLUS 2.99 PERCENT INTERNATIONAL CONVERSION MARGIN. THIS IS NOT AN ADDITIONAL FEE AND REPLACES CURRENCY CONVERSION CHARGES NORMALLY APPLIED. MY CHOICE IS FINAL. TRANSACTIONS CAN ALSO BE CONDUCTED IN GBP. THE CURRENCY CONVERSION SERVICE IS PROVIDED TO THE MERCHANT BY FEXCO DCC IN ASSOCIATION WITH Barclays Merchant Services.</ReceiptDisclaimer> </DCCDetails> <TokenRegistrationResult>NotSet</TokenRegistrationResult> <TokenRegistrationOnly>false</TokenRegistrationOnly> </VoucherDetails>
Customer Receipt
<?xml version="1.0" encoding="utf-8"?> <VoucherDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <TrainingMode>false</TrainingMode> <ReceiptType>Customer</ReceiptType> <Header>###################DefaultCustomerHeader###################</Header> <PTID>PW001106</PTID> <TID>20420001</TID> <MID>6819049</MID> <mkTransactionID>3977914</mkTransactionID> <TxnDateTime>2011-11-25T10:17:08.2775612+00:00</TxnDateTime> <CardScheme>Visa</CardScheme> <PAN>************0006</PAN> <ExpiryDate>12/12</ExpiryDate> <TxnType>Sale</TxnType> <CaptureMethod>KEYED</CaptureMethod> <CustomerPresent>true</CustomerPresent> <ECommerce>false</ECommerce> <ContAuth>false</ContAuth> <AccountOnFile>false</AccountOnFile> <PinEntered>false</PinEntered> <CreditDebitMessage>Please debit my account</CreditDebitMessage> <CurrencySymbol>JPY</CurrencySymbol> <CurrencyAbbreviation>JPY</CurrencyAbbreviation> <Amount>19100</Amount> <Total>19100</Total> <CVM>SIGNATURE VERIFIED</CVM> <KeepText1>Please Keep This Receipt</KeepText1> <KeepText2>For your Records</KeepText2> <EFTSN>1021</EFTSN>
Author ND
Phone 08444 828 200
Public
Version V1.15
<AuthCode>789DE</AuthCode> <Footer>###################DefaultCustomerFooter###################</Footer> <GratuityBoxRequired>false</GratuityBoxRequired> <ExtendedReceipt>false</ExtendedReceipt> <DisableCurrencySymbol>false</DisableCurrencySymbol> <AuthOnly>false</AuthOnly> <AcquirerPrintText /> <CardSchemePrintText /> <PrintAttempts>1</PrintAttempts> <ContactlessMSD>false</ContactlessMSD> <DCCDetails> <OriginalTransactionValue>100.00</OriginalTransactionValue> <OriginalGratuityValue>0.00</OriginalGratuityValue> <OriginalCashbackValue>0.00</OriginalCashbackValue> <OriginalTotalValue>100.00</OriginalTotalValue> <OriginalCurrencySymbol></OriginalCurrencySymbol> <OriginalCurrencyAbbreviation>GBP</OriginalCurrencyAbbreviation> <OriginalCurrencyDecimalPlaces>0</OriginalCurrencyDecimalPlaces> <DCCConversionRateApplied>191.00000</DCCConversionRateApplied> <DCCCommissionFee>0.00000</DCCCommissionFee> <DCCMarkUpFee>2.99000</DCCMarkUpFee> <ReceiptDisclaimer>CARDHOLDER HAS CHOSEN TO PAY IN JPY. THIS TRANSACTION IS BASED ON REUTERS WHOLESALE INTERBANK EXCHANGE RATE PLUS 2.99 PERCENT INTERNATIONAL CONVERSION MARGIN. THIS IS NOT AN ADDITIONAL FEE AND REPLACES CURRENCY CONVERSION CHARGES NORMALLY APPLIED. MY CHOICE IS FINAL. TRANSACTIONS CAN ALSO BE CONDUCTED IN GBP. THE CURRENCY CONVERSION SERVICE IS PROVIDED TO THE MERCHANT BY FEXCO DCC IN ASSOCIATION WITH Barclays Merchant Services.</ReceiptDisclaimer> </DCCDetails> <TokenRegistrationResult>NotSet</TokenRegistrationResult> <TokenRegistrationOnly>false</TokenRegistrationOnly> </VoucherDetails>
4.6.2. Barclaycard Gift To provide receipt information for Barclaycard Gift transactions, PAYware Ocius Sentinel has specific fields returned for these transactions. An example of these receipts is included below to aid integrations: Merchant Receipt
<?xml version=1.0 encoding=utf-8?> <BarclaysGiftReceiptDetails xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd=http://www.w3.org/2001/XMLSchema> <Header>Test</Header> <Footer>Thank You</Footer> <PTID>PW000045</PTID> <TID>04380001</TID> <MID>99800000001</MID> <GiftCardNumber>************2200</GiftCardNumber> <OriginalTransactionID>0</OriginalTransactionID> <mkBarclaysGiftTransactionID>962</mkBarclaysGiftTransactionID> <TransactionDateTime>2011-11-08T10:58:00.2577368+00:00</TransactionDateTime> <CurrencySymbol></CurrencySymbol> <CurrencyAbbreviation>GBP</CurrencyAbbreviation> <PreviousBalance>0.00</PreviousBalance> <TxnAmount>100.00</TxnAmount> <RemainingBalance>100.00</RemainingBalance>
Author ND
Phone 08444 828 200
Public
Version V1.15
<PIN /> <AuthCode>004579000</AuthCode> <ReceiptType>Merchant</ReceiptType> <Message /> <TransactionType>NewCard_TopUp</TransactionType> <PrintAttempts>1</PrintAttempts> <MessageNumber>0132</MessageNumber> <DisableCurrencySymbol>true</DisableCurrencySymbol> <CaptureMethod>Swiped</CaptureMethod> <Reference>1234</Reference> </BarclaysGiftReceiptDetails>
Customer Receipt
<?xml version=1.0 encoding=utf-8?> <BarclaysGiftReceiptDetails xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd=http://www.w3.org/2001/XMLSchema> <Header>Test</Header> <Footer>Thank You</Footer> <PTID>PW000045</PTID> <TID>04380001</TID> <MID>99800000001</MID> <GiftCardNumber>6280390007672200</GiftCardNumber> <OriginalTransactionID>0</OriginalTransactionID> <mkBarclaysGiftTransactionID>962</mkBarclaysGiftTransactionID> <TransactionDateTime>2011-11-08T10:58:00.2577368+00:00</TransactionDateTime> <CurrencySymbol></CurrencySymbol> <CurrencyAbbreviation>GBP</CurrencyAbbreviation> <PreviousBalance>0.00</PreviousBalance> <TxnAmount>100.00</TxnAmount> <RemainingBalance>100.00</RemainingBalance> <PIN /> <AuthCode>004579000</AuthCode> <ReceiptType>Customer</ReceiptType> <Message /> <TransactionType>NewCard_TopUp</TransactionType> <PrintAttempts>1</PrintAttempts> <MessageNumber>0132</MessageNumber> <DisableCurrencySymbol>true</DisableCurrencySymbol> <CaptureMethod>Swiped</CaptureMethod> <Reference>1234</Reference> </BarclaysGiftReceiptDetails>
Author ND
Phone 08444 828 200
Public
Version V1.15
4.6.3. Transax SV To provide receipt information for Transax SV transactions, PAYware Ocius Sentinel has specific fields returned for these transactions. An example of the receipts information is included below to aid integrations:
<VoucherDetails> <Header>Test</Header> <PTID>PW345678</PTID> <MID>12345678</MID> <TID>87654321</TID> <TransactionDateTime>2011-09-29 17:06:23.394</TransactionDateTime> <CardScheme>CardSchemeName</CardScheme> <CardNumber>************3505</CardNumber> <ExpiryDate>1013</ExpiryDate> <IssueNumber>1</IssueNumber> <TransactionType>Sale</TransactionType> <CaptureMethod>Swiped</CaptureMethod> <Amount>10.00</Amount> <CurrencySymbol></CurrenctSymbol> <CurrencyExponent>2</CurrencyExponent> <CurrencyDecimalPointCharacter>.</CurrencyDecimalPointCharacter> <CurrencyAbbreviation>GBP</CurrencyAbbrevaiation> <TransactionResult>AUTHORISED</TransactionResult> <TransactionID>1234</TransactionID> <AuthorisationCode>123456</AuthorisationCode> <MerchantReference>Test1</MerchantReference> <DisableCurrencySymbol>True</DisableCurrecnySymbol> <ReceiptType>Merchant</ReceiptType> <AcquirerResponseCode>00</AcquirerResponseCode> <PrintAttempts>1</PrintAttempts> <AmountDisplay>AMOUNT</AmountDisplay> <DebitRefundMessage>Please Debit My Account</DebitRefundMessage> <Message>AUTH CODE: 123456 BAL:10.00</Message> <SignatureVerificationResult>SIGNATURE VERIFIED</SignatureVerificationResult> </VoucherDetails>
Author ND
Phone 08444 828 200
Public
Version V1.15
4.6.4. Pennies To provide receipt information for Pennies transactions, PAYware Ocius Sentinel has specific fields returned for these transactions. An example of the receipts information is included below to aid integrations: Merchant Receipt
<?xml version="1.0" encoding="utf-8"?> <VoucherDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <TrainingMode>false</TrainingMode> <ReceiptType>Merchant</ReceiptType> <Header>Test</Header> <PTID>PW000045</PTID> <TID>22270438</TID> <MID>21249872</MID> <mkTransactionID>2983057</mkTransactionID> <TxnDateTime>2012-01-18T15:38:29.5349028+00:00</TxnDateTime> <CardScheme>VISA BARCLAYCARD</CardScheme> <PAN>************0002</PAN> <TxnType>Sale</TxnType> <CaptureMethod>ICC</CaptureMethod> <CustomerPresent>true</CustomerPresent> <ECommerce>false</ECommerce> <ContAuth>false</ContAuth> <AccountOnFile>false</AccountOnFile> <PinEntered>true</PinEntered> <CreditDebitMessage>Please debit my account</CreditDebitMessage> <CurrencySymbol></CurrencySymbol> <CurrencyAbbreviation>GBP</CurrencyAbbreviation> <Amount>1.02</Amount> <Total>2.00</Total> <CVM>PIN VERIFIED</CVM> <KeepText1>Please Keep This Receipt</KeepText1> <KeepText2>For your Records</KeepText2> <EFTSN>2624</EFTSN> <AuthCode>789DE</AuthCode> <Reference>Normal</Reference> <AID>A0000000031010</AID> <AppEff>0402</AppEff> <AppSeq>00</AppSeq> <AppExp>0308</AppExp> <CryptoTxnType>00</CryptoTxnType> <CID>40</CID> <CardHolder>BMSTESTCARDO5603/O </CardHolder> <CVMR>410302</CVMR> <TSI>E800</TSI> <TVR>40C0000000</TVR> <IACDef>4040488000</IACDef> <IACDen>1010A00060</IACDen> <IACOnl>40E84C9800</IACOnl> <AC>CB93F502E701D49F</AC> <AIP>5C00</AIP>
Author ND
Phone 08444 828 200
Public
Version V1.15
<CardAVN>0084</CardAVN> <FloorLimit>5.00</FloorLimit> <TDOL>9F02065F2A029A039C0195059F3704</TDOL> <DDOL>9F3704</DDOL> <MCC>2701</MCC> <CAPK>A0000000031010.99</CAPK> <TACDef>DC4000A800</TACDef> <TACDen>0010000000</TACDen> <TACOnl>DC4004F800</TACOnl> <IAD>06FE0A0364AD00</IAD> <ATC>0388</ATC> <AmtO>0.00</AmtO> <UN>203ADAA0</UN> <TCtry>826</TCtry> <Footer>Thank You</Footer> <GratuityBoxRequired>false</GratuityBoxRequired> <ExtendedReceipt>false</ExtendedReceipt> <DisableCurrencySymbol>true</DisableCurrencySymbol> <AuthOnly>false</AuthOnly> <CardSchemePrintText /> <PrintAttempts>1</PrintAttempts> <ContactlessMSD>false</ContactlessMSD> <TokenRegistrationResult>NotSet</TokenRegistrationResult> <TokenRegistrationOnly>false</TokenRegistrationOnly> <TransactionCurrencyCode>826</TransactionCurrencyCode> <CharitableDonation>0.98</CharitableDonation> <CharitableDonationReceiptText>CHARITY DONATION RECEIPT TEXT</CharitableDonationReceiptText> </VoucherDetails>
Author ND
Phone 08444 828 200
Public
Version V1.15
Customer Receipt
<?xml version="1.0" encoding="utf-8"?> <VoucherDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <TrainingMode>false</TrainingMode> <ReceiptType>Customer</ReceiptType> <Header>Test</Header> <PTID>PW000045</PTID> <TID>22270438</TID> <MID>21249872</MID> <mkTransactionID>2983057</mkTransactionID> <TxnDateTime>2012-01-18T15:38:29.5349028+00:00</TxnDateTime> <CardScheme>VISA BARCLAYCARD</CardScheme> <PAN>************0002</PAN> <TxnType>Sale</TxnType> <CaptureMethod>ICC</CaptureMethod> <CustomerPresent>true</CustomerPresent> <ECommerce>false</ECommerce> <ContAuth>false</ContAuth> <AccountOnFile>false</AccountOnFile> <PinEntered>true</PinEntered> <CreditDebitMessage>Please debit my account</CreditDebitMessage> <CurrencySymbol></CurrencySymbol> <CurrencyAbbreviation>GBP</CurrencyAbbreviation> <Amount>1.02</Amount> <Total>2.00</Total> <CVM>PIN VERIFIED</CVM> <KeepText1>Please Keep This Receipt</KeepText1> <KeepText2>For your Records</KeepText2> <EFTSN>2624</EFTSN> <AuthCode>789DE</AuthCode> <Reference>Normal</Reference> <AID>A0000000031010</AID> <AppEff>0402</AppEff> <AppSeq>00</AppSeq> <AppExp>0308</AppExp> <CryptoTxnType>00</CryptoTxnType> <CID>40</CID> <CardHolder>BMSTESTCARDO5603/O </CardHolder> <CVMR>410302</CVMR> <TSI>E800</TSI> <TVR>40C0000000</TVR> <IACDef>4040488000</IACDef> <IACDen>1010A00060</IACDen> <IACOnl>40E84C9800</IACOnl> <AC>CB93F502E701D49F</AC> <AIP>5C00</AIP> <CardAVN>0084</CardAVN> <FloorLimit>5.00</FloorLimit> <TDOL>9F02065F2A029A039C0195059F3704</TDOL> <DDOL>9F3704</DDOL> <MCC>2701</MCC> <CAPK>A0000000031010.99</CAPK>
Author ND
Phone 08444 828 200
Public
Version V1.15
<TACDef>DC4000A800</TACDef> <TACDen>0010000000</TACDen> <TACOnl>DC4004F800</TACOnl> <IAD>06FE0A0364AD00</IAD> <ATC>0388</ATC> <AmtO>0.00</AmtO> <UN>203ADAA0</UN> <TCtry>826</TCtry> <Footer>Thank You</Footer> <GratuityBoxRequired>false</GratuityBoxRequired> <ExtendedReceipt>false</ExtendedReceipt> <DisableCurrencySymbol>true</DisableCurrencySymbol> <AuthOnly>false</AuthOnly> <AcquirerPrintText /> <CardSchemePrintText /> <PrintAttempts>1</PrintAttempts> <ContactlessMSD>false</ContactlessMSD> <TokenRegistrationResult>NotSet</TokenRegistrationResult> <TokenRegistrationOnly>false</TokenRegistrationOnly> <TransactionCurrencyCode>826</TransactionCurrencyCode> <CharitableDonation>0.98</CharitableDonation> <CharitableDonationReceiptText>CHARITY DONATION RECEIPT TEXT</CharitableDonationReceiptText> </VoucherDetails>
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7. Integration Messages

All available record formats are detailed within this section, giving an understanding of how it is possible to customise integration to suit the requirements of the merchant. As aforementioned, each record sent to PAYware Ocius Sentinel must be formatted as a comma separate string of data and terminated by a carriage return line feed (CRLF), unless configured otherwise within the software. For more information please see the PAYware Ocius Sentinel Installation Guide, section 6. 4.7.1. Transaction Request (T Record) Detailed below is the format of the most frequently used record, the Transaction Record. This is used for initiating payment transactions with PAYware Ocius Sentinel. The T Record is followed by the output response generated after the transaction record has been processed. Please note that the format of the response returned by PAYware Ocius Sentinel is controlled by configuring the Integration Version.
Field 1 2 Name Message Type Account Number Type String Mandatory Description Identifier for the message type, which for transaction requests is: T This field is no longer used. Field 24, Account ID, is used to define the merchant parameter set to use. If populated this field will be ignored. 01 Purchase 02 Refund 04 Cash advance Available modifiers with PAYware Ocius Sentinel: 0000 Cardholder Present 0002 Offline (Capture) 0008 CNP Mail Order 0010 Authorisation Only 0040 Recovered Transaction (reserved for future use) 0080 Allow Zero Value Pre-Auth 0100 Unattended Device 0400 CPC Minus I and L Records 0800 Allow Electron CNP (Tele/Spread-betting) 1000 CNP Telephone Order 2000 CNP Account On File Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Total value of the transaction applies to: Purchase, Refund, Cheque Guarantee, and Cash Advance. Provision of the decimal point is recommended although optional. For example: 1.23 = 1.23 123=123.00, 000001.2389 = 1.23. Values should always be positive, and will be truncated to
Transaction Type
Integer Mandatory Integer Mandatory
Modifier
5 6 7 8 9 10 11
PoS Routing / Bill ID PAN / Track 2 CSC Expiry Date Issue No Start Date Txn Value
Integer Mandatory
Author ND
Phone 08444 828 200
Public
Version V1.15
12 13 14 15 16 17 18 19 20 21 22 23
Cash Back Value Bank Acc No Sort Code Cheque No Cheque Type Cardholder Name Cardholder Billing Address EFTSN Auth Source Auth Code Txn Date Time Reference
String Optional
24 25 26
Account ID Gratuity NDI Value
String Optional Integer Optional
the correct number of decimal places required for the currency. For example: 1.23 = 1 (one Japanese Yen) (0 decimal places)). Reserved for future use (not currently supported) Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reserved, leave empty Reference numbers can be supplied up to a maximum length of 50 characters. When forwarded to the acquirer these are truncated to 25 characters Defines merchant parameter set to be used Reserved for future use (not currently supported) Non Discounted Items this value field is available to define how much of the transaction value is not applicable for the cardholder to earn rewards against. If no value is supplied, this field will default to 0.00 and the cardholder will earn rewards against the full value of the transaction (from Txn Value field). Available when Barclaycard Freedom value added service is enabled Defines Account On File Registration. Supported values are: 0 Not Set 1 Do Not Register 2 Register 3 Register Only* 4 Register, decline transaction if registration fails *When performing a Register Only registration, the value of the transaction must be set to 0.00 and a modifier of 0000 (Cardholder Present) used Token ID value if processing an Account On File Payment Field to indicate whether the charitable donation should be suppressed. This functionality is designed to allow the retailer to account for scenarios whereby the transaction needs to be repeated and that the cardholder should not be prompted again. Valid values are: 0 Not Set 1 Suppress
27
Register For Account On File
Integer
28 29
Token ID Suppress Charitable Donation
Integer Integer
Please note that additional fields may be required in order to support Procurement Card Processing and these are described within a Procurement Card Specification available separately.
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7.2. Transaction Response (Initial)

Field 1 Name Result Type Integer Description Transaction result: 0 Completed 7 Declined -nn All other negative values are used to define error conditions Appendix B contains a full list of error codes and messages. Screenless transaction results: 0 Completed 2 Referred 5 Declined 6 Authorised 7 Reversed 8 Comms Down -nn Negative values are used to define error conditions Reserved, Ignore Values will be truncated to the correct number of decimal places required for the transaction currency. For example: 1.23 = 1 (one Japanese Yen) Field will show total that will be debited As above As above The Primary Account Number (Card Number). Please note: This value will not be returned in full due to PCI requirements. The PAN will be masked apart from the last four digits, e.g. ************1234 Card Expiry Month and Year. Card Issue Number. Blank when scheme does not provide an issue number. Card start month and year. CCYYMMDDHHMMSS The Merchant Number for the given card scheme and account. Terminal ID used for this transaction. Card scheme name Floor limit for the card scheme/account. Four digits in the range 0001 9999. (Prefixed with OL when offline) Blank if the transaction is declined or is below the floor limit. Reserved, ignore As returned by communications process. Normally direct from acquirer. Also contains status message if enabled
2 3
Terminate Loop Total Transaction Value Processed
Integer Integer
4 5 6
Cashback Value Gratuity Value PAN
Integer Integer Integer
7 8 9 10 11 12 13 14 15 16 17 18
Expiry Date MMYY Issue Number Start MMYY Transaction Date / Time Merchant Number Terminal ID Scheme Name Floor Limit EFT Sequence Number Authorisation Code Referral Telephone Number. Customer Verification Method / Authorisation Message / Error Message / Status Message
Integer Integer Integer Integer Integer Integer String Integer Integer String
String
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7.3. Transaction Response (Version2)

Field 19 Name Type Description First 18 fields are the same as Transaction Output Record (Initial) Capture Method String Valid values are: ContactlessEMV ContactlessMagswipe Swipe ICC Keyed Transaction Currency Code Currency Code associated with the transaction Original Transaction Value Transaction value based on the original base currency Original Cashback Value Cashback value based on the original base currency Original Gratuity Value Gratutiy Value based on the original base currency Original Transaction Currency Code Currency code associated with the base currency Barclaycard Freedom Discount Value Integer The value of discount, inclusive of any Campaigns or eCoupons, earned from the transaction (e.g. 4.00) Barclaycard Freedom Redemption Integer The total value redeemed against the transaction, using Value available Barclaycard Freedom rewards earned (e.g. 10.00) Account on File Registration Result Integer This is the result of the Account on File registration. Valid values are: 0 Not Set 1 Not Performed 2 Success 3 Failed Token ID String This is the token allocated to the payment details as part of the Account on File registration process or the token used for the Account on File payment. AVS Post Code Result Integer This is the result of any AVS post code checking. Valid values are: 0 Unknown 1 Not Checked 2 Matched 4 Not Matched 8 Reserved AVS House Number Result Integer This is the result of any AVS house number checking. Valid values are: 0 Unknown 1 Not Checked 2 Matched 4 Not Matched 8 Reserved CSC Result Integer This is the result of any CSC verification. Valid values are: 0 Unknown 1 Not Checked 2 Matched 4 Not Matched 8 Reserved
20 21 22 23 24 25 26
27
28
29
30
31
Author ND
Phone 08444 828 200
Public
Version V1.15

Field 32 Name Type Description Fields 19 to 31 are the same as Transaction Output Record (Version2) Card Number Hash String This is a SHA-256 hash of the PAN with a merchant specific salt (base64encoded binary)

Field 33 Name Type Description Fields prior to 33 are the same as Transaction Output Record (Version3) VGIS Reference String This is the VGIS reference generated if the transaction was flagged as a VGIS transaction (see Procurement Guide for further information)

Field 34 Name Type Description Fields prior to 34 are the same as Transaction Output Record (Version4) Track1 Discretionary String Data captured from the Track1 Discretionary Data field, e.g. Loyalty Data Card Number

Field 35 36 37 Name Type Description Fields prior to 35 are the same as Transaction Output Record (Version5) CharityDonationValue Decimal The donation value which has been incorporated as part of the transaction value CharityDonationMerchantNumber String The charitable donation provider allocated merchant number OriginalCharityDonationValue Decimal The donation value which has been incorporated as part of the transaction value prior to currency conversion being performed (if applicable)
Example (37 fields): 0,1,10.00,0.00,0.00,476173******0010,1215,,0709,20110526085049,6637599,28200004,ELEC TRON DE VISA,,1946,082595,,SIGNATURE VERIFIED,ICC,826,,,,,,,2,33206201,0,0,0,nuano/6UXPC6YRkGz3TayA+6kTY=,,,1.00,1.00,123 456,
Please note that the format of the response returned by PAYware Ocius Sentinel is controlled by configuring the Integration Version.
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7.8. Login Request (L2 Record) To provide the ability to log into PAYware Ocius Sentinel remotely via an integration message, the L2 record is available. The record, as well as containing the terminal user credentials, can be used to stipulate which menu structures are enabled for the operator.
Field 1 2 3 4 5 Name L2 (Upper Case) UserID PIN Menu Options SVS Store ID Type String Mandatory String Mandatory String Mandatory String Conditional VarChar Optional Description L2 Indicates an L2 format Login Record User ID User PIN See Menu Options below this table Field which provides the ability for the merchant to pass the SVS Store ID assigned by VeriFone to indicate the store where the terminal is located, as part of the login message. This information is used by PAYware Ocius Sentinel to link the PTID to the SVS Store, ensuring that the correct configuration is downloaded for each terminal. This is an optional field included for merchants utilising the SVS value added service Terminal name to associate with the terminal. If the name provided is longer than 50 characters then it will be truncated before being stored within the database. If a Terminal Name is not provided then the existing entry within the ICP Managed Service will not be amended. This is the ISO 3166 country code representing the country location of the terminal Please note: VeriFone do not recommend the use of the terminal country code field to update the terminal as this functionality is provided automatically by the merchant store association process. Menu Options: 1. New Transaction 2. Menu 1. Transaction Management 1. Reports 1. Live Store 2. X Report 3. Z Report 4. Session Report 5. Transaction Report 6. Summary Settlement Report 7. Detailed Settlement Report 8. Q Report 9. Stored Offline Txn Report 2. Submit Offline Txns 2. Reprint 1. Merchant Receipt 2. Customer Receipt 3. Last Report 3. System 1. Print Stored AID's
Terminal Name
String Optional
Terminal Country Code
String Optional
Author ND
Phone 08444 828 200
Public
Version V1.15
2. System Info 3. Voucher Type 1. Enabled 2. Disabled 4. Change Setup PIN 5. Download 4. Ordering 1. Product List 2. Place Order 5. User Management 1. Change User ID 2. Change User PIN 3. Change Stationary PIN 6. Terminal Management 1. ----2. Reboot Pinpad 3. ----3. Select Bill 1. Close Bill on POS 2. Get Bill 3. Get/Print Bill 4. Print Bill 4. Logoff 5. Other 1. [Reserved for Future Use] 2. PayPoint 3. Givex 4. MiVoucher 5. UKASH 6. GRTFS 7. Barclays Bonus 8. Barclays Gift 9. GTP
The options are listed by placing all those required in the fourth field of the record. For example, to include all the menus and their sub-menus (for a user with a Login ID and PIN of 1234): L2,1234,1234,* For more specific configurations, it is possible to only enable the operator access to the logout option. This would be achievable using the following record: L2,1234,1234,4 By including a 4, none of the other options are accessible. Leaving the fourth field blank would specify that no options would be available at all, rendering the application completely controlled by records from the POS. To control the sub menus as well a set of { } must be included after the option selected, and within the brackets list which sub options are utilisable. An example here would be where Select Bill is required, but only Print Bill to be available within the sub menu (option 4 of the four suboptions): L2,1234,1234,3 {4} 4
Author ND
Phone 08444 828 200
Public
Version V1.15
As with the previous example, for all sub options to be available then include {*} after the option. Not including anything will only allow the top menu to be accessed. The only exception to this rule is the New Transaction option, which is controlled using the permissions setup on the account. Please note: it is also possible to control user menu options by configuring a Permission Profile within WebCom. For instructions on how to do this, please refer to the WebCom manual
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7.9. Logout Request (O Record) When there is a requirement to logout of PAYware Ocius Sentinel, the O Record can be used to perform this action.
Field 1 Name O (Upper case) Function Type String Mandatory Integer Mandatory Description O Indicates Logout Record
0 Logout 1 Print Q Report and logout 2 Exit and logout 3 Exit and logout with Q report 4 Submit offline transactions, logout and shut down
A response is sent once the request has been processed, informing the integrated system of the result. As with the login record, a 0 record is received back to confirm a successful logout, or a -31 for a processing error. If attempting to logout when there is no user logged in, a -85 error message is received. 4.7.10. POS Progress/Customer Facing The POS Progress Message is sent to the POS either via a socket connection (set to port 25001 by default) or via a text file named StatusFile.txt, which is written to the TIPath as defined within the Program.Settings.ccf file when the solution is operating in Screenless Mode. For further information on amending these details please see the Installation Guide, which details amending the configuration files. When operating in this mode, PAYware Ocius Sentinel operates silently whilst minimised in the taskbar; therefore, in order for the integrated solution to react and provide information as required, the POS Progress message continually sends status messages which are monitored and can be responded to by sending a Continue Transaction record.
Field 1 2 3 4 5
Name Result Terminate Loop Status ID Status Parameters
Type Integer Integer Integer String String
Description This indicates the result code (100) Reserved, Ignore Status ID of the transaction. All responses listed below in separate table This is a text representation of the progress status This field will contain any information that the POS may require that is associated with that status. Each parameter will be ; delimited and will be defined as follows: <Name>=<Value> Here is a list of all possible parameters: TXN VALUE CASHBACK GRATUITY TOTAL AMOUNT AUTH CODE
Author ND
Phone 08444 828 200
Public
Version V1.15
VR TEL NO CARD EXPIRY MID TID FILENAME PROGRESS SCHEME ID MERCHANT NAME
Status ID Messages Listed below are all the available Status ID messages which could be returned by PAYware Ocius Sentinel, along with the parameters which may be returned. Please note: where the Status ID is described as Not Used the status is not returned by PAYware Ocius Sentinel.
Status ID 0 1 2 Description Processing Transaction Waiting For Gratuity Gratuity Being Entered Parameters / Not Used Not Used Enter Gratuity No message required [Informs POS that the gratuity is being entered on screen] Present Card / Insert Card Suggested on screen message to display to customer for each status:
Awaiting Card
Swipe Card
TXN VALUE CASHBACK VALUE GRATUITY VALUE TOTAL AMOUNT TXN VALUE CASHBACK VALUE GRATUITY VALUE TOTAL AMOUNT
Swipe Card / Remove Card
5 6 7 8 9 10
Card Inserted Card Removed Card Processing Change Card Contact Transaction Required Key In Card Details
Please Wait Please Wait Do Not Remove Card Use Alternative Payment Method Not Used TXN VALUE CASHBACK VALUE GRATUITY VALUE TOTAL AMOUNT Key Card Number
11 12 13
Waiting For Cashback Pin Entry Risk Management Complete
14 15 16 17 18 19
Authorising Transaction Waiting For Result Auth Result Received Printing Merchant Receipt Signature Confirmation Required Continue Required
Enter Cashback Enter PIN No message required [Informs POS that PIN has been entered/stage where PIN would be entered has been completed] Please Wait Please Wait Please Wait Please Wait Please Wait No message required [Informs POS that PAYware Ocius requires information] [Display all the information on screen to
20
Confirm Auth Code
AUTH CODE
Author ND
Phone 08444 828 200
Public
Version V1.15
21 22 23 24
Confirming Transaction Rejecting Transaction Final Result Received Voice Referral
VR TEL NO CARD EXPIRY MID TID Not Used Not Used FILENAME PROGRESS FILENAME PROGRESS Not Used Not Used
allow a Voice Referral to be processed; Merchant Number, Correct Bank Telephone Number and all transaction details] Please Wait Declined Please Wait Referral
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
Remove Card Auth Result Error Fallback To Swipe Disabled Downloading File Updating PED Invalid PED Configuration Card Data Retrieval Starting Transaction Performing Download Requesting Report Gratuity Selection Required Expiry Date Required Start Date Required Issue Number Required AVS House Number Required AVS Post Code Required CSC Required Customer Present / Not Present Selection Required Customer / Not Present Option Selection Required Enter Charge Auth Code Login Required
Remove Card
Loading Loading
Please Wait Loading Please Wait Not Used Expires MM/YY Valid From MM/YY Issue Number Enter House Number Enter Post Code Enter Card Security Code Customer Present? Yes/No
Not Used Not Used
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
Ready Card Not Accepted Card Blocked Transaction Cancelled Invalid Expiry Gratuity Invalid Invalid Card Printing Customer Receipt Initialising PED PED Unavailable Card Application Selection Retry Download Restart After Software Update Requesting DCC DCC Currency Choice Cardholder DCC Currency Choice Unsafe Download Unexpected Login Start Barclays Bonus
Enter Charge Auth Code No message required [Informs POS that PAYware Ocius is ready to be logged in] Ready Not Accepted Not Used Transaction Void Not Used Not Used Not Used Please Wait Please Wait No message required [Informs POS that the PED is unavailable] Select Payment Type No message required No message required Please Wait No message required Please select currency [include details of currency options] No message required No message required Not Used
Author ND
Phone 08444 828 200
Public
Version V1.15
65 66 67 68 69
Transaction Update Barclays Bonus Transaction Cancel Barclays Bonus Transaction Confirm Gratuity Register For Account On File Decision Awaiting Token ID
Not Used Not Used Not Used No message required TXN VALUE CASHBACK VALUE GRATUITY VALUE TOTAL AMOUNT Not Used Not Used Not Used Not Used No message required No message required No message required No message required No message required Invalid Amount Not Accepted No message required No message required Loading No message required No message required No message required No message required No message required No message required No message required No message required No message required No message required No message required No message required No message required No message required Please Wait No message required Please Wait No message required
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
Barclays Bonus Discount Summary Barclays Bonus Use Bonus Barclays Bonus Enter Redemption Barclays Bonus Not Available Download Complete Download Still Being Prepared Server Connection Failed Resume Download PayPoint Account Extraction Failed PayPoint Amount Outside Allowed Range PayPoint Card Expired PayPoint Initialised PayPoint Initialisation Failed PayPoint Initialising PayPoint Invalid Account PayPoint Invalid Amount PayPoint Invalid Capture Method PayPoint Invalid Card Number PayPoint Invalid Configuration PayPoint Invalid Denomination PayPoint Invalid Expiry Date PayPoint Invalid Scheme PayPoint Invalid Scheme Option PayPoint Invalid Top-up Type PayPoint Invalid Service Provider PayPoint Invalid Track2 Format PayPoint Invalid Transaction Type PayPoint Keyed Entry Not Allowed PayPoint Merchant Reference Required PayPoint No Accounts PayPoint Processing
Author ND
Phone 08444 828 200
Public
Version V1.15
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 131 132 133 134
Transaction PayPoint Retry Confirmation Decision PayPoint Scheme Not Recognised PayPoint Transaction Cancelled PayPoint Transaction Type Not Allowed PayPoint Select Scheme Option PayPoint Download Required PayPoint Select Account Printing PayPoint Receipt Licence Detail Confirmation Licence File Required Pay Point Service Unavailable Park Retail Gift Account Extraction Failed Park Retail Gift Amount Outside Allowed Range Park Retail Gift Card Expired Park Retail Gift Initialisation Failed Park Retail Gift Initialising Park Retail Gift Invalid Account Park Retail Gift Invalid Amount Park Retail Gift Invalid Capture Method Park Retail Gift Invalid Card Number Park Retail Gift Invalid Configuration Park Retail Gift Invalid Expiry Date Park Retail Gift Invalid Track2 Format Park Retail Gift Invalid Transaction Type Park Retail Gift Keyed Entry Not Allowed Park Retail Gift Merchant Reference Required Park Retail Gift No Accounts Park Retail Gift Service Unavailable Park Retail Gift Processing Transaction Park Retail Gift Scheme Not Recognised Park Retail Gift Select Account Park Retail Gift Transaction Cancelled Park Retail Gift Transaction Type Not Allowed
Please Wait Invalid Scheme Transaction Void Not Accepted SCHEME ID Select Scheme No message required No message required Printing Receipt Please Wait Loading
MERCHANT NAME
Author ND
Phone 08444 828 200
Public
Version V1.15
135 136 137
Printing Park Retail Gift Receipt PED In ESD Recovery 3 Mode Update Transaction Value Decision
CAPTUREMETHOD CARDDATA SCHEMENAME HASH TXNVALUE GRATUITYVALUE CBVALUE
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
3
Update Barclaycard Freedom Config Processing Key Exchange Barclays Gift Initialising Global Blue Tax Free Shopping Initialising GiveX Initialising M-Voucher Initialising Performing Post Confirm Reversal Invalid Amount Merchant Reference Required Merchant Reference Length Invalid Initialising Account Extraction Failed Amount Outside Allowed Range Enter Amount Confirm Authorisation Card Expired Transax SV Initialisation Failed Transax SV Initialising Invalid Account Invalid Capture Method Invalid Card Number Invalid Configuration Invalid Expiry Date Invalid Track2 Format Invalid Transaction Type Keyed Entry Not Allowed No Accounts Card Scheme Not Recognised Transaction Type Not Allowed Transax SV Service Unavailable Invalid Issue Number Invalid Card Security Code Confirmation Failed Printing Receipt Waiting For Donation
states that PED is in electrostatic discharge recovery mode and needs to be power cycled Copyright 2012 VeriFone All rights reserved. Copying and/or redistribution of this information in whole or in part without the express permission of VeriFone prohibited.
Author ND
Phone 08444 828 200
Public
Version V1.15
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
Pin Blocked Pin Try Limit Exceeded Further Payment Required SVS Initialising SVS Initialisation Failed SVS Invalid Configuration SVS Service Unavailable Cannot Continue Transaction Part Payment Obtain STAN Invalid STAN IVR Required Prompt For Authorisation Code Invalid Auth Code Offline Txn Failed Enter Reference Print Shop Copy Must Insert Card PIN Entered Card Swiped PIN Bypassed Cancelling Transaction Card Presented Server Error On Hold Transaction
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7.11. Continue Transaction (CONTTXN Record) This record is used with PAYware Ocius Sentinel in Screenless mode and allows the POS system to progress a transaction when further information is required. This message is sent via the standard integration port (25000 by default).
Field 1 2 3 Name Message Type Action ID Parameters Type String Integer String Description CONTTXN This is the required action to perform. These are defined below within a separate table. This field will contain any information that the POS may require that is associated with that status. Each parameter will be semi-colon ; delimited and will be defined as follows: <Name>=<Value> The following parameters are available: REPRINTOPT=FILE AUTHCODE= Ocius for Reprint to file rather than current printer The auth code to be supplied to PAYware VR transactions / Charge Only transactions The cashback to be added to the transaction The manager PIN to use The PayPoint account ID to use The PayPoint Scheme Option to use
CASHBACK= MGRPIN= PAYPOINTACCID= PAYPOINTOPTIONID=
Action ID Messages Listed below are all the available Action ID messages which could be returned by PAYware Ocius Sentinel, along with the parameters which may be returned. Please note: where the Action ID is described as Not Used the status is not returned by PAYware Ocius Sentinel.
Action ID 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 Description Not Specified Bypass PIN Continue Transaction Confirm Signature Reject Signature Reprint Receipt Keyed Entry Required Voice Referral Authorised Voice Referral Rejected Gratuity Required Gratuity Not Required Gratuity On PED Cancel Transaction Alternate Payment Customer Present Required Parameters / Not Used Reserved for Internal Use
REPRINTOPT Not Used AUTHCODE Not Used Not Used Not Used
Not Used
Author ND
Phone 08444 828 200
Public
Version V1.15
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
Customer Not Present Required E-Commerce Required Mail Order Required Telephone Order Required Change Card Confirm Auth Code Reject Auth Code Charge Auth Code Reverse UAT ICC Txn Retry Device Continue Without Device Abort Device Connectivity Retry Download Cancel Download Cashback Required Cashback Not Required Restart Accept Unsafe Download Reject Unsafe Download Replace Account Cancel Replace Account Confirm Gratuity Change Gratuity Account On File Registration Required Account On File Registration Not Required Reconnect To Server Abort Reconnect To Server Select PayPoint Account Select PayPoint Option Retry PayPoint Confirmation Cancel PayPoint Confirmation Accept Licence Key Reject Licence Key Cancel Licence Key Verification Continue Licence Key Verification Confirm Park Retail Gift Transaction Reverse Park Retail Gift Transaction Cancel Get Card Details (GDET) No Transaction Value Update Required Transaction Value Update Required Merchant Currency Required Cardholder Currency Required Merchant Reference Entered Supply IVR Details Reject IVR Print Shop Copy Receipt Cancel Shop Copy Receipt Supply STAN Accept Part Payment Reject Part Payment Further Payment Required No Further Payment Required
Not Used Not Used Not Used Not Used Not Used
AUTHCODE
CASHBACK
MGRPIN Not Used Not Used
PAYPOINTACCID PAYPOINTOPTIONID
TXNVALUE
REF
Some actions are dependent upon the stage the transaction has reached, e.g. bypassing the PIN can only be actioned at the stage where PIN entry is requested. Please see the below table for a list of the actions available and what stage the transaction must have reached before being able to perform the required action.
Action Required Transaction Stage
Author ND
Phone 08444 828 200
Public
Version V1.15
Bypass PIN Continue Txn Confirm Signature Reject Signature Reprint Receipt Voice Referral Authorised Voice Referral Rejected Cancel Transaction
PIN Entry Continue Required, Change Card Signature Confirmation Required Signature Confirmation Required Signature Confirmation Required, Continue Required Voice Referral Voice Referral Present Card, Card Data Retrieval, Enter Card Number, Expiry Date Required, Start Date Required, Issue Number Required, AVS House Number Required, AVS Post Code Required, CSC Required, Selection Required, Enter Charge Auth Code, Change Card, Invalid Expiry, Waiting For Cashback, PayPoint Select Account PayPoint Select Scheme Option Present Card, Invalid Expiry Change Card Confirm Auth Code Confirm Auth Code Enter Charge Auth Code Continue Required (merchant receipt stage only) PED Unavailable PED Unavailable PED Unavailable Retry Download Retry Download Waiting For Cashback Waiting For Cashback Restart After Software Update Unsafe Download Unsafe Download Unexpected Login Unexpected Login Register For Account On File Decision Register For Account On File Decision PayPoint Select Account PayPoint Select Scheme Option PayPoint Retry Confirmation Decision PayPoint Retry Confirmation Decision Licence Detail Confirmation Licence Detail Confirmation Licence Detail Confirmation
Alternate Payment Change Card Confirm Auth Code Reject Auth Code Charge Auth Code Reverse UAT ICC Txn Retry Device Continue Without Device Abort Device Connectivity Retry Download Cancel Download Cashback Required Cashback Not Required Restart Accept Unsafe Download Reject Unsafe Download Replace Account Cancel Replace Account Account on File Registration Required Account on File Registration Not Required Select PayPoint Account Select PayPoint Option Retry PayPoint Confirmation Cancel PayPoint Confirmation Accept Licence Key Reject Licence Key Cancel Licence Key Verification
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7.12. Transaction Value Modification As described earlier within the document, the transaction value modification functionality allows for an initial transaction value to be updated after the card has been inserted. The transaction flow is as follows: 1. Transaction initiated using standard transaction request (T Record), with a nominal dummy value, e.g. 1 2. PAYware Ocius prompts for Card Entry 3. PAYware Ocius reads and hashes the card details 4. POS Progress message (Status ID = 137) returned detailing the card hash and card type 5. POS uses information as required for perform lookups/additional processing 6. POS returns a CONTTXN message (action ID = 55/56) to proceed with transaction processing, including any discounts required Please note: When proceeding with the transaction using action ID 56 to update the details, it is possible to flag the transaction as a procurement card transaction. Please see the Procurement Card Specification for full details. 7. PAYware Ocius updates the value and proceeds with standard transaction processing This feature must be enabled on the terminal before to the above flow will be adhered to. POS Progress Message Status ID = 137 This progress message will be returned as shown in step 4 of the above flow.
Field 1 2 3 Name Result Terminate Loop Status ID Type Integer Integer Integer Description This indicates the result code (100) Reserved, Ignore Status ID of the transaction. For the Transaction Value Modification process, the Status ID will be 137 This is a text representation of the progress status For the Transaction Value Modification process the Status will be Update Transaction Value Decision This field will contain any information that the POS may require that is associated with that status. Each parameter will be ; delimited and will be defined as follows: <Name>=<Value> Here is a list of all possible parameters: CAPTUREMETHOD* Capture method, from: 1 = Keyed_CP
Status
String
Parameters
String
Author ND
Phone 08444 828 200
Public
Version V1.15
CARDDATA SCHEMENAME HASH TXNVALUE GRATUITYVALUE CASHBACKVALUE ISCPCCARD
2 = Keyed_CNP_MailOrder 3 = Swiped 4 = ICCFallbackToSwipe 5 = ICCFallbackToSignature 6 = ICCPINOnly 7 = ICCPINAndSignature 8 = ICCNoCVM 9 = ContactlessEMV 10 = ContactlessMagswipe 11 = Keyed_CNP_TelephoneOrder 12 = Keyed_CNP_ECommerce 13 = ICCUnknown 14 = Keyed_CNP_AccountOnFile Card number Name of the card scheme Hash representation of the card number Current transaction value Gratuity value Cashback value Mark the transaction as being
*Please Note: when the capture method is obtained from the initial card insertion, no risk management is performed. It is therefore possible that the capture method may change when performing standard transaction processing after updating the transaction value.
Example message: 100,0,137, UpdateTransactionValueDecision,CAPTUREMETHOD=6,CARDDATA=492912*******;SCHEME NAME=Visa;HASH=<Hashed_card_details>;TXNVALUE=1.00;GRATUITYVALUE=0.00;CBVAL UE=0.00 Continue Tranasction Message After receiving a Progress Message with a status ID of 137, the transaction will not progress until the correct Continue Transaction Message is returned. With the transaction value modification functionality, a continune transaction message with an Action ID of 55 or 56 must be returned. This infroms the terminal of the tranasction value to proceed with:
Field 1 2 Name Message Type Action ID Type String Integer Description CONTTXN This is the required action to perform. For the Transaction Value Modification functionality this should be either: 55 = No transaction value update 56 = Transaction value update required This field will contain any information that the POS may require that is associated with that status. Each parameter will be semi-colon ; delimited and will be defined as follows: <Name>=<Value>
Parameters
String
Author ND
Phone 08444 828 200
Public
Version V1.15
The following parameter should be provided with the Action ID of 56: TXNVALUE The value of the transaction
Example messages: If the transaction value does not require any change: CONTTXN,55 If the transaction value requires an update: CONTTXN,56,TXNVALUE=10.00
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7.13. REQINFO Should information be required from PAYware Ocius Sentinel, then a request for information can be sent. Via a response a report will be produced containing the requested information from a terminal, or an estate of terminals, depending on how the message is sent. Detailed within the table below are the available commands:
Field 1 2 Name Message Type REQINFO Type Type String Mandatory Integer Mandatory Description Identifier for the message type, which for information requests is: REQINFO Integer to identify which information is required:
1 Returns the PTID of the terminal 2 Software version on the terminal 3 Login status report 4 Displays Please wait, and performs connection test to transaction server 5 Returns the status of the PED from the last check performed by PAYware Ocius 6 Returns the hardware PTID of the PED, serial number of the attached PED and PED firmware version number The following parameters are only available with REQINFO,6 Data Type Integer The type of data required: Optional 0 PTID, serial number and firmware data of device 1 PTID of device only 2 Serial number of device only 3 Firmware data of device only Reader Type String Available modifiers with PAYware Ocius Sentinel: Optional ALL Return details from Contactless or EMV devices CONTACTLESS return details from Contactless devices only EMV Return details from EMV devices only Reserved for future use when multiple devices can be attached to PAYware Ocius Sentinel
Device Index
String Optional
Where multiple data is returned within the same field within the output record, field separators are used. Example record for REQINFO,6: 0,1,,,,,,,,,,,,,,,,1|Contactless|12345678<FS>123-456-789<FS>2.14
Author ND
Phone 08444 828 200
Public
Version V1.15
4.7.14. Additional Integration Commands The following commands are available to provide extra (non-transaction) functionality to the host system. They can be used with either of the integration methods (text or socket):
Output Message OLS, Description On receipt of this integrated function, PAYware Ocius Sentinel will submit all offline transactions and respond with a message informing the operator of the outcome. N.B. if the terminal is offline when OLS is sent, then a reconnection attempt will be made. If this fails, an error message of -87 will be returned to inform the POS of this result. The command can be followed by NOMSG, which will result in the terminal remaining minimised during submission, e.g. OLS,NOMSG. Report command which when sent to PAYware Ocius Sentinel will produce a report, where x is the report required. Another variable; y (optional, in which case the format of the record is REP,x,y) can be supplied to provide the full filename to output the report to. Here are the reports available (x): 1 Z Report report detailing all transactions since last Z report run 2 X Report report detailing all transaction since last Z report, but without resetting the values as with Z report 3 Txn Report report of last 10 processed transactions 5 Q Report quick report showing total processed amount since last Z report, and the date and time of the last Z report 10 Last Printed Report (Re-print) reprints the last printed report 11 Stored Offline Txn Report report of any stored offline transactions which are yet to be submitted to the ICP server 100 Product List prints a list of available products, e.g. till roll 101 Reprints customer receipt reprints customer receipt from the last processed transaction 102 Reprint Merchant reprints the merchant receipt from the last processed transaction 103 Prints System Information report prints System Info report, which contains information about the software running on the device as well as all the network settings for the terminal 201 Live Store prints a report showing all transaction in the live store waiting to be sent for settlement 202 Session Report prints a report showing all transactions processed during the current logon session 203 Summary Settlement Report prints a report showing the totals, broken down by card scheme, of transaction from the last time the account was settled 204 Detailed Settlement Report prints a report showing each settled transaction included in the last settlement (e.g. the night before). 205 Barclays Gift Report prints report on all Barclays Gift transactions The REP command can be followed by NOMSG which will result in the terminal remaining minimised whilst the receipt is being produced, e.g. to produce a Z Report to the default report location silently REP,1,,NOMSG. Returns the last message sent to the POS. If a value is not stored, a -29 response will be returned. This provides the ability to adjust the screen position, where x and y are the co-ordinates (integer values). This message will be accepted when PAYware Ocius Sentinel is on the login screen or the main idle screen. This message allows a command to be sent to the application to instruct PAYware Ocius to Stay Offline for a period off time. The available options to supply for the value are: 0 Online 1 to 98 Stay offline for x minutes (minimum of 1, maximum of 98) 99 Stay offline until the end of the day This function will check for updates. Once the updates are completed, the standard response will be sent to the POS with details of download being successful 0,1,,,,,,,,,,,,,,,,Download Successful. If there are no downloads to be acquired by the terminal then a response of 0,1,,,,,,,,,,,,,,,,No Downloads Available will be returned to the host.
REP,x
REQLASTMSG, SCRPOS,x,y
STAYOFFLINE,x
UPDAPP,
Author ND
Phone 08444 828 200
Public
Version V1.15
WINSTATE,x
The WINSTATE messages allows the system to control the status of the window, using the following commands: 0 Normal 1 Minimised 2 Maximised The response received after the action has been performed will be either: 0,1,,,,,,,,,,,,,,,,Window State Changed or -31,1,,,,,,,,,,,,,,,,Failed To Change Window State
Author ND
Phone 08444 828 200
Public
Version V1.15
5. Value Added Services

5.1. Barclaycard Gift
Barclaycard Gift is a prepay gift card supported by VeriFones PAYware Ocius platform. The gift card can be purchased in store from any participating merchant and has a prepaid balance, the amount of which is loaded upon purchase. The card can then be given as a gift to allow the cardholder to spend the balance at any of the participating merchants. A 4 digit PIN is printed on the receipt when the gift card is initially purchased and can be used to access the balance of the card online at: www.showmybalance.com
5.2. Barclaycard Gift Request (BGIFT Record)

Requires Barclaycard Gift Value Add to be enabled When utilising the Barclaycard Gift value added service, integrated Barclaycard Gift transactions can be automated by the POS using the below request message:
Field 1 Name Message Identifier Type String Description Identifier for the message type, for Barclaycard Gift: BGIFT Mandatory Account ID under which to process the transaction. Conditional Note: This is not required for void transactions. It is mandatory for all other transaction types. Barclays Gift Transaction type. Valid values are: Balance Enquiry = 1 New Card / Top-Up = 2 Sale = 3 Refund = 4 Cash = 5 Void = 6 Mandatory Transaction value to be processed Conditional Note: This is not required for Void / Balance Enquiry transaction types. For all other transaction types this is mandatory. Merchant supplied reference for the purpose of tracking the transaction. Conditional Note: The requirement of this field will be dependent upon Merchant settings. ID of the original transaction to be voided.
Account ID
Decimal
Transaction Type
Integer
Amount
Decimal
Reference
String
Original Transaction
Decimal
Author ND
Phone 08444 828 200
Public
Version V1.15
ID Conditional Note: This is mandatory for void transactions. For all other transaction types, this field is not to be supplied.
5.3. Barclays Gift Response

After receiving and processing the request, the below response message will be returned via integration:
Field 1 Name Result Code Type Integer Description Result of the transaction. Valid values are: Success = 0 Reversed = 1 Rejected = 2 Error = -ve Ok = 0 NoCard = 10 CardValidButNotForThisMerchant = 20 PartialPurchaseTransaction = 30 ExchangeRateNotPresent = 40 MaximumLoadExceeded = 50 MinimumLoadNotMet = 51 MaximumValueOnCardExceeded = 52 CardExpired = 60 MessageTypeInvalid = 71 VoidPeriodElapsed = 72 MessageDetailsIncorrect = 73 InsufficientFunds = 74 CallCallCentre = 99 ConfigurationProblem = -1 Authorisation Code assigned by Card Commerce Amount of the transaction Remaining Balance of the card returned in the transaction response Authorisation message indicating the result of the transaction Message number allocated to the transaction by VeriFone Transaction date/time in the format DD MMM YYYY HH:MM:SS Transaction ID assigned by VeriFones processing system
Response Code
String
3 4 5 6 7 8 9
Transaction Auth Code Amount Remaining Card Balance Message Message Number Transaction Date/Time Transaction ID
String Decimal Decimal String String String Decimal
Author ND
Phone 08444 828 200
Public
Version V1.15
5.4. Dynamic Currency Conversion (DCC)

As companies become increasingly globalised and cheaper travel encourages individuals to travel the world more and more frequently, the need for retailers to increase footfall from international tourists has become more pressing. Dynamic Currency Conversion (DCC), provided by FEXCO, offers retailers the functionality to allow overseas customers to make purchases by Visa and MasterCard in their home billing currency. DCC enables overseas customers making purchases by Visa and MasterCard the choice to pay in their card billing currency. The benefits to the Merchant include: Creates revenue stream for merchants from foreign exchange Settlement is in GBP, eliminating the risk of foreign exchange Eliminates need to display multi-currency pricing
The benefits to Customer include:
Competitive exchange rates Provides customers with choice to pay in their own currency, providing transparency and familiarity No additional charges
5.5. Givex
Givex provides the ability for Merchants to sell and redeem electronic gift cards through multiple sales interfaces and locations. Supplying Gift and Loyalty functionality provides customers with the opportunity to earn rewards that can equate to a future purchase or receive special discounts from promotions. According to research, increasing customer loyalty drives long-term profitability more than any other strategic factor. It is estimated that companies can boost profits by between 50% by retaining just 5% of their customers (Frederick Reichheld, The Loyalty Effect). This is due to the fact that these gift and loyalty cards can increase customer spending by 10%-40%. Customer loyalty also allows the retailer to build a customer database for effective marketing and enables spending habits to be tracked to develop customer profiles.
Author ND
Phone 08444 828 200
Public
Version V1.15
5.5.1. Givex Request (GIVEX Record) Requires Givex Value Add to be enabled When utilising the Givex value added service, integrated Givex transactions can be automated by the POS using the below request message:
Field 1 Name Message Identifier Type String Description Identifies the type of message. This will always be GIVEX Mandatory Indicates the type of Givex transaction to perform. Valid values are: Gift Certificate Register = 904 Gift Certificate Activation = 906 Gift Certificate Increment = 905 Gift Certificate Redemption = 901 Gift Certificate Forced Redemption = 902 Gift Certificate Cash Back = 903 Gift Certificate Forced Cash Back = 919 Gift Certificate Forced Pre Auth = 920 Gift Certificate Post Auth = 921 Gift Certificate Cancel = 907 Gift Certificate Adjustment = 908 Balance Enquiry = 909 Balance Transfer = 910 Points Issuance = 911 Points Redemption = 912 Points Cancel = 913 Cash Out = 915 Mandatory Full Givex number Optional Transaction value Optional Security Code assigned to a customers card which can be provided for additional security purposes Optional Authorisation Code assigned to a transaction. Conditional Notes: The Authorisation Code is only required when adding Gratuity to a transaction or when performing a Gift Certificate Cancel This field can contain a numeric value for any purpose as determined by the Merchant, it could be the number of items in the sale or the number of points to be assigned for the sale Optional Reserved for future use Number of points added as a result of the current transaction Optional Full Givex number to transfer Balance/Points to
Transaction Type
Integer
Givex Number
String
Amount
Decimal
Security Code
String
Auth Code
String
Units
Int64
8 9
Promotion Code Points
String Int64
10
Givex Number To
String
Author ND
Phone 08444 828 200
Public
Version V1.15
Conditional Notes: Required for Balance Transfer transaction types Reference associated with the transaction, supplied by the Merchant Optional
11
Reference
String
5.5.2. Givex Response After having received and processed the request message, PAYware Ocius Sentinel will return a response message detailing the below information:
Field 1 Name Result Type Integer Description Givex transaction status -99 Transaction Cancelled 0 Pending 1 Authorised 2 Completed 3 Error 4 Reversed 5 Declined -ve Error codes defined within Appendix B Message to provide a text representation of the transaction result Indicates the type of Givex transaction which was performed Authorisation Code assigned to the transaction Balance of the Certificate Expiry date of the card/certificate Security code of the card/certificate Transaction value for the transaction processed Masked version of the Givex Number Number of points given to this transaction Points balance of the card First Name of the cardholder Middle Name of the cardholder Surname of the cardholder When performing a balance transfer, the auth code assigned to the card which the balance has been transferred from When performing a balance transfer, the auth code assigned to the card which the balance has been transferred to When performing a balance transfer, the auth code assigned to the certificate which the balance has been transferred from When performing a balance transfer, the auth code assigned to the certificate which the balance has been transferred to Number assigned to a batch of transactions after a close request Unique Givex transaction ID
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
Result Message Transaction Type Auth Code Cert Balance Expiry Date Security Code Amount Givex Number Points Points Balance First Name Middle Name Surname Points Auth Code From Points Auth Code To Cert Auth Code From Cert Auth Code To Cash Out ID Transaction ID
String Integer String String String String String String String String String String String String String String String String Decimal
5.6. MiVoucher
Mobile vouchers (MiVouchers) are a development of existing mobile phone technology and retail POS systems to transmit, receive, store and redeem retail vouchers via SMS (text) message. The system also allows for MMS (Multi-Media or Picture messaging) and future support for NFC (Near-Field Communication), contactless style voucher transmission. The vouchers have numerous marketing applications and provide the first true step into the field of stored value mobile purses and interactive mobile marketing.
Author ND
Phone 08444 828 200
Public
Version V1.15
Consumers may respond to a call to action, following instructions via a more traditional advertising medium such as print or television, to text into a service in order to receive their promotional voucher. Alternatively, voucher codes can also be sent to consumers whose details have previously been collected by another means and as such are already recorded within the retailers own marketing database. The consumer then receives a text message containing a unique ID voucher code, with the message also containing personal or promotional details and redemption instructions. The relevant retail outlet is then visited by the consumer and they pay for the item using the MiVoucher, redeeming the discount offered in the advertisement. The MiVoucher scheme is a real-time solution supported by VeriFones ICP Managed Service. The MiVoucher service is provided by Eagle Eye Solutions. 5.6.1. MiVoucher Request (M Record) Requires MiVoucher Value Add to be enabled When utilising the MiVoucher value added service, integrated MiVoucher transactions can be automated by the POS using the below request message:
Field 1 2 3 Name Message Identifier Account ID Voucher Number Type String Decimal Mandatory String (20) Description This is identifies the type of message. M is used to signify a MiVoucher transaction type. This identifies the MiVoucher Account to use This is the voucher number supplied by the customer Mandatory for Redemption Entry Type Dependent for Verification & Creation For verification & creation transactions, if the entry type is set to keyed customer, the terminal will prompt for the voucher number irrespective of whether this field is populated. For any other entry types, this field is mandatory. This is the type of transaction being performed. Allowed values are: LITE = 1 STANDARD = 2 This will always be set to STANDARD Mandatory This identifies the transaction being performed. Allowed values are: LITE = 1 VERIFY = 2 REDEEM = 3 CREATE = 4 CANCEL = 5 In the VeriFone implementation LITE will never be used. CANCEL is a VeriFone internal processing option and will not be available from an
Transaction Type
Integer
Message Type
Integer Mandatory
Author ND
Phone 08444 828 200
Public
Version V1.15
integration perspective Mandatory This identifies how the customer specific details were captured Allowed values are: KEYED CUSTOMER = 1 KEYED OPERATOR = 2 SCANNED = 3 NFC = 4 In the VeriFone implementation, SCANNED and NFC will never be used. Mandatory This is the details of the voucher(s) to be redeemed. Each voucher detail record will be pipe (|) separated. Mandatory for Redemption & Creation
Entry Type
Integer
Voucher Details
String
The voucher details section supports the provision of multiple voucher details records. This functionality is supported for redemption transactions; however, when creating a voucher, the POS must only supply one record in this field. 5.6.2. MiVoucher Details The Voucher Details component of the integration record will consist of the following semi colon (;) delimited fields.
Field 1 Name Voucher ID Type String (20) Description This is a unique ID identifying the MiVoucher. Mandatory for Redemption The value of the discount to be applied per item Mandatory for Redemption & Creation The number of distinct times the product / product group should be present for qualifying usage in the rule. If the usage returned as part of the verification result is 0 then populate this field with 1. Mandatory for Redemption & Creation For creation transactions pass in a value of 1. This indicates the target of the voucher being created. Valid values are: 0 = Not Set 1 = POS 2 = SMS Mandatory for Creation For all other transaction types set the value to 0. This is the mobile number to be supplied with the voucher creation request. This must either be supplied with the leading zero (e.g. 079xxxxxxxx) or with the country identifier (e.g. +4479xxxxxxxx)
Discount Value
Integer Max=1000000 Integer (4)
Usage
Voucher Target Type
Integer
Mobile Number
String (20)
Author ND
Phone 08444 828 200
Public
Version V1.15
Mandatory for Creation when Voucher Target Type = 2
Author ND
Phone 08444 828 200
Public
Version V1.15
5.6.3. MiVoucher Response After receiving and processing the request message, PAYware Ocius Sentinel will respond with a message containing the following information:
Field 1 2 Name MiVoucher Transaction ID Auth Result Type Decimal String (20) Description This is the unique ID of the transaction as allocated by VeriFone This is the result of the authorisation. Allowed values are: VERIFIED REDEEMED ISSUED ERROR If an error response is returned in the Auth Result field, this field will detail the error code relating to the error This is the voucher number delivered to the consumer This is the ID of the campaign that the vouchers belong to This is a unique ID of the transaction This is the details of the voucher(s) that relate to the supplied voucher number. Each voucher detail record will be pipe (|) separated.
3 4 5 6 7
Auth ID Voucher Number Campaign ID Reference ID Voucher Details
Integer (2) String (20) Int64 String (50) String
Voucher Details The Voucher Details component of the integration record will consist of the following semi colon (;) delimited fields.
Field 1 2 3 4 5 6 7 8 9 Name Voucher ID Type Reference ID Discount Type Discount Value Usage Min Spend Description Voucher Target Type Type Int64 Integer (2) String (50) String (5) Decimal Max=1000000 Integer (4) Integer (4) String (50) Integer Description This is a unique ID identifying the MiVoucher This is the required voucher type returned by MiVoucher This is the Reference ID of the voucher, returned by MiVoucher This is the type of discount to be applied, returned from MiVoucher The value of the discount to be applied per item The number of distinct times the product / product group should be present for qualifying usage in the rule This is the minimum spend for the voucher to apply, returned by MiVoucher This is the description of the voucher as returned by MiVoucher This indicates the target of the voucher being created. Valid values are: 1 = POS 2 = SMS If the voucher target type is set to 2 (SMS), this is the mobile number that the voucher was issued to.
10
Mobile Number
String (20)
Author ND
Phone 08444 828 200
Public
Version V1.15
5.7. Flexecash (Park Retail)

Flexecash (used to be known as Park Retail) is a prepaid high street gift card service, provided by Park Group PLC. The prepaid gift card allows consumers to do their shopping keeping to a pre-determined budget without the need to carry cash. The functionality is provided in both standalone and integrated modes, with integration records included later on within this document. Screenless mode is also supported, allowing PAYware Ocius Sentinel to return progress messages information the POS of the state of the transaction. Flexecash amount validation ensures both Ceiling and Floor limits are correctly processed, i.e. via integration if the amount returned is outside the allowed limits then the operator will be informed and transaction cancelled. However, for manual transaction; an amount between the two limits will be required in order to continue. 5.7.1. Park Retail Request (PRG Record) Requires Park Retail Value Add to be enabled When utilising the Park Retail value added service, integrated Park Retail transactions can be automated by the POS using the request message detailed below.
Field 1 2 Name Message Type Transaction Type Type String Integer Description This will always be PRG This is the type of transaction to process. Accepted values are: 0 = Sale 1 = Refund 2 = Balance Enquiry This field is mandatory. If it is not present the record will be rejected This will be the full transaction amount including the decimal place i.e. 10.00. If the Transaction value is not supplied as part of the integration record then PAYware Ocius will reject the integration record The Merchant reference is dependent upon the configuration. If the reference is optional and not provided then the request will be processed without a reference. If the reference is required and one is not provided the integrated request will be rejected This is the Account ID of the required account for processing. If not supplied and only one account is present this will be selected automatically, otherwise the request will be rejected
Transaction Amount
Decimal
Merchant Reference
String
Account ID
Decimal
Example: PRG,1,50.00,Test1,12345678
Author ND
Phone 08444 828 200
Public
Version V1.15
5.7.2. Park Retail Response The response message returned after processing an integrated Park Retail transaction will conform to the following formats dependent upon which Park Retail integration version is configured within the Program Settings file: Version 1 Response
Field 1 Name Result Code Type String Description This is the result code as returned by Park Retail or set by VeriFone. Authorised = 0 please see below Acquirer Response Code table for possible results. This is the error code if the transaction has encountered an error. Please see PAYware Ocius Sentinel standard VeriFone Error Codes This is the value of the transaction processed including the decimal place This is the starred PAN used for processing only showing the last 4 digits This is the expiry date of the card processed This is the date time of the transaction in the format of DD MMM YYYY HH:MM:SS e.g. 10 Jun 2011 11:39:06 This is the MID (Card Acceptor Number) used for processing This is the TID assigned to the transaction This is the internal ID assigned to the authorisation request This is the Merchant reference if supplied by the Merchant This is the Account ID that the transaction was process under
2 3 4 5 6 7 8 9 10 11
VeriFone Error Code Transaction Value Starred PAN Expiry Date Transaction Date Time MID TID Message ID Merchant Reference Account ID
String Decimal String String String String String String String Decimal
Example: 0,0,10.00,***************0325,1212,10 Jun 2011 11:39:06,365678,4380001,754,Test1,12345678 Version 2 Response

Field 1 Name Result Code Type String Description This is the result code as returned by Park Retail or set by VeriFone. Authorised = 0 please see below Acquirer Response Code table for possible results. This is the error code if the transaction has encountered an error. Please see PAYware Ocius Sentinel standard VeriFone Error Codes This is the value of the transaction processed including the decimal place This is the starred PAN used for processing only showing the last 4 digits This is the expiry date of the card processed This is the date time of the transaction in the format of DD MMM YYYY HH:MM:SS e.g. 10 Jun 2011 11:39:06 This is the MID (Card Acceptor Number) used for processing This is the TID assigned to the transaction This is the internal ID assigned to the authorisation request This is the authorisation code returned for the transaction request This is the Merchant reference if supplied by the Merchant This is the Account ID that the transaction was process under
2 3 4 5 6 7 8 9 10 11 12
VeriFone Error Code Transaction Value Starred PAN Expiry Date Transaction Date Time MID TID Message ID Authorisation Code Merchant Reference Account ID
String Decimal String String String String String String String String Decimal
Example:
0,,50.00,***************0325,1212,10 Jun 2011 11:38:01,00365678,04380001,753,549976,Test1,12345678
Acquirer Response Codes

Author ND
Phone 08444 828 200
Public
Version V1.15
Code -1 00
ISO Meaning Not Set Confirmed
Action Decline Accept
Applicable To Sale Authorisation, Reversal, Balance Enquiry Sale Authorisation
Message
Auth Code: xxxxxx Bal: xxx.xx
Reversal Balance Enquiry 01 02 03 05 12 14 30 41 51 54 62 96 99 Transaction Failed System Unavailable Reversed Do Not Honour Invalid Transaction Invalid Card Number Format Error Lost or Stolen Not Sufficient Funds Expired Restricted System Malfunction VeriFone Error Decline Decline Decline Decline Decline Decline Decline Decline Decline Decline Decline Decline Sale Authorisation, Reversal, Balance Enquiry Sale Authorisation, Reversal, Balance Enquiry Reversal Sale Authorisation, Reversal, Balance Enquiry Sale Authorisation, Reversal, Balance Enquiry Sale Authorisation, Reversal, Balance Enquiry Sale Authorisation, Reversal, Balance Enquiry Sale Authorisation, Balance Enquiry Sale Authorisation Sale Authorisation, Balance Enquiry Sale Authorisation, Balance Enquiry Sale Authorisation, Reversal, Balance Enquiry Sale Authorisation, Reversal, Balance Enquiry
Completed Bal: xxx.xx Bal: xxx.xx
Declined Invalid Transaction Not Authorised Format Error Not Authorised Lost Card Insufficient Funds Bal: xxx.xx Declined Expired Card Not Accepted System Error
Author ND
Phone 08444 828 200
Public
Version V1.15
5.8. PayPoint
To provide the ability to process E-Card and E-Voucher topups, VeriFone supports PayPoint transactions with PAYware Ocius Sentinel. Via either standalone, integrated or screenless transactions; PayPoint add E-TopUp capabilities to a merchant site. A host of network operators are available; along with BT Bill Payments, which allows cardholders to pay for their BT line using their BT account card. Please note that when installing the software with the intention of utilising the PayPoint functionality on the PAYware Ocius Sentinel version that the Microsoft .NET Framework version will need to be V3.5. The PayPoint transaction is processed independently of any EFT processing to collect payment. VeriFone recommend that payment is collected prior to the PayPoint transaction, or that the two are linked together via integration to form one process. The integration process for PayPoint should be built using the PayPoint specific XML files within the PAYware Ocius Sentinel directory. This will ensure that the integration is dynamic and should there be any changes within these configuration files that the integration will be automatically updated should all the available schemes be accepted by the merchant. 5.8.1. PayPoint Request (PPOINT Record) Requires PayPoint Value Add to be enabled Please note: when utilising the PayPoint value added service, the .NET Framework version utilised on each machine where PAYware Ocius Sentinel is installed must be V3.5. When utilising the PayPoint value added service, integrated PayPoint transactions can be automated by the POS using the request message detailed below. The Service User, Scheme ID and available top up amounts for each scheme should be dynamically sourced from the PayPoint XML files which are stored within the PAYware Ocius Sentinel directory once PayPoint has been enabled on the merchant system. These files contain information on the following elements of a PayPoint transaction: Amount Top up value available for an option Option Each network provider has different voucher options available for purchase, e.g. text packs or voice packs. Each pack has different options available which are usually different prices. An option would be 5 Text Pack. Service User Service user is the name given refer to a network operator (e.g. BT, O2, Vodafone) Scheme The type of voucher pack required, e.g. BT Pay & Call, Pay As You Go, Top Up Voucher, Text Pack.
The files downloaded which should be used to build the request messages are:
Author ND
Phone 08444 828 200
Public
Version V1.15
PayPointOptionAmounts.xml Provides a list of the top up amounts available for each option. PayPointSchemeDetails.xml Provides details for each scheme, e.g. currency (978 Irish, 826 UK), scheme name, min/max/lowest denomination. PayPointSchemeOptions.xml Provides breakdown of the options for each scheme which are available. PayPointServiceUsers.xml Provides a breakdown of the service user name for each service user ID.
After deciding which schemes are to be supported, the integration should build the request messages using the information from these XML. Avoiding hard coding these values will also ensure that should the PayPoint files be updated that no integration changes are required to add new schemes.
Field 1 2 3
Name Message Identifier Account ID Transaction Type
Type String Decimal Optional Integer
Description This is identifies the type of message. This will always be PPOINT This is the PayPoint Account ID to process the transaction under. This indicates the type of transaction to perform. Valid values are: Sale = 1 Refund = 2 Mandatory This indicates the type of top-up to perform. Valid values are: E-Card = 1 E-Voucher = 2 This is the Service User ID for the operator required. Mandatory for E-Voucher transactions Not required for E-Card transactions This is the Scheme Detail ID required, this information can be found in the PayPointSchemeDetails.xml in the PAYware Ocius Sentinel directory. Please note that these need to be matched to the correct Service User. Mandatory for E-Voucher transactions Not required for E-Card transactions This is the value of the transaction being performed. This is a merchant allocated reference to aid identifying the transaction. EFT Capture Method indicating how the card details were obtained. This is to be populated when supplying the card number via integration. Accepted values: Keyed Cardholder Present = 1 Swiped = 3 The card number to be supplied via integration, the format of which is dependent upon the capture method. When the Capture Method is Keyed CP (1), supply the full card number. When the Capture Method is Swiped (3), supply the track2 data obtained by swiping the card.
Top-Up Type
Integer Mandatory
Service User
Integer
Scheme Detail ID
Integer
7 8 9
Amount Merchant Reference Capture Method
Decimal Mandatory String Conditional Integer Optional
10
Card Number
String Conditional
Author ND
Phone 08444 828 200
Public
Version V1.15
11
Expiry Date
Integer Conditional
Expiry date of the PayPoint card. Conditionally required, if the E-Card details are supplied and an expiry date is required by the card
5.8.2. PayPoint Response The response message returned after processing an integrated PayPoint transaction will conform to the following format:
Field 1 Name Result Type Integer Description This is the result of the transaction. Valid values are: -ve = VeriFone Error Code Confirmed = 0 Transaction Failed = 1 Declined = 2 System Unavailable = 3 Reversed = 4 This is the date / time that the transaction was started on the terminal. This will be in the format: DD MMM YYYY HH:MM:SS This is the operator as defined in the PayPoint scheme specification. This is the scheme name as defined in the PayPoint scheme specification. This indicates how the card details were captured. Valid values are the following subset from the values acceptable for the standard transaction capture method: Keyed Cardholder Present = 1 Swiped = 3 This will be either the response outcome message returned by PayPoint or will be a textual description of the VeriFone Error
Transaction Date / Time
String
3 4 5
Service User Name Scheme Name Capture Method
String String Integer
Response Outcome Message
String
Author ND
Phone 08444 828 200
Public
Version V1.15
5.9. Pennies
The Pennies Foundation has created Pennies, the electronic charity box. Pennies is designed to make giving to charity easy, quick and affordable. Its new, inclusive and will raise additional money for many UK registered charities. With one touch of a button shoppers can choose to donate a few pennies in private when they pay by debit card, credit card or electronically. Merchants can configure the functionality to either round up to the nearest adjustment value (e.g. the nearest 1) or top up according to the adjustment value (e.g. top up by 1). The adjustment value is configured on the merchant account. All the pennies are then added together and all of the money thats been collected is given to UK charities, both big and small. Pennies are powerful a few pennies a month from many people add up to millions of pounds. It would take just 8 pence a week (just over 4 a year) from half of the UKs card-holders to raise 89 million a year.
5.10.
Stored Value Solutions (SVS)
Stored Value Solutions provide prepaid services to merchants. VeriFone support SVS branded prepaid cards which are used to:

Reward and incentivise employees, customers, and partners Improve foot traffic to your locations Increase brand awareness Facilitate new promotional and co-branding opportunities Allow easy gift card acceptance across multiple point-of-sale systems
Prepaid cards are accepted the same way as any standard electronic funds transfer card through VeriFones PAYware Ocius platform. Integration records are provided within this manual, allowing the merchant to utilise the functionality integrated into the POS, or in standalone mode without integration in place. Store ID Each terminal/installation needs to be linked to the correct SVS Merchant Store; this will ensure that the correct configuration details are downloaded with the accounts files. To support merchants utilising PAYware Ocius Sentinel and to avoid the need for manual intervention to link the PAYware Ocius Sentinel PTID to a merchant store, the Login Record includes an optional 5th field in which to supply the Store ID. When this information reaches the VeriFone Server, the PTID is automatically linked to the Merchant Store. 5.10.1. SVS Request (SVS Record) To support integrated Stored Value Solution transactions a comma delimited integration record must be supplied, conforming to the below format:
Author ND
Phone 08444 828 200
Public
Version V1.15
Field 1 2
Name Message Type Transaction Type
Type String Integer
Description This field will always be set to SVS. Valid values are: Balance Enquiry *Pre-Authorization Redemption *Tip Cancellation Return Card Reload *Pre-Auth Completion *Activate Card Issue Card *Issue Virtual Card *Reversal *Network Message Cash Out 0 1 2 3 4 5 6 7 8 9 10 11 12 13
3 4 5 6
Amount Account ID STAN Reference
Decimal String String String
[* = reserved for future use] The amount of the SVS transaction The SVS Account under which the transaction is to be processed Systems Trace Audit Number Reference supplied by the merchant
Example record: SVS,9,1.00,10459,123456,Test
Author ND
Phone 08444 828 200
Public
Version V1.15
5.10.2. SVS Response Upon completion of the SVS transaction the terminal will provide the POS with a comma delimited message in the below format:
Field 1 Name Response Code Type String Length (Max) 3 Description SVS response codes: None 0 Approved 1 Card Inactive 2 Invalid Card Number 3 Invalid Transaction Code 4 Insufficient Funds 5 No Previous Transaction 6 Invalid Message 7 No Card Found 8 Insufficient Funds Pre-Auth 9 Denial No Previous Auth 10 Exceeded Maximum Single Reloads 13 Exceeded Max Balance 14 Shut Down 15 Invalid Card Status 16 Unknown Store Number 17 Exceeded Max Reloads 18 Invalid Verification Value 19 Invalid Pin Number 20 Card Already Issued 21 Card Not Issued 22 Card Already Used 23 Manual Transaction Not Allowed 24 Invalid Magnetic Read 25 Unknown Transaction Type 26 Invalid Tender Type 27 Invalid Customer Type 28 Pin Locked 29 Exceeded Maximum Redemptions 30 Invalid Currency Code 31 Invalid Server ID 32 Frozen 33 Invalid Amount 34 Application Error -1 Cancelled -99 Value of the transaction Value of the card balance Standard accepted alpha code of the currency (e.g. GBP) Conversion rate between merchant and cardholder currencies Masked Card number used in the transaction Systems Trace Audit Number Text returned by SVS host server
2 3 4 5 6 7 8
Amount Balance Currency Code Conversion Rate Masked PAN STAN Message
String String String String String String String
8 8 4 8 20 6 Variable
Example record: 01,0.00,39.99,GBP,1.00000,***************4179,110009,Approval
Author ND
Phone 08444 828 200
Public
Version V1.15
5.11.
Transax SV (Stored Value)
Transax SV is a value added service provided by FIS. It can be integrated into merchants existing retail payment systems to provide a Gift Card programme. The following functionality is supported:

Balance Enquiry Load/activate Refund Sale Top-up
Gift Cards can be used for a range of retail sales and marketing applications including savings schemes, insurance claim schemes, promotions and staff incentives. Duplication Checking As potential communication and technical issues may cause duplicate transactions to be requested, the Transax SV Host comprises a Duplicate Checking Mechanism to ensure that cards are only debited or credited once for each genuine transaction performed at the Point of Sale. When the host receives a new transaction for a card, it retrieves the previous (last) transaction to carry out a comparison check between the two (current and previous) transactions, to ensure they are not duplicates. There are two flavours of duplicate handling provided by Transax SV: If the merchant is supplying a Unique Merchant Reference (UMR) for every transaction, where this reference matches the reference for the previous transaction on the same card and the transaction amount, transaction type and merchant number all match then the latest transaction will be considered a duplicate and the result of the previous transaction will be returned If no UMR is provided for each transaction; where the transaction amount, transaction type and merchant number all match then if the two transactions are within X minutes (where X is the duplicate window in minutes set on the Transax SV host on a card scheme level) of each other then the latest transaction will be considered a duplicate and the result of the previous transaction will be returned
If merchants do not wish for this duplication checking to be in place, then the duplication window should be configured with Transax SV to be 0 and no UMR should be supplied with each transaction. 5.11.1. Transax SV Request (TSV Record) To support integrated Transax SV requests, a comma delimited integration record must be supplied, conforming to the below format:
Field Name Type Description
Author ND
Phone 08444 828 200
Public
Version V1.15
Record Type
String
This is always set to: TSV Mandatory This is the Account ID to identify the required account for processing Mandatory This is the Transax SV Transaction type. Valid values are: Load / Activate = 1 Top-Up = 2 Sale (Debit) = 3 Balance Enquiry = 4 Refund = 5 Mandatory This determines if a Cardholder Present or Cardholder Not Present transaction is required. Valid Values are: 0 = Cardholder Present 1 = Cardholder Not Present
Account ID
Decimal
Transaction Type
Integer
Cardholder Not Present
Boolean
Amount
Decimal
Mandatory This is the amount for the transaction. Mandatory Note: For Balance Enquiries this must be set to 0.01 This indicates the unique Merchant Reference Conditional Note: The requirement for this is deemed by the account. This is either enabled or disabled. If disabled and supplied it will be ignored. If enabled and not supplied the transaction will be rejected
Reference
String
Examples: TSV,1,1,0,10.00,TEST
Author ND
Phone 08444 828 200
Public
Version V1.15
POS Progress Message This progress message will be returned when processing Transax SV transaction in Screenless mode where a Continue Message is required.
Field 1 2 3 Name Result Terminate Loop Status ID Type Integer Integer Integer Description This indicates the result code (100) Reserved, Ignore Status ID of the transaction. The following Statuses are valid for Transax SV: 149 = Account Extraction Failed 150 = Amount Outside Allowed Range 151 = Enter Amount 152 = Confirm Authorisation 153 = Card Expired 154 = Transax SV Initialisation Failed 155 = Transax SV Initialising 156 = Invalid Account 157 = Invalid Capture Method 158 = Invalid Card Number 159 = Invalid Configuration 160 = Invalid Expiry Date 161 = Invalid Track 2 Format 162 = Invalid Transaction Type 163 = Keyed Entry Not Allowed 164 = No Accounts 165 = Card Scheme Not Recognised 166 = Transaction Type Not Allowed 167 = Transax SV Service Unavailable 168 = Invalid Issue Number 169 = Invalid Card Security Code 170 = Confirmation Failed 171 = Printing Receipt This is a text representation of the progress status This field will contain any information that the POS may require that is associated with that status. There are no parameters associated with the status messages applicable for Transax SV (listed above) specific processing.
4 5
Status Parameters
String String
Author ND
Phone 08444 828 200
Public
Version V1.15
Continue Message After receiving a Progress Message, the transaction will not progress until the correct Continue Transaction Message is returned. With the Transax SV functionality, a continune transaction message with an Action ID of one of the below must be returned. This infroms the terminal of the tranasction value to proceed with:
Field 1 2 Name Message Type Action ID Type String Integer Description CONTTXN This is the required action to perform. For Transax SV, the action required is either: 2 = Continue Transaction 3 = Confirm Transaction 4 = Reject Signature 5 = Re-Print 20 = Confirm Transaction 21 = Reject Transaction This field will contain any information that the POS may require that is associated with that status. There are no parameters associated with the action IDs applicable for Transax SV (listed above) specific processing
Parameters
String
Author ND
Phone 08444 828 200
Public
Version V1.15
5.11.2. Transax SV Response Upon completion of the Transax transaction the solution will provide the POS with a comma delimited message in the below format:
Field 1 Name Result Code Type Integer Description This is the result of the transaction. Valid values are: 0 = Authorised 1 = Declined 2 = Reversed -ve = VeriFone Error This is the Acquirer Response Code. Valid values are: 00 = Authorised 05 = Declined This is the authorisation code This is the amount for the transaction This is the remaining card balance This is the message from the authorisation host This is the Transaction ID supplied by the VeriFone processing system This is the message number for processed transaction This is the MID for the account used to process the transaction This is the TID assigned to the transaction for processing
Response Code
String
3 4 5 6 7 8 9 10
Auth code Amount Balance Message Transaction ID Message Number MID TID
String Decimal Decimal String Decimal String String String
Example message: 0,00,12345,10.00,40.00,AUTHORISED,999999,123,123456,01230123
Author ND
Phone 08444 828 200
Public
Version V1.15
6. Additional Functionalities
PAYware Ocius Sentinel provides additional functionality which is detailed within this section. For further information on any of the additional functionality supplied merchants should consult their Account Manager.
6.1. Discretional Data

PAYware Ocius Sentinel supports the ability to capture data from the track1 discretional data field. This allows for additional information stored on the card within this field to be returned to the merchant via integration messages. This field is often used for retailer specific data, often in conjunction with large retailers such as loyalty card data. The merchant will need to be integrated to PAYware Ocius Sentinel and the feature enabled within the merchant system. The integration output field can be enabled by configuring the Integration Version to 5 as advised within section 8.4 Integration Version, which will ensure that as part of an integrated solution that the data is returned within the 34th field of the transaction response.
6.2. External Hashing

PAYware Ocius Sentinel provides an External Hashing process whereby merchants are provided with a unique identifier for each payment card that is processed, which can be safely stored within the Merchants own systems without risk of data compromise. This is often referred to as Tokenisation, but VeriFone use the term (External) Hashing to avoid confusion with the Account On File feature which provides merchants with Token IDs to reference card details stored within VeriFones infrastructure. VeriFones External Hashing functionality converts the payment card number (PAN) into a oneway hash value a form of data encryption. This SHA-256 hash value returned via integration is a base64 encoded binary which cannot be reverse engineered to reveal the card number it represents. This hash value will be returned in the transaction output record produced by PAYware Ocius Sentinel, within field 32 of the Transaction Response Record and will require base64 decoding before producing a 32 byte string. The hash is generated by the PED and should be base64 decoded before being stored by the merchant. This value is unique per card number and can be stored by the merchant in order facilitate searching for transactions with which that card was processed. Should the external hash not be stored routinely by the merchant or in the scenario whereby a cardholder contacts the merchant and the hash value is not available; WebCom does contain the functionality to convert the PAN into its equivalent hash representation.
Author ND
Phone 08444 828 200
Public
Version V1.15
6.3. Get Card Details

Should the merchant require the ability to obtain details from the card prior to onward processing, the Get Card Details functionality can be utilised via integration record. The request must define if the card is EFT or non-EFT (e.g. loyalty card, gift card) and the response will define the card number (masked for EFT cards and in full for non-EFT) as well as the card scheme name and a hashed version of the card number for secure storage. An alternative to this approach may be the Transaction Value Modification feature. 6.3.1. Get Card Details Request (GDET Record) In order to retrieve the details of the card provided, PAYware Ocius Sentinel supports the Get Card Details request record:
Field 1 2 Name Message Identifier Operation Mode Type String Integer Description This is identifies the type of message. This will always be GDET This identifies what type of card details to retrieve. Valid values are: 0 Non-EFT 1 EFT This indicates whether the card removal processing should be performed or not. Valid values are: 0 Dont Remove Card 1 Remove Card This indicates if the Hashed Card Number is to be returned. Accepted values are: Standard Version = 0 Version 1 = 1 This field is optional and does not have to be present. In the event that this field is not present fields 1 through 3 of the output response will be returned as normal, this is the same when the POS Version is set to 0. If the POS Version is set to 1 then the Hashed Card Number will be returned to the POS in field 4 of the response
Remove Card Setting
Integer
POS Version
Integer Optional
6.3.2. Get Card Details Response Once the request has been received and processed by PAYware Ocius Sentinel, the PED will request the card is inserted/swiped and will respond with a message containing the below information:
Field 1 Name Result Type Integer Description This identifies the result of the processing. Valid values are: 0 Success -4 Card Not Recognised -5 EFT Card Presented For Non-EFT Operation Mode or Non-EFT Card Presented For EFT Operation Mode -12 Invalid Record -30 Processing Failed -70 Operation Mode Not Supported -85 User Not Logged In -90 Service Not Allowed -99 Retrieval Cancelled -135 Timeout Waiting For Card
Author ND
Phone 08444 828 200
Public
Version V1.15
Card Data
String
3 4
Scheme Name Hash
String String (base64encoded binary)
The error codes correspond to standard VeriFone Error Codes. For EFT identified cards, this will be the starred card number where all digits bar the first 6 are starred. For Non-EFT cards, this will be the full track 2. For EFT identified cards, this is the name as stored against the IIN table. The SHA-256 hash of the PAN, with salt to ensure that the same PAN gives a different hash for different merchants.
Author ND
Phone 08444 828 200
Public
Version V1.15
6.4. PAN Masking

With the settings file of PAYware Ocius Sentinel it is possible to enable or disable the StarOutIIN setting which controls how the PAN is masked when being returned to the POS via integration message. When this setting is enabled, the last four digits only of the PAN are returned (e.g. *********3123). When disabled, the PAN will be masked apart from the first six and last four digits (e.g. 492912***3123).
6.5. PED Version Mapping

In order to supply the ability to define which version of the PAYware Ocius Sentinel POS software should be utilised with specific version of the PED Sentinel software, the PED Version Mapping functionality has been created. Within WebCom, a section has been provided to allow a merchant to create a table which maps PAYware Ocius Sentinel POS and PED versions together. Once this mapping has been created within WebCom, each time a PED validation is performed (typically during registration and when performing a configuration download), PAYware Ocius Sentinel will compare the POS version to the information stored within the ICP Managed Service and ensure that any PED version mappings are adhered to. Should the PED version need updating, then a software update will be sent to the PED and installed. If no PED Version Mapping exists then PAYware Ocius Sentinel will progress as standard.
6.6. Procurement Card Processing

For merchants requiring the ability to process corporate purchasing cards, VeriFone has developed a Procurement Card Specification which is documented separately. This functionality can be supported via integration with PAYware Ocius Sentinel, providing the ability for Procurement Card Data to be submitted to VeriFone via the transaction request message. This message format is documented within the aforementioned procurement card specification. The Integration Version for PAYware Ocius Sentinel will need to be set to Version 4 to ensure that the VGIS reference is returned via integration within the transaction response message.
6.7. Transaction Value Modification

As part of a transaction process it is feasible that the merchant will need to apply a discount to the initial transaction value. This functionality must be enabled on the terminal and will result in a change to the standard processing flow, described below:
Author ND
Phone 08444 828 200
Public
Version V1.15
1. Transaction initiated using standard transaction request message (T Record), with a nominal dummy value, e.g. 1 2. PAYware Ocius prompts for Card Entry 3. PAYware Ocius reads and hashes the card details 4. POS Progress message returned detailing the card hash and card type 5. POS uses information as required for perform lookups/additional processing 6. POS returns a CONTTXN message to proceed with transaction processing, including any discounts required 7. PAYware Ocius updates the value and proceeds with standard transaction processing This functionality could be viewed as an alternative to the Get Card Details feature.
Author ND
Phone 08444 828 200
Public
Version V1.15
6.8. Card Wait

The Card Wait functionality has been introduced to provide additional integration flexibility for merchants. The functionality allows for the integration to place PAYware Ocius in a wait state, prior to processing a transaction, ready for a card to be presented. Once a card is presented and read by the PED, the card details are returned to the POS and based upon this information a decision on how to continue to be made. The card details presented are securely stored within the PED and should the merchant decide to proceed with a transaction after receiving the response from the card wait record (CARDWAIT message type), then the card initially presented will not need to be reinserted/swiped. After the result from the card wait record has been returned to the POS, PAYware Ocius will remain in the card wait state and will need to be instructed to either:
Cancel the Card Wait state (CANCELCARDWAIT) Proceed with one of the following transaction types, utilising the store card details: o Barclays Gift transaction (BGIFT) o EFT transaction (T Record) o Park Retail Gift transaction (PRG) o PayPoint transaction (PPOINT) o SVS transaction (SVS) Request the last message be resent Screen position change (SCRPOS) Send a request for information command (REQINFO) Window state (WINSTATE)
Should a Cancel Card Wait request be sent to PAYware Ocius, all securely stored card details are removed from the PED, before returning to the PAYware Ocius Main Menu. Please note: by default, the Card Wait response message will define the Capture Method as ICC Unknown. This is due to the fact that the data is only being read from the card at this stage and no Cardholder Verification Method is required until a transaction is processed using the card. 6.8.1. Card Wait Request (CARDWAIT Record) As discussed, the Card Wait functionality allows for PAYware Ocius to be placed in a wait for card state. Details of the card presented are returned to the POS, allowing merchants to decide upon a final transaction value (in case discounts are to be applied according to which card type is presented for example) and if they wish to proceed with a transaction as a result. The request message should adhere to the following format:
Field Name Type Description
Author ND
Phone 08444 828 200
Public
Version V1.15
1 2
Message Identifier Header
String Mandatory String Optional
This is identifies the type of message. This will always be CARDWAIT This is the header text to display on the PED when it prompts for the card details to be presented. To indicate that the section should be left empty, supply the following: <Blank> An empty field indicates that the terminal should display its standard data within this section This is the body text to display on the PED when it prompts for the card details to be presented. To indicate that the section should be left empty, supply the following: <Blank> An empty field indicates that the terminal should display its standard data within this section This is the footer text to display on the PED when it prompts for the card details to be presented. To indicate that the section should be left empty, supply the following: <Blank> An empty field indicates that the terminal should display its standard data within this section This is the time in seconds for the PED to wait for the card details to be presented. This value must be greater than or equal to 0 and must be less than or equal to the maximum value allowed for a 32-bit integer 10 seconds when expressed in milliseconds (i.e. 2147483 seconds / 24 days). A value of 0 means do not timeout . Default: 0
5
Body
String Optional
Footer
String Optional
Wait for Card Timeout
Integer Optional
Allowed Capture Methods
String Optional
This is a hex bitmap of the capture methods that the PED is to allow. The hex bitmap is comprised of the following hex values:Keyed = 01 Swipe = 02 ICC = 04 Reserved = 08 Default: ICC + Swipe + Keyed = 07 This is a hex bitmap of the fallback methods that the PED is to
7
4
Allowed Fallback
String
PAYware Ocius will timeout 10 seconds after this timeout to try to ensure that the PED times out before PAYware Ocius does. This is similar to the wait for card timeout employed by standard transaction processing. Also, the timeout is referenced against either the time that the request was sent to the PED or the last PED message received, whichever is the latter. 5 PAYware Ocius will treat a value of zero for the wait for card timeout to be 2147463647 milliseconds (24 days)
Author ND
Phone 08444 828 200
Public
Version V1.15
Methods
Optional
allow. The hex bitmap is comprised of the following hex values:Fallback from ICC to Swipe = 01 Fallback from Swipe to Key = 02 Default: Fallback from ICC to Swipe + Fallback from Swipe to Key = 03
Example record: CARDWAIT,Welcome to The Shop,Please Present Card,Thank You,0,07,03 6.8.2. Card Wait Cancel Request (CANCELCARDWAIT Record) In order to cancel a Card Wait request, the below message should be sent to PAYware Ocius:
Field 1 Name Message Identifier Type String Mandatory Description This is identifies the type of message. CANCELCARDWAIT This will always be
The Card Wait Cancel request response will follow the same format as defined within the Card Wait Response. The CANCELCARDWAIT command will be dependent on two scenarios; whether PAYware Ocius is still waiting for the card details or is in the Wait for Card transaction mode.
If PAYware Ocius is still waiting for the card details, the Card Wait Cancel command must be sent down the existing socket connection (similar to the continue transaction commands). This is to allow other client connections to process a request. If PAYware Ocius is in the Wait for Card transaction mode, the original socket connection will no longer be available.
Author ND
Phone 08444 828 200
Public
Version V1.15
6.8.3. Card Wait Response The result of the card wait request will follow the below format:
Field 1 Name Result Type Integer Description This indicates the result of the Wait for Card request Valid values are:Success = 0 Error = -ve The likely error codes are: -99 = Cancelled 135 = Wait for card timed out This indicates the type of card that was captured. Valid values are:-1 = Not Recognised 0 = EFT 1 = Barclays Gift 2 = GiveX 3 = PayPoint 4 = SVS 5 = PayZone ETU 6 = Nectar 7 = ChockStone 8 = Ukash 9 = Park Retail 10 = Merchant Specific Card Type 11 = Merchant Specific Card Type Default: Not Recognised = -1 This is the full track2 data of the non-EFT card. For Standard EFT cards this will be the starred PAN using either the all starred bar the first 6 and last 4 formatting or the all starred bar the last 4 formatting as determined by configuration. For non-Standard EFT cards, which are identified as allowing the full PAN to be returned, this will be the full PAN. For non-EFT cards, this will be the full PAN. This is the EFT cards expiry date / application expiration date in the format MMYY, if applicable. For non-EFT cards, this field will not be returned. This is the EFT cards start date / application effective date in the format MMYY, if applicable For non-EFT cards, this field will not be returned. This is the EFT cards issue number / application sequence number, if applicable This is the scheme name as identified from the relevant IIN table entry used to identify the card This identifies the method used to capture the card details. Valid values are:Not Set = 0 Keyed Cardholder Present = 1 Keyed Cardholder Not Present (Mail Order) = 2 Swiped = 3
Card Type
Integer
3 4
Track2 PAN
String String
Expiry Date / Application Expiration Date
String
Start Date / Application Effective Date
String
8 9
Issue Number / Application Sequence Number Scheme Name Capture Method
String
String Integer
Author ND
Phone 08444 828 200
Public
Version V1.15
10 11
Hash Track1
String String
ICC Fallback To Swipe = 4 ICC Fallback To Signature = 5 ICC PIN Only = 6 ICC PIN And Signature = 7 ICC No CVM = 8 Contactless EMV = 9 Contactless Magswipe = 10 Keyed Cardholder Not Present (Telephone Order) = 11 Keyed Cardholder Not Present (E-Commerce) = 12 ICC Unknown = 13 Keyed Cardholder Not Present (Account On File) = 14 This is a SHA-256 hash of the PAN with a merchant specific salt This is the full track1 data of the non-EFT crad.
Author ND
Phone 08444 828 200
Public
Version V1.15
6.9. Contactless Payments

In order to process contactless transactions with PAYware Ocius Sentinel; a contactless enabled device is required. The VX 820 PIN pad supports contactless transactions through an integrated contactless module for EFT transactions. The feature offers on-screen tap zone (CTLS logo) on the PED for optimised user experience and accepts EMV and mag-stripe contactless payments as well as PIN-based transactions. The PED only becomes active for contactless smart card transactions when enabled on the PIN pad. Provided the total transaction amount is less than the value of 20.00, a contactless payment can be used. If the amount is over 20.00* in value, then the sale becomes a standard Chip and PIN transaction. Please note: The contactless functionality is optional and only available if configured at merchant account level. For more details, please speak to your Account Manager. To perform a contactless transaction, please follow the below instructions: 1. Gently tap the card on the contactless logo
2.
on the screen
An activated LED visual on the display followed by a short beeping sound indicates a successful transaction
Please note this functionality is optional; to take advantage of this functionality it must be enabled at merchant account level. For more details, please contact your Account Manager.
* The value of 20 is subject to change in accordance with scheme rules.
Author ND
Phone 08444 828 200
Public
Version V1.15
7. Offline Functionality and Floor Limits

If no Floor Limits are configured then PAYware Ocius Sentinel will voice refer all offline keyed and swiped for transactions. For ICC transactions the decision to allow the transaction to be processed offline is controlled by the chip on the card. There will be instances whereby the card does not allow the transaction to be authorised and this will result in the transaction being declined as opposed to voice referred. Voice referral due to being in offline mode (or Comms Down, see below) is not supported in PAYware Ocius Sentinel. There are options available with PAYware Ocius to add a level of control when faced with this situation. These options are provided by floor limits, which can be configured on the merchant system (which will apply to each and every merchant account within that merchant system), and these are explained in more detail within the next two sections. There are no floor limits configured by default with PAYware Ocius Sentinel, and any floor limit being added should be carefully considered and approved by the acquiring bank.
7.1. EMV Floor Limit

PAYware Ocius Sentinel has a configurable EMV Floor Limit, whereby all transactions below the configured value inform the card that an attempt to authorise offline is being made prior to any communication attempt (i.e. before authorisation online is attempted). The card may choose to accept, decline or force the transaction online. The EMV floor limit is only used at the 1st generate stage of a transaction. It is just one factor taken into consideration as to whether the card can authorise the transaction offline or requires it to be sent online to the acquirer or the card issuer. In the event that there is a communication issue and the card instructs the terminal to authorise online, in most cases this is expected to result in a Decline or Voice Referral outcome. This is not a suitable solution to the majority of merchants due to the fact that transactions authorised offline in this manner carry greater risk and therefore higher merchant fees. This is unnecessary in the event that communications are available, which would mean that online authorisation was available and carry a lower merchant fee due to the cardholder being verified. Most of the current VeriFone merchant base has this floor limit set to 0.00 (zero) and it is always VeriFones recommendation that this floor limit is set to zero. The merchants acquirer is required to approve a floor limit of any value other than zero. Please note: VeriFone requires a copy of this agreement before the EMV Floor Limit can be enabled on an account.
Author ND
Phone 08444 828 200
Public
Version V1.15
7.2. Voice Referral Floor Limit

The Voice Referral floor limit will come into effect after any EMV Floor Limit in place has been checked. ICC Transactions The Voice Referral floor limit does not apply to ICC transactions. For Keyed and Swiped Transactions In the event that PAYware Ocius Sentinel cannot communicate with the VeriFone Managed Service or if PAYware Ocius Sentinel receives a Comms Down response from the VeriFone Managed Service, it will request manual authorisation of the transaction by performing a voice referral. In this scenario, the voice referral floor limit, if configured on the merchant system, will be taken into account to determine how the voice referral is processed. If the transaction value is less than the Offline Voice Referral floor limit then the transaction will be authorised locally, supplying the authorisation code agreed between the merchant and acquirer and stipulated on the signed agreement between the two parties.
7.3. Post Comms Floor Limit & Stand-In Authorisation

Permission from the acquirer is required before enabling this feature. Please note: VeriFone requires a copy of this agreement before the Post Comms floor limit can be enabled on an account. The Post Comms floor limit applies to ICC transactions only. The Post Comms floor limit allows the merchant to configure an authorisation floor limit that is taken into consideration after communication to authorise the transaction online with the acquirer has been attempted and cannot be successfully completed. PAYware Ocius Sentinel will make use of this floor limit for ICC transactions if either PAYware Ocius Sentinel cannot communicate with, times out waiting for the authorisation response from, or receives a Comms Down response from the VeriFone Managed Service. Unlike the EMV floor limit, it is not taken into consideration before the authorisation stage of the transaction, only being utilised in these specific scenarios. A merchant can have an EMV floor limit and a Post Comms floor limit configured. In this setup, any card approved offline at the 1st card action analysis will remain as approved offline as the Post Comms floor limit does not apply in this scenario. If the PAYware Ocius setup is configured with a Post Comms floor limit, and the transaction value is above the Post Comms floor limit, the terminal will implement the new higher value of the floor limit. The terminal then proceeds with the 2nd Card Action Analysis, informing the card that a communications failure occurred. The chip on the card utilises this information to make a final decision on whether to authorise or decline the transaction. It is still possible for
Author ND
Phone 08444 828 200
Public
Version V1.15
transactions to be rejected in this scenario due to the card overriding the authorisation within the 2nd Card Action Analysis stage of the EMV Transaction Flow. If the PAYware Ocius setup is configured with a Post Comms floor limit, and the transaction value is below the Post Comms floor limit PAYware Ocius Sentinel will determine whether it can stand-in for the issuer and attempt to accept transactions up to that floor limit that do not have a TVR (Transaction Verification Result) value which indicates a reason that the transaction should be declined. This process is automatically handled by PAYware Ocius Sentinel and is at the card acceptor (merchant)s risk. If the card acceptor does not wish to take this risk, the Post Comms floor limit should be set to zero. Should a Comms Fail authorisation result be received from the hosted service or PAYware Ocius Sentinel falls back to offline mode due to failure to successfully communicate to the hosted service, then the following transaction flow will be adopted, dependent upon the transaction value: 1. If the total transaction value (inclusive of any gratuity and cashback) is below or equal to the Post Comms floor limit: a. If the TVR indicates a reason that the transaction should be declined (see Decline Conditions), PAYware Ocius Sentinel will inform the PED that the transaction should be declined b. If the TVR does not indicate a reason that the transaction should be declined, PAYware Ocius Sentinel will inform the PED that the transaction should be authorised, i.e. that the decision has been made by the Card Acceptor (Merchant) to authorise the transaction. 2. If the total transaction value is above the Post Comms floor limit, the 2nd Card Action Analysis will be advised by the terminal that there was a communications failure. This stage of the transaction process will then provide an authorised or decline result, as decided by the chip. It is possible that the 2nd Card Action Analysis (also known as 2nd Generate) could still decide to decline the transaction even if the transaction value is below the Post Comms floor limit and stand-in authorisation is configured; however, this is understood to be an unlikely outcome.
Author ND
Phone 08444 828 200
Public
Version V1.15
Decline Conditions Should any of the elements listed below in the TVR breakdown be set, then the transaction will decline: Combined DDA / Gen AC failed Off-line DDA failed Card on hot list ICC data missing SDA failed Off-line data authentication not performed Requested service not allowed for card product Application not yet effective Expired application PIN try limit exceeded Cardholder verification unsuccessful Card acceptor forced on-line (i.e. suspicious) Upper consecutive off-line limit exceeded
Author ND
Phone 08444 828 200
Public
Version V1.15
7.4. Offline Transaction Specifics

Offline Transactions are processed when PAYware Ocius Sentinel:

Is unable to contact the VeriFone central servers Receives a Comms Down result Times out waiting for a response from the acquirer
In these scenarios, the offline transactions are stored in the PED. If unable to contact the VeriFone central servers, PAYware Ocius Sentinel will return an offline token in the T-record response if token registration is performed. The EFTSN placed in the receipt is prefixed with OL. If able to contact the VeriFone central servers but receives a Comms Down result or times out waiting for a response from the acquirer, PAYware Ocius Sentinel will return an online token in the T-record response if token registration is performed. The EFTSN placed in the receipt is prefixed with OL. The PED has storage limits depend on the type of PED in use and its capacity. There is storage for over 300 transactions on the PED. When the storage capacity of the PED is reached no further offline transactions can be run. After this transaction limit is reached, no further transactions can be stored on the PED and offline transactions will fail to complete. When PAYware Ocius Sentinel next connects to the VeriFone central severs (at the logon or the next transaction any offline transactions present in the PED are transferred to the VeriFone central server. Offline transactions which are processed when PAYware Ocius Sentinel is able to contact the VeriFone central servers but the VeriFone central servers not able to reach the Acquirer are stored in the PED. PAYware Ocius Sentinel will return an online token in the T-record response if token registration is performed. The EFTSN placed in the receipt is prefixed with OL.
7.5. Offline Hash Generation

Some merchants will store the VeriFone hashed version (SHA-256) of the card number returned via integration when configured to the appropriate Integration Version. Customer specific hashes, when used, are amalgamated with the generic VeriFone hash by PAYware Ocius Sentinel and returned to the merchant via integration. VeriFones SHA-256 hashed version of the card number is 32 bytes in length (after base64 decoding). In a scenario when a customer specific hash is also produced, this will be returned within the same hash field of the integration response. The customer specific hash will follow the SHA-256, 32 byte hash, without any separator in place within the field between the two hashes.
Author ND
Phone 08444 828 200
Public
Version V1.15
Hash representations of card numbers are generated by the PED and returned via integration. When PAYware Ocius Sentinel is offline, the generic VeriFone (SHA-256) hash is still returned via integration as it is generated of the PED and not by the VeriFone Servers.
7.6. Example EFT Scenarios

In the below scenarios, the following floor limits are configured:

EMV Floor Limit 0.00 Voice Referral Floor Limit 100.00 Post Comms floor limit 200.00 Transaction Value 150.00
Here are four example scenarios to demonstrate the offline processing and floor limits described. In each of the examples below, a token registration has been performed as part of the transaction in order to also provide examples of how tokens are handled online/offline: a) PAYware Ocius Sentinel cannot reach VeriFone servers. Swiped Transaction for 150.00 As this is a Swiped Transaction the Voice Referral Floor Limit applies. As the transaction is above the Voice Referral Floor Limit, the transaction is prompted for Voice Referral. As PAYware Ocius Sentinel cannot reach the VeriFone server, the T-record returns an offline token. The SHA-256 hash representation of the card number is returned via integration after being generated by the PED; this process is unaffected by being offline to the VeriFone servers. The transaction is stored in the PED for later transmission to the PAYware Ocius Sentinel Server. b) PAYware Ocius Sentinel cannot reach VeriFone servers. ICC Transaction for 150.00 As this is an ICC transactions and a Post Comms floor limit has been specified, the Post Comms floor limit applies. As the transaction is below the Post Comms floor limit, the transaction is processed by the Stand-In Authorisation. If the card allows, authorisation of the transaction will be attempted by PAYware Ocius Sentinel. As PAYware Ocius Sentinel cannot reach the VeriFone server, the T-record returns an offline token. The SHA-256 hash representation of the card number is returned via integration after being generated by the PED; this process is unaffected by being offline to the VeriFone servers. The transaction is stored in the PED for later transmission to the PAYware Ocius Sentinel Server. c) PAYware Ocius Sentinel can reach VeriFone servers. VeriFone servers cannot reach Acquirer. Swiped Transaction for 150.00
Author ND
Phone 08444 828 200
Public
Version V1.15
As this is a Swiped Transaction the Voice Referral Floor Limit applies. As the transaction is above the Voice Referral Floor Limit, the transaction is prompted for Voice Referral. As PAYware Ocius Sentinel can reach the VeriFone server, the T-record returns an online token. The SHA-256 hash representation of the card number is returned via integration after being generated by the PED. The transaction is stored in the PED for later transmission to VeriFones central servers. d) PAYware Ocius Sentinel can reach VeriFone servers. VeriFone servers cannot reach Acquirer. ICC Transaction for 150.00 As this is an ICC transactions and a Post Comms floor limit has been specified, the Post Comms floor limit applies. As the transaction is below the Post Comms floor limit, the transaction is processed by the Stand-In Authorisation. If the card allows, the transaction will be authorised by PAYware Ocius Sentinel. As PAYware Ocius Sentinel can reach the VeriFone server, the T-record returns an online token. The SHA-256 hash representation of the card number is returned via integration after being generated by the PED. The transaction is stored in the PED for later transmission to the PAYware Ocius Sentinel Server. e) PAYware Ocius Sentinel cannot reach the VeriFone servers. CARDWAIT request No floor limits are applied during the CARDWAIT process; the card presented is read and its details returned to the POS via integration without authorisation being sought from the acquirer. One of the fields returned within the CARDWAIT response message is the hash representation of the card. The SHA-256 hash representation of the card number is returned via integration after being generated by the PED. This process is unaffected by being offline to the VeriFone servers.
Author ND
Phone 08444 828 200
Public
Version V1.15
7.7. SVS Offline Functionality

When processing an SVS transaction, if PAYware Ocius Sentinel goes offline then this could be for two reasons:
a)
PAYware Ocius Sentinel is unable to connect to VeriFones central servers PAYware Ocius Sentinel will attempt to connect to the central server 3 times (not configurable) before falling back to Offline mode, and therefore initiating the IVR process In this scenario, an error message of -99,Tranasction Cancelled will be returned to the POS
b)
PAYware Ocius Sentinel can connect to VeriFones central servers but the SVS Host System is unavailable In this scenario, PAYware Ocius Sentinel will wait for a response for the period of time defined within the AuthTimeout setting within the Program Settings file (by default 60 seconds) before timing out waiting for a response and informing the POS of this timeout transaction outcome. In this scenario, an error message of -181,Host Unavailable will be returned to the POS
When an SVS transaction is attempted but a timeout is experienced, the VeriFone central servers will initiate and handle the reversal process with the SVS host; ensuring that any transactions which are not completed are reversed. VeriFones central servers have a 45 second timeout period which is not configurable. Any transactions which fail due to a timeout should be re-processed using the IVR functionality. 7.7.1. SVS Reversal Processing As aforementioned, VeriFones central servers handle the reversal process on behalf of the merchant; attempting to reverse any transactions, which are not completed within the timeout period, with the SVS host. The process is as follows:

SVS request message sent from PAYware Ocius Sentinel and inserted into the relevant database Database passes SVS request message to the SVS server application within the VeriFone central infrastructure. A timeout is initiated at this point of 45 seconds SVS server application communicates with the SVS host to attempt to process the request o If the SVS server application fails to return a response to the database within the 45 second timeout period, then the transaction is deleted from the database and a reversal request passed to the SVS server application to send to the SVS host. PAYware Ocius Sentinel is simultaneously informed that the transaction has timed out The SVS server application updates the database with the response from the SVS host on receipt of the information o At this stage of the transaction, the databases 45 second timeout period is restarted as an update to the transaction has been received
Author ND
Phone 08444 828 200
Public
Version V1.15
The database passes the transaction result back to PAYware Ocius Sentinel via the SVS response message PAYware Ocius Sentinel acknowledges to the database that it has received the transaction result message, which initiates the SVS transaction being confirmed On receipt of the confirmation request, the SVS transaction is completed on the database and the SVS transaction removed from the processing queue to ensure that transaction is not reversed by the 45 timeout period expiring o If the database fails to receive a confirmation request from PAYware Ocius Sentinel within the 45 second timeout period, then the transaction is deleted from the database and a reversal request passed to the SVS server application to send to the SVS host
When a reversal is attempted, the same number of connection attempts is applicable as with standard processing. The SVS server application will attempt to connect to the SVS host 3 times in order to send the reversal, before returning a result to the VeriFone database.
7.8. Transax Offline Functionality

When processing a Transax transaction, if PAYware Ocius Sentinel is unable to connect to the VeriFone central servers it will attempt to connect 3 times (not configurable), with a timeout of 60 seconds on each attempt, before falling back to offline processing, via IVR. However, if receiving an error response to the initial Transax Request then PAYware Ocius Sentinel will not retry to connect. Should PAYware Ocius Sentinel be able to connect to the VeriFone central servers but be unable to reach the Transax host then it will retry up to 3 times (not configurable), with the transaction timing out if exceeding 45 seconds.
7.1. Automatic Return Online Functionality

When PAYware Ocius Sentinel returns to the main menu screen; if it is offline it enables an offline timer. An offline timer, when enabled performs a check every 10 minutes to see if it can go back to an online state. If PAYware Ocius Sentinel is returned to an online state, it will perform an offline transaction submission attempt. If PAYware Ocius Sentinel is still offline, the timer gets restarted. The timer gets stopped if PAYware Ocius Sentinel leaves the main menu screen or if it is processing the timer elapsed event.
Author ND
Phone 08444 828 200
Public
Version V1.15
APPENDIX
Contact Details
VeriFone 100 Eureka Park Ashford Kent TN25 4AZ
Main Tel: Main Fax: Merchant Helpdesk: Merchant Helpdesk Fax: Implementations:
08444 828200 08444 828210 08444 828222 08444 828223 08444 828273
Email:
Sales Enquiries Merchant Helpdesk (For live queries) Implementation Enquiries (For test queries)
Ocius.Enquiries@VeriFone.com
Ocius.Helpdesk@VeriFone.com
Ocius.Implementations@VeriFone.com
Website:
www.VeriFone.com
Author ND
Phone 08444 828 200
Public
Version V1.15
Currency Code ISO 4217

Currency Afghani Algerian dinar Argentine peso Armenian dram Aruban guilder Australian dollar Code AFN DZD ARS AMD AWG AUD Num 971 012 032 051 533 036 Locations using this currency Afghanistan Algeria Argentina Armenia Aruba Australia, Australian Antarctic Territory, Christmas Island, Cocos (Keeling) Islands, Heard and McDonald Islands, Kiribati, Nauru, Norfolk Island, Tuvalu Azerbaijan Bahamas Bahrain Thailand Panama Bangladesh Barbados Belarus Belize Bermuda Bolivia Bolivia Brazil Brunei, Singapore Bulgaria Burundi Canada Cape Verde Cayman Islands Ghana Benin, Burkina Faso, Cte d'Ivoire, Guinea-Bissau, Mali, Niger, Senegal, Togo Cameroon, Central African Republic, Congo, Chad, Equatorial Guinea, Gabon French Polynesia, New Caledonia, Wallis and Futuna Chile China (Mainland)
Azerbaijanian manat Bahamian dollar Bahraini dinar Baht Balboa Bangladeshi taka Barbados dollar Belarusian ruble Belize dollar Bermudian dollar (customarily known as Bermuda dollar) Bolivian Mvdol (funds code) Boliviano Brazilian real Brunei dollar Bulgarian lev Burundian franc Canadian dollar Cape Verde escudo Cayman Islands dollar Cedi CFA Franc BCEAO CFA franc BEAC CFP franc Chilean peso Chinese Yuan Code reserved for testing purposes Colombian peso Comoro franc Convertible marks Cordoba oro Costa Rican colon Croatian kuna Cuban convertible peso Cuban peso Czech Koruna Dalasi Danish krone Denar Djibouti franc Dobra Dominican peso East Caribbean dollar
AZN BSD BHD THB PAB BDT BBD BYR BZD BMD BOV BOB BRL BND BGN BIF CAD CVE KYD GHS XOF XAF XPF CLP CNY XTS COP KMF BAM NIO CRC HRK CUC CUP CZK GMD DKK MKD DJF STD DOP XCD
944 044 048 764 590 050 052 974 084 060 984 068 986 096 975 108 124 132 136 936 952 950 953 152 156 963 170 174 977 558 188 191 931 192 203 270 208 807 262 678 214 951
Egyptian pound Ethiopian birr Euro
EGP ETB EUR
818 230 978
Colombia Comoros Bosnia and Herzegovina Nicaragua Costa Rica Croatia Cuba Cuba Czech Republic Gambia Denmark, Faroe Islands, Greenland Macedonia Djibouti So Tom and Prncipe Dominican Republic Anguilla, Antigua and Barbuda, Dominica, Grenada, Montserrat, Saint Kitts and Nevis, Saint Lucia, Saint Vincent and the Grenadines Egypt Ethiopia Austria, Belgium, Cyprus, Finland, France, Germany,
Author ND
Phone 08444 828 200
Public
Version V1.15
Greece, Ireland, Italy, Luxembourg, Malta, Netherlands, Portugal, Slovakia, Slovenia, Spain, Andorra, Kosovo, Monaco, Montenegro, San Marino, Vatican European Composite Unit (EURCO) (bond market unit) European Monetary Unit (E.M.U.-6) (bond market unit) European Unit of Account 17 (E.U.A.-17) (bond market unit) European Unit of Account 9 (E.U.A.-9) (bond market unit) Falkland Islands pound Fiji dollar Forint Franc Congolais Gibraltar pound Gold (one troy ounce) Guarani Guinea franc Guyana dollar Haiti gourde Hong Kong dollar Hryvnia Iceland krona Indian rupee Iranian rial Iraqi dinar Israeli new sheqel Jamaican dollar Japanese yen Jordanian dinar Kenyan shilling Kina Kip Kroon Kuwaiti dinar Kwacha Kwacha Kwanza Kyat Lari Latvian lats Lebanese pound Lek Lempira Leone Lesotho loti Liberian dollar Libyan dinar Lilangeni Lithuanian litas Malagasy ariary Malaysian ringgit Manat Mauritius rupee Metical Mexican peso Mexican Unidad de Inversion (UDI) (funds code) Moldovan leu Moroccan dirham Naira XBA XBB XBD XBC FKP FJD HUF CDF GIP XAU PYG GNF GYD HTG HKD UAH ISK INR IRR IQD ILS JMD JPY JOD KES PGK LAK EEK KWD MWK ZMK AOA MMK GEL LVL LBP ALL HNL SLL LSL LRD LYD SZL LTL MGA MYR TMT MUR MZN MXN MXV MDL MAD NGN 955 956 958 957 238 242 348 976 292 959 600 324 328 332 344 980 352 356 364 368 376 388 392 400 404 598 418 233 414 454 894 973 104 981 428 422 008 340 694 426 430 434 748 440 969 458 934 480 943 484 979 498 504 566 Falkland Islands Fiji Hungary Democratic Republic of Congo Gibraltar Paraguay Guinea Guyana Haiti Hong Kong Special Administrative Region Ukraine Iceland Bhutan, India Iran Iraq Israel Jamaica Japan Jordan Kenya Papua New Guinea Laos Estonia Kuwait Malawi Zambia Angola Myanmar Georgia Latvia Lebanon Albania Honduras Sierra Leone Lesotho Liberia Libya Swaziland Lithuania Madagascar Malaysia Turkmenistan Mauritius Mozambique Mexico Mexico Moldova Morocco, Western Sahara Nigeria
Author ND
Phone 08444 828 200
Public
Version V1.15
Nakfa Namibian dollar Nepalese rupee Netherlands Antillean guilder New Taiwan dollar New Zealand dollar Ngultrum No currency North Korean won Norwegian krone Nuevo sol Ouguiya Pa'anga Pakistan rupee Palladium (one troy ounce) Pataca Peso Uruguayo Philippine peso Platinum (one troy ounce) Pound sterling
ERN NAD NPR ANG TWD NZD BTN XXX KPW NOK PEN MRO TOP PKR XPD MOP UYU PHP XPT GBP
232 516 524 532 901 554 064 999 408 578 604 478 776 586 964 446 858 608 962 826
Eritrea Namibia Nepal Netherlands Antilles Taiwan and other islands that are under the effective control of the Republic of China (ROC) Cook Islands, New Zealand, Niue, Pitcairn, Tokelau Bhutan North Korea Norway, Bouvet Island, Queen Maud Land, Peter I Island Peru Mauritania Tonga Pakistan Macau Special Administrative Region Uruguay Philippines United Kingdom, Crown Dependencies (the Isle of Man and the Channel Islands), certain British Overseas Territories (South Georgia and the South Sandwich Islands, British Antarctic Territory and British Indian Ocean Territory) Botswana Qatar Guatemala Oman Cambodia Romania Maldives Indonesia Russia, Abkhazia, South Ossetia Rwanda Saint Helena Samoa Saudi Arabia Serbia Seychelles Singapore, Brunei Solomon Islands Kyrgyzstan Somalia Tajikistan South Africa South Korea International Monetary Fund Sri Lanka Sudan Suriname Sweden Switzerland, Liechtenstein Syria Tanzania Kazakhstan Trinidad and Tobago Mongolia Tunisia Turkey, Northern Cyprus Uganda International Union of Railways
Pula Qatari rial Quetzal Rial Omani Riel Romanian new leu Rufiyaa Rupiah Russian rouble Rwanda franc Saint Helena pound Samoan tala Saudi riyal Serbian dinar Seychelles rupee Silver (one troy ounce) Singapore dollar Solomon Islands dollar Som Somali shilling Somoni South African rand South Korean won Special Drawing Rights Sri Lanka rupee Sudanese pound Surinam dollar Swedish krona/kronor Swiss franc Syrian pound Tanzanian shilling Tenge Trinidad and Tobago dollar Tugrik Tunisian dinar Turkish lira Uganda shilling UIC franc (special settlement
BWP QAR GTQ OMR KHR RON MVR IDR RUB RWF SHP WST SAR RSD SCR XAG SGD SBD KGS SOS TJS ZAR KRW XDR LKR SDG SRD SEK CHF SYP TZS KZT TTD MNT TND TRY UGX XFU
072 634 320 512 116 946 462 360 643 646 654 882 682 941 690 961 702 090 417 706 972 710 410 960 144 938 968 752 756 760 834 398 780 496 788 949 800 Nil
Author ND
Phone 08444 828 200
Public
Version V1.15
currency) Unidad de Fomento (funds code) Unidad de Valor Real United Arab Emirates dirham United States dollar (next day) (funds code) United States dollar (same day) [who?] (funds code) (one source claims it is no longer used, but it is still on the ISO 4217-MA list) US dollar
CLF COU AED USN USS
990 970 784 997 998
Chile Colombia United Arab Emirates United States United States
USD
840
Uzbekistan som Vatu Venezuelan bolvar fuerte Vietnamese ng WIR euro (complementary currency) WIR franc (complementary currency) Yemeni rial Zimbabwe dollar Zoty
UZS VUV VEF VND CHE CHW YER ZWL PLN
860 548 937 704 947 948 886 932 985
American Samoa, British Indian Ocean Territory, Ecuador, El Salvador, Guam, Haiti, Marshall Islands, Micronesia, Northern Mariana Islands, Palau, Panama, Puerto Rico, Timor-Leste, Turks and Caicos Islands, United States, Virgin Islands, Bermuda (as well as Bermudian Dollar) Uzbekistan Vanuatu Venezuela Vietnam Switzerland Switzerland Yemen Zimbabwe Poland
Author ND
Phone 08444 828 200
Public
Version V1.15
Country Codes ISO 3166

Official country names used by the ISO 3166/MA Afghanistan land Islands Albania Algeria American Samoa Andorra Angola Anguilla Antarctica Antigua and Barbuda Argentina Armenia Aruba Australia Austria Azerbaijan Bahamas Bahrain Bangladesh Barbados Belarus Belgium Belize Benin Bermuda Bhutan Bolivia Bosnia and Herzegovina Botswana Bouvet Island Brazil British Indian Ocean Territory Brunei Darussalam Bulgaria Burkina Faso Burundi Cambodia Cameroon Canada Cape Verde Cayman Islands Central African Republic Chad Chile China Christmas Island Cocos (Keeling) Islands Colombia Comoros Congo Congo, Democratic Republic of the Cook Islands Costa Rica Cte d'Ivoire Croatia Cuba Cyprus Czech Republic Denmark Numeric 004 248 008 012 016 020 024 660 010 028 032 051 533 036 040 031 044 048 050 052 112 056 084 204 060 064 068 070 072 074 076 086 096 100 854 108 116 120 124 132 136 140 148 152 156 162 166 170 174 178 180 184 188 384 191 192 196 203 208 Alpha-3 AFG ALA ALB DZA ASM AND AGO AIA ATA ATG ARG ARM ABW AUS AUT AZE BHS BHR BGD BRB BLR BEL BLZ BEN BMU BTN BOL BIH BWA BVT BRA IOT BRN BGR BFA BDI KHM CMR CAN CPV CYM CAF TCD CHL CHN CXR CCK COL COM COG COD COK CRI CIV HRV CUB CYP CZE DNK Alpha-2 AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CY CZ DK
Author ND
Phone 08444 828 200
Public
Version V1.15
Djibouti Dominica Dominican Republic Ecuador Egypt El Salvador Equatorial Guinea Eritrea Estonia Ethiopia Falkland Islands (Malvinas) Faroe Islands Fiji Finland France French Guiana French Polynesia French Southern Territories Gabon Gambia Georgia Germany Ghana Gibraltar Greece Greenland Grenada Guadeloupe Guam Guatemala Guernsey Guinea Guinea-Bissau Guyana Haiti Heard Island and McDonald Islands Holy See (Vatican City State) Honduras Hong Kong Hungary Iceland India Indonesia Iran, Islamic Republic of Iraq Ireland Isle of Man Israel Italy Jamaica Japan Jersey Jordan Kazakhstan Kenya Kiribati Korea, Democratic People's Republic of Korea, Republic of Kuwait Kyrgyzstan Lao People's Democratic Republic Latvia
262 212 214 218 818 222 226 232 233 231 238 234 242 246 250 254 258 260 266 270 268 276 288 292 300 304 308 312 316 320 831 324 624 328 332 334 336 340 344 348 352 356 360 364 368 372 833 376 380 388 392 832 400 398 404 296 408 410 414 417 418 428
DJI DMA DOM ECU EGY SLV GNQ ERI EST ETH FLK FRO FJI FIN FRA GUF PYF ATF GAB GMB GEO DEU GHA GIB GRC GRL GRD GLP GUM GTM GGY GIN GNB GUY HTI HMD VAT HND HKG HUN ISL IND IDN IRN IRQ IRL IMN ISR ITA JAM JPN JEY JOR KAZ KEN KIR PRK KOR KWT KGZ LAO LVA
DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR KW KG LA LV
Author ND
Phone 08444 828 200
Public
Version V1.15
Lebanon Lesotho Liberia Libyan Arab Jamahiriya Liechtenstein Lithuania Luxembourg Macao Macedonia, the former Yugoslav Republic of Madagascar Malawi Malaysia Maldives Mali Malta Marshall Islands Martinique Mauritania Mauritius Mayotte Mexico Micronesia, Federated States of Moldova, Republic of Monaco Mongolia Montenegro Montserrat Morocco Mozambique Myanmar Namibia Nauru Nepal Netherlands Netherlands Antilles New Caledonia New Zealand Nicaragua Niger Nigeria Niue Norfolk Island Northern Mariana Islands Norway Oman Pakistan Palau Palestinian Territory, Occupied Panama Papua New Guinea Paraguay Peru Philippines Pitcairn Poland Portugal Puerto Rico Qatar Runion Romania Russian Federation Rwanda
422 426 430 434 438 440 442 446 807 450 454 458 462 466 470 584 474 478 480 175 484 583 498 492 496 499 500 504 508 104 516 520 524 528 530 540 554 558 562 566 570 574 580 578 512 586 585 275 591 598 600 604 608 612 616 620 630 634 638 642 643 646
LBN LSO LBR LBY LIE LTU LUX MAC MKD MDG MWI MYS MDV MLI MLT MHL MTQ MRT MUS MYT MEX FSM MDA MCO MNG MNE MSR MAR MOZ MMR NAM NRU NPL NLD ANT NCL NZL NIC NER NGA NIU NFK MNP NOR OMN PAK PLW PSE PAN PNG PRY PER PHL PCN POL PRT PRI QAT REU ROU RUS RWA
LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL AN NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW
Author ND
Phone 08444 828 200
Public
Version V1.15
Saint Helena Saint Kitts and Nevis Saint Lucia Saint Pierre and Miquelon Saint Vincent and the Grenadines Samoa San Marino So Tom and Prncipe Saudi Arabia Senegal Serbia Seychelles Sierra Leone Singapore Slovakia Slovenia Solomon Islands Somalia South Africa South Georgia and the South Sandwich Islands Spain Sri Lanka Sudan Suriname Svalbard and Jan Mayen Swaziland Sweden Switzerland Syrian Arab Republic Taiwan, Province of China Tajikistan Tanzania, United Republic of Thailand Timor-Leste Togo Tokelau Tonga Trinidad and Tobago Tunisia Turkey Turkmenistan Turks and Caicos Islands Tuvalu Uganda Ukraine United Arab Emirates United Kingdom United States United States Minor Outlying Islands Uruguay Uzbekistan Vanuatu Venezuela Viet Nam Virgin Islands, British Virgin Islands, U.S. Wallis and Futuna Western Sahara Yemen Zambia Zimbabwe
654 659 662 666 670 882 674 678 682 686 688 690 694 702 703 705 090 706 710 239 724 144 736 740 744 748 752 756 760 158 762 834 764 626 768 772 776 780 788 792 795 796 798 800 804 784 826 840 581 858 860 548 862 704 092 850 876 732 887 894 716
SHN KNA LCA SPM VCT WSM SMR STP SAU SEN SRB SYC SLE SGP SVK SVN SLB SOM ZAF SGS ESP LKA SDN SUR SJM SWZ SWE CHE SYR TWN TJK TZA THA TLS TGO TKL TON TTO TUN TUR TKM TCA TUV UGA UKR ARE GBR USA UMI URY UZB VUT VEN VNM VGB VIR WLF ESH YEM ZMB ZWE
SH KN LC PM VC WS SM ST SA SN RS SC SL SG SK SI SB SO ZA GS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW
Author ND
Phone 08444 828 200
Public
Version V1.15
VeriFone Error Codes

Error Code 0001 0002 General Description Unspecified error Invalid transaction type Additional Technical Description (if required) An example of this could be a Refund being passed when the site are not set up to do so. A trace of what was passed will be in the system log. General card error. Track2 must either be ;PAN=YYMMsss?x or just the PAN. The card Issuer Identification Number (IIN) has not been located in the IIN table. The IIN is typically the first 4 to 6 digits of the card number. The card has been identified, but the card scheme is not accepted at the given site. The LUHN check digit is incorrect (the card has been mis-keyed or mis-swiped). The length of the PAN is incorrect for the given card scheme. The pen-ultimate check digit is invalid. Recommended Action Contact VeriFone Use alternative method for transaction type.
0003
Invalid card / invalid Track2
Re-enter card number or re-swipe card
0004
Card scheme not recognised
Prompt for alternate method of payment
0005
Card scheme not accepted
Reject Transaction
0006
Invalid card number (lcd)
Re-enter card number or re-swipe card
0007 0008 0009 0010 0011 0012 0013
Invalid card number length Invalid card number (pcd) Expired card Card not yet valid Invalid card service code File or XML missing or wrong format File permanently locked
Re-enter card number or re-swipe card Re-enter card number or re-swipe card Prompt for alternate method of payment Prompt for alternate method of payment Prompt for alternate method of payment Contact VeriFone Contact VeriFone
The Track2 service code is invalid. A required file or XML is missing or has wrong format. A file required by the EFT library was still locked after EFT FIO TRIES attempts. The library has failed to allocate sufficient heap. The requested account number does not exist. Purchase value exceeds card scheme ceiling limit Cashback value exceeds card scheme ceiling limit The transaction currency code is invalid or incorrect for the given site. Attempt to lay away invalid / lay aways are not allowed Attempt to lay away a transaction where there is already a transaction laid away on that card The EFT system has not been configured A buffer is too small Invalid / unknown communications device type Configuration file is invalid / bad format There are no valid accounts specified in the TillInfo.cfg Invalid channel
0014 0015
Out of memory Account number does not exist Value exceeds ceiling limit
Contact VeriFone Check the account number configuration of the system, ensuring it matches that configured within WinTI Prompt for alternative method of payment. Arrange to increase ceiling limits Revise transaction cash-back value
0016
0017 0018
Cashback exceeds ceiling limit Transaction currency is invalid
0019 0020
Lay aways are not allowed Lay away already stored
0021 0022 0023 0024 0025 0026
EFT system not configured Internal error, buffer too small Unknown comms device type Configuration file is invalid No valid accounts Invalid channel
Check communications configuration Check system configuration Check system configuration Check> 2 transactions arent being passed down the same channel. 2 tills arent using the same channel
Author ND
Phone 08444 828 200
Public
Version V1.15
number. WinTI EFTChans within the registry has enough available channels set (Socket mode only). 0027 0028 0029 0030 0031 0032 0033 System error module not loaded General transaction error Transaction store unavailable Unspecified error Unspecified error:2 Library not open Possible text for error: <fieldname> (<fieldno>) should be X to Y characters in length. <fieldname> out of range, should be X to Y. <fieldname> out of tolerance, is X, should be X +/- Z. Line discount not available for Cendant cards. Line count (X) doesnt match header -> CPC lines (Y). Separate post and packing only on Amex cards. Where <fieldname> = part number, part description, commodity code, unit of measure, quantity, net value, VAT amount, gross value, PAN, PO number, customer number, customer name, customer VAT no, destination zip, destination country code, order date, original invoice number, cost centre, invoice net amount, invoice VAT amount, post and packing VAT, invoice gross or transaction total. Invalid CPC data Modifier field invalid/missing System error (Track2 check module has not been loaded) Transaction store unavailable Unspecified error Transaction cancelled EFT library is unavailable The error message is made up of a combination of text (1 to 6) with the applicable field name inserted, as applicable. For example: Net value out of tolerance, is 123.45, should be 123.00 +/- 1 Re-enter transaction Check Live Store. Check hard disk space. Check system log for indication of error. Channel available for next transaction
0034
0035 0036 0037
Invalid card / invalid Track 1 Invalid card / invalid Track 3 Invalid / missing expiry date
0038 0039
Invalid / missing issue number Invalid / missing start date
0040 0041 0042 0043 0044 0045 0046 0047
Purchase/refund value bad or missing Cash-back value bad or missing Auth code value bad or missing Cheque account number value bad or missing Invalid cheque sort code Invalid / missing cheque number Invalid / missing cheque type Invalid EFT serial number
As the modifier is passed within the T record the host software is likely to be the cause of this Track 1 is invalid Track 3 is invalid The expiry date is either invalid or missing. If key entered, the format should be MMYY The issue number is either invalid (value or length) or missing The start date is either invalid or missing. If key entered, the format should be MMYY. The transaction value is either invalid or missing The cash-back value is either invalid or missing The authorisation code is either invalid or missing The cheque account number is either invalid or missing The cheque sort code is either invalid or missing
Re-swipe card Re-swipe card Re-enter expiry date or re-swipe card
Re-enter issue number or re-swipe card Re-enter start date or re-swipe card
Re-enter transaction Re-enter transaction
Re-enter cheque account number Re-enter sort code Re-enter cheque number Re-enter cheque type Re create *.cnf
The EFT serial number is either
Author ND
Phone 08444 828 200 invalid or missing in the .Cnf file Purchasing card invoice data has been presented for a nonPurchasing Card (where invoice data is not valid/required) Attempt to confirm or reject a transaction, which has already been confirmed or rejected Could be a permission problem on the PC Attempt to perform a post confirm reversal on a PWCB or Cash Advance has been dis-allowed (as post confirm reversals are not supported when cash is involved) The details supplied in the post confirm reversal message is not consistent with the data stored for the transaction to be reversed Attempt to perform a post transaction reversal has failed because the transaction has already been voided/reversed The card number is on the locally stored host list (received from the acquirer and/or entered by the customer). The card must be rejected The format of the confirmation message is invalid (confirming a declining transaction). The confirmation message should contain a command value of 2 (reverse/reject) and not a value of 1 (confirm). CV2 is invalid AVS is invalid Merchant Details passed in XML Gateway are Invalid. The Mobile Number format passed is incorrect The bank account number within the supplied T-Record is incorrect. The Token ID supplied is incorrect or invalid for the merchant system Unexpected / Invalid Authorisation Response from M-Voucher Host The Target Voucher Type is invalid (M-Voucher) The refund pin entered is invalid
Public
Version V1.15
0048
Unexpected CPC data
Re-enter transaction without invoice data or prompt for a valid Purchasing Card
0049
Transaction already confirmed or rejected Copy protection failure Post confirm reversal not allowed for PWCB or Cash Advance (reserved for future use) Transaction data supplied in post conf rev not consistent with store (reserved for future use) Transaction already void
0050 0051
Reverse transaction manually (as cash is involved)
0052
0053
0054
Card on hot list
0055
Attempt to confirm a declined transaction
0056 0057 0058
EFT_ERR_BAD_CV2 EFT_ERR_BAD_AVS Invalid Merchant Details
0059 0060 0062 0064 0065 0066
Invalid Mobile Number Format Invalid/missing bank account number Token does not exist or invalid token for this merchant system Unexpected / Invalid Authorisation Response Invalid voucher target type Invalid Refund Pin
Check CV2 and re-enter Check AVS and re-enter Check both the GUID and Passcode information that being passed to the XML Gateway Please check and re-enter the mobile number supplied. Check the bank number being passed and re-enter as necessary. Check the Token ID is correct and for use with the current merchant system Please contact VeriFone Support Please contact VeriFone Support Please enter the correct refund pin if continues to fail, please contact VeriFone Support Check the Report ID that is being passed Contact VeriFone Check Gratuity Value Capture Method Not Set correctly Use a different card or proceed without cashback Use a different card Reduce transaction value
0067
Report Not Supported
0068 0069 0070 0071 0072 0073
Report Failed Gratuity value exceeded Invalid Capture Not Supported Cashback not allowed by card Cash advance not allowed by card Max refund value exceeded
The Report ID supplied is either invalid or does not correspond to a report that is supported Integrated report failed Check Gratuity Value Check PAYware Ocius settings Card does not allow cashback Card does not allow cash advance Refund transaction value is greater than the maximum refund value set on the account The bill being cancelled is already completed and therefore cannot be cancelled.
0074
Bill Already Complete
N\A
Author ND
Phone 08444 828 200 0075 No ETU accounts Attempt to process ETU transaction without ETU accounts being present on terminal Attempt to process an online only card whilst offline Attempt to cancel a lodged Bill failed, usually locked on a specific terminal User ID or PIN is incorrect An invalid confirmation response has been received or the confirmation message to be sent was not saved Attempt to lodge a Bill into I-Link that already exists The request report failed to generate or print Error in Network Invalid Record A Login command has been received, but a user is already logged in The terminal needs to be logged in
Document name PAYware Ocius Sentinel Integration Guide Date 1st October 2012 Page number 127 Contact VeriFone
Public
Version V1.15
0076 0077
Card is online only Cancel Failed - In Payment on xxx.xxx.xxx.xxx Login failed Confirmation Status Unknown
Check network or use another card Leave for configured amount of time before retrying cancel routine. Check login details and try again
0078 0079
0080 0081 0082 0083 0084
Bill Reference Already Exists Print Report Failed Network Error Invalid Record PED User already logged in
Clear the original Bill, or re-send this one using an alternative reference. Check printer settings, network connection and try again. Check network. The record received is invalid. Log the terminal off first, or simply pass a transaction. Send a login command to the terminal, or manually login using the on-screen prompts, then re-send the transaction. The transactions will still be stored on the terminal. Re-try, and if still having problems contact The Merchant Helpdesk.
0085
PED User not logged in
0086
Submission of offline transactions failed
The submission of the offline stored transactions have failed.
0087 0088 0089 0090 0091 0092 0093 0094 0095 0096 0097
Problem in network Voice Referral Timeout Invalid Account ID Service Not Allowed Card Not Accepted Unknown Card Not In IIN Range Application Blocked Card Blocked Card Error Authorisation Error
There has been a problem in the network. The voice referral transaction has taken too long. Invalid Account ID Service code not supported Card type not accepted Unknown card type Unknown card type The terminal cannot accept this card type The card has been blocked. There is a problem with the Card The authorisation process has been interrupted or is not responding. When using transaction processing, if no POS Routing has been configured for the IP Address or File Name where the transaction originates from, ILink does not know where to send the transaction. It therefore rejects it with this message. When a transaction has been cancelled by the user, the system or an ICC card, this error message will be sent. ICC Card does not allow Pin Bypass. The Terminal Country Code passed is invalid Check account permissions in WebCom. The Currency Code passed is
Re-try or cancel.
0098
Unknown Client Unknown Transaction Source Unknown Message
Use another card, or cancel the transaction Use another card, or cancel the transaction Use another card, or cancel the transaction Use another card, or cancel the transaction Use another card, or cancel the transaction Use another card, or cancel the transaction. Re-try or use another card. Check ILink & WinTI are running or when using ICP, contact VeriFone Merchant Helpdesk. Configure POS routing for that Point Of Sale.
0099
Transaction/Bill Cancelled
0100 0101
Pin Bypass Failed Invalid Terminal Country Code'
Use another card. Please check the ISO Country Codes table and make sure the code being passed is correct. Please contact VeriFone Support Please check the ISO Currency Codes
0102 0103
User has no permissions on specified account Invalid Currency Code'
Author ND
Phone 08444 828 200 invalid. 0104 0105 0106 0107 Invalid EMV Terminal Type' Unknown Message Type General Enqueue Error Transaction Confirmation Error The EMV Terminal Type passed is invalid The message type received by server side is not recognised General VeriFone Enqueueing Error The transaction confirmation has errored. The Payer Auth has encountered an error. The Ukash transaction has encountered an error. An error has occurred in the data encryption. The auxillary data record failed to build correctly The attempt to reject the transaction has errored The terminal\PTID is not recognised The download type is invalid The attempt to register the terminal has failed The terminal has been marked as deactivated. Acquirer has been blocked in the database as acquirer is not processing any authorisations (comms down) This is when the terminal is in offline mode at the start of a transaction, and cannot connect to the hosted server to allow MVoucher Error response when Comms failure between server application and XLS Host experienced. The Token Server has encountered an error The token provided does not allow purchase transactions The token provided does not allow refund transactions The token provided does not allow cashback transactions The token provided has passed its expiry date The token provided is invalid The Token Registration has no transaction permissions The token expiration date provided is invalid The processing database that is passed in the client header is either missing or invalid.
Public
Version V1.15
table and make sure the code being passed is correct. Please check the EMV Terminal Type that is being passed is valid. Please contact VeriFone Support Please contact VeriFone Support Please retry the confirmation and if continues to fail please contact VeriFone Support Please check the error message response and contact VeriFone support. Please check the error message response and Contact VeriFone Support. Please contact VeriFone Support Please contact VeriFone Support Please retry the rejection and if continues to fail please contact VeriFone support Please contact VeriFone Support Please contact VeriFone Support Please retry the registration if it continues to fail, please contact VeriFone Support Please contact VeriFone Support Please contact VeriFone Support
0108
Payer Auth Error
0109
Ukash Auth Error
0110 0111 0112
Encryption Failure Unable to build Auxillary Data Record Transaction rejection error
0113 0114 0115
Unknown Terminal Invalid Download Type Terminal Registration Failed
0116 0117
Terminal has been deactivated Comms down
0118
M-Voucher Service Unavailable
Please contact VeriFone Support
0119
Barclays Bonus Service Unavailable Token Server Error Purchase transaction type not allowed on token Refund transaction type not allowed on token Cashback transaction type not allowed on token Token expired Invalid TokenID Token has no Txn Type Permissions Invalid Token expiration date ProcessingDB Missing or Invalid
Please contact VeriFone Support
0120 0121 0122 0123 0124 0125 0126 0127 0128
Please contact VeriFone Support Please supply another token that allows purchase transactions Please supply another token that allows refund transactions Please supply another token that allows cashback transactions Please register a new token Please supply another token or contact VeriFone Support Please resubmit the token request with transaction permissions enabled Please resubmit the token request with a valid token expiration date Please check that the message you are sending has the processing database set in the client header and that it is valid (as per the transaction\payer auth request) Please check the Original Transaction ID and try again. Please check the configuration and download to the terminal. If the problem continues please contact
0129 0130
Invalid Original Barclays Gift Transaction ID Invalid Barclays Gift Configuration
The Original Gift Transaction ID provided is invalid Your Barclays Gift Configuration is invalid
Author ND
Phone 08444 828 200
Public
Version V1.15
0131 0132
Barclays Gift Service Unavailable Merchant Reference Required
0133
Account On File Not Allowed
The Barclays Gift Service is temporarily unavailable Your current configuration requires a Merchant Reference to be passed. Terminal is operating in offline mode Account does not allow Account On file CNP transactions EFT transaction capture method does not support registration of details for Account On File processing The card scheme doesn't allow processing of keyed card numbers A timeout has occurred whilst waiting for the card and Transactions has been cancelled The card presented does not support cash advance and needs to be represented as a purchase txn. Check Gratuity Value The application has timed out waiting for a Barclays Gift response The scheduled payment registration has failed. The PAYware Ocius migration failed on the database because the migration has not been setup / enabled Terminal has timeout after 30 seconds from no response from user The software or configuration download on the Vx810 RS solution has failed to complete its download successfully. The PayPoint configuration that you have setup is invalid. There are no PayPoint accounts available. The PayPoint service is currently unavailable A PayPoint download is required PayPoint account file extraction has failed. The PayPoint transaction type provide is not allowed The PayPoint TopUp type provided is invalid The PayPoint Service Provider provided is invalid The PayPoint Scheme provided is invalid The PayPoint Scheme Option provided is invalid The PayPoint Amount provided is invalid The PinPad is currently unavailable
support. Please contact VeriFone Support Please re-submit the transaction with the Merchant Reference populated. Please check that the terminal is online Please check the configuration of the account Check the transaction details that you have passed.
0134 0135
Card not allowed to be keyed Timeout Waiting for Card
Use another card, or cancel the transaction Reprocess Transaction.
0137
Present Cash Advance Transaction As Purchase
Reprocess Transaction as a purchase
0138 0139
Gratuity Value Incorrect Transaction Timeout
0140
Schedule Payment registration failed. Ocius migration failed
0141
Check Gratuity Value Please check whether the gift request has gone through and if necessary please try again. Please attempt to re-register the scheduled payment or contact VeriFone Support Contact VeriFone to arrange for migration
0142
S Record Timeout
Reprocess record if required
0143
Download Failed
Please retry the download if it continues to fail please contact VeriFone Support Please contact VeriFone Support Please contact VeriFone Support Please retry the payment or contact VeriFone support Please perform a configuration file update to your terminal Please retry the download if it continues to fail please contact VeriFone Support Please check the Transaction Type supplied and correct Please check the TopUp Type supplied and correct Please check the Service Provider supplied and correct Please check the Scheme supplied and correct Please check the Scheme Option supplied and correct Please check the Amount supplied and correct Please check the PinPad is available for use, please contact VeriFone Support if the problem persists. Please contact VeriFone Support
0150 0151 0152 0153 0154
Invalid PayPoint Configuration No PayPoint Accounts PayPoint Service Unavailable PayPoint Download Required PayPoint Account Extraction Failed PayPoint Transaction Type Not Allowed Invalid PayPoint TopUp Type Invalid PayPoint Service Provider Invalid PayPoint Scheme Invalid PayPoint Scheme Option Invalid PayPoint Amount No PinPad Available
0155 0156 0157 0158 0159 0160 0161
0189
Invalid refund password
An invalid refund password has
Author ND
Phone 08444 828 200 been supplied during the transaction, and was rejected by the database Start date or issue data supplied is incorrect or missing Generic Capture Error The information supplied in the post is incorrect The source URL is unrecognised A TokenID and PAN were received for the same transaction Communication Error The error code returned could not be extracted PayPage has failed to retrieve your System Configuration The data that has been supplied is suspicious PayPage has failed to retrieve your session data PayPage has failed to create a new session The sessionID provided by the front end is incorrect. The PIN provided by the front end is incorrect. The session that you are trying to use has already finished. An error has occurred trying to decrypt\extract the Payer Auth data The session that you are trying to use has expired.
Public
Version V1.15
0999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
Token Server Error Generic Error Merchant Supplied Bad Data Bad Source URL Attempting to use a TokenID and a PAN at the same time Curl Error Couldn't Extract Error Code from Response Failed to Retrieve System Config Unusual Data Supplied (Possible Attack) Failed to Retrieve Session Data Failed to Create New Session Bad SessionID received from end user Bad PIN received from end user Session Finished Failed to extract PA Data Session Expired
Please check you are passing the appropriate required fields Please contact VeriFone Support Please check the data that you are sending and retry. Please contact VeriFone Support Please check the data that is being passed Please contact VeriFone Support Please contact VeriFone Support Please contact VeriFone Support Please check the data that you are sending and contact VeriFone support Please retry the payment or contact VeriFone support Please retry the payment or contact VeriFone support Please check the data that you are sending and retry. Please check the data that you are sending and retry. Please retry the payment or contact VeriFone support Please retry the payment or contact VeriFone support Please retry the payment or contact VeriFone support
Author ND
Phone 08444 828 200
Public
Version V1.15
PAYware Ocius Sentinel FAQs

Why do I get an EFT is not allowed integration response? Receiving a -21 response to an integrated transaction request with an authorisation message of EFT Not Allowed indicates that when the transaction was started that the PED was deemed not to be available.
Possible Causes PED is disconnected Description If the PED is not physically connected to the PC that is running PAYware Ocius Sentinel, it will not be able to communicate to the PED and as such not be able to perform EFT transactions If the PED is not powered up, the PED cannot perform any processing If the PED has been power cycled too many times between pairing requests, the PED will require online PED verification. If PAYware Ocius Sentinel is logged in, this will require the current user to logout to allow for the verification to be performed In order for a PED to remain in an available state, the PED must respond to the polling messages within a given period of time. If the PC is under load, PAYware Ocius Sentinel may not receive these messages in time and so fall into a PED not connected state Steps To Resolve Ensure that the PED is correctly connected to the PC using the supplied RS232 / USB cable Do not use RS232 to USB serial converters Ensure that the supplied power supply is correctly connected to the RS232 cable Logout of PAYware Ocius Sentinel Re-Login to PAYware Ocius Sentinel Enter PED Security PIN if prompted
PED is not powered up
Online PED verification required
Low System Resources
Invalid PED Settings
COM Port In Use
User Opted To Continue Without PED
PED is invalid
In order to successfully communicate with the PED, PAYware Ocius Sentinel must be correctly configured to communicate on the correct settings If another application is using the COM port, PAYware Ocius Sentinel will not be able to access it, and will therefore be unable to communicate to the PED During the PAYware Ocius Sentinel start-up process, if the PED is deemed as not connected, PAYware Ocius Sentinel will prompt for the user to connect the PED. If the user chooses to continue without the PED, the PED will not be available for use PAYware Ocius Sentinel can only use
Ensure that the PC has enough RAM Minimum requirements for Windows is not enough. Every application that you run requires additional resources on top of the Windows defined minimum value Ensure that the PC has enough free disk space Windows makes use of swap files to boost the amount of RAM available. Limiting this, limits the total amount of RAM (physical + virtual) available Ensure that the PC is not running at near 100% CPU usage for long periods of time. If the machine / a process is using near 100% CPU usage, applications could be suffering from the inability to perform any processing Ensure that PAYware Ocius Sentinel is set to use the correct PED Type Ensure that the COM Port settings are correct Ensure that no other applications are using the specified COM port
Ensure that the PED is correctly connected and configured Restart PAYware Ocius Sentinel Do not opt to continue without the PED
Ensure that the PED is valid for the
Author ND
Phone 08444 828 200
Public
Version V1.15
Faulty PED
PEDs that are allowed by the merchants system. Connecting any other PED will result in PAYware Ocius Sentinel either requiring Online Validation or not being allowed If the PED is faulty or not working correctly, unexpected results may be experienced
given merchant system
Try an alternative PED that is allowed for that merchant system
Why do I get an integration service not allowed? Receiving a -31 response to an integration record with a message indicating Service Not Allowed indicates that when the specified functionality to be performed was requested, PAYware Ocius Sentinel was not in a position whereby it could process the request.
Possible Causes PAYware Ocius Sentinel Is Not Idle Description The majority of integrated commands can only be processed when PAYware Ocius Sentinel is on the idle screen. Integration commands include: Transaction PayPoint Transaction GR TFS Transaction Barclays Gift Transaction M-Voucher Transaction Park Retail Gift Transaction Logout Offline Submission Report Update App Stay Offline Givex Transaction PAYware Ocius Sentinel only supports processing a single integrated request at a time. If another client connects to PAYware Ocius Sentinel and sends a request, PAYware Ocius Sentinel will reject the request If sending Continue Transaction command, and the action does not fall into one of the few exceptions, PAYware Ocius Sentinel expects a transaction to be in progress. If there is no transaction in progress, the request will be rejected. If PAYware Ocius Sentinel is not in a position to be able to log in (on the login screen), PAYware Ocius Sentinel cannot process the login request. Steps To Resolve Ensure that the integration command is only sent when PAYware Ocius Sentinel is idle Use the PAYware Ocius Sentinel log file to help identify the issue
Already Processing A Request For Another Client
Ensure that only one client is connected and sending messages to PAYware Ocius Sentinel at a given time
PAYware Ocius Sentinel Is Not Processing A Transaction
Ensure that the correct Continue Transaction command is being sent and at the right time
PAYware Ocius Sentinel Is Not Able To Accept Login Request
Ensure that the login request is being sent at the correct time.
Author ND
Phone 08444 828 200
Public
Version V1.15
System.MissingMethodException in the log file Normally this indicates that the required signature of an external resource does not match that expected by PAYware Ocius Sentinel. Log File Example: OCIUS(StartPinpadInitialisation)System.MissingMethodException: Method not found: 'Boolean System.Threading.WaitHandle.WaitOne(Int32)'. at VeriFone.VeriFonePED.PinpadEMV.PingProcessing() at VeriFone.VeriFonePED.PinpadEMV.Ping() at OciusPED.OCIUS.InitialisePinpad(Boolean Reconnecting) at OciusPED.OCIUS.StartPinpadInitialisationProcessing()
Possible Causes .NET Framework is not up-to-date Description PAYware Ocius Sentinel is compiled against specific versions of the .NET framework. As and when patches released by Microsoft are applied, these patches may update the assemblies used within the .NET framework for functionality that PAYware Ocius Sentinel depends on. If these assemblies are not compatible with those required, PAYware Ocius Sentinel will not be able to use them. Steps To Resolve Ensure that all available updates for Windows are applied Ensure that the correct version of .NET is installed Ensure that all released updates to the .NET framework have been installed
What version of .NET is required? Unless PayPoint is enabled on the merchant system, PAYware Ocius Sentinel requires .NET 2.0 SP2. If PayPoint is enabled, PAYware Ocius Sentinel requires .NET 3.5 SP1. Please note, Windows and the .NET framework should be kept fully patched in line with Microsofts patch and service releases issued via Windows Update. No System ID available What causes No System ID available - Either PAYware Ocius PED is activated, but the System Config does not exist or contain the System ID, or activation is required, but the License Key does not exist or contain the System ID? In order to use PAYware Ocius Sentinel, it needs to be successfully activated in order to obtain its PTID and system details. All these details are required to perform core processing and therefore are validated during the login process. Without having the system ID available, the login process cannot be performed, and as such it obtains the System ID from the System Config file. If this file does not exist or the value is invalid then if activation is being performed (i.e. this is the first run of PAYware Ocius Sentinel), the System ID will be obtained from the supplied license key. If activation is not being performed, the license key would not have been loaded and as such the configuration is invalid. The requirement to perform activation is governed by whether PAYware Ocius Sentinel has a PTID available for use.
Author ND
Phone 08444 828 200
Public
Version V1.15
To resolve this issue, delete the PTID details stored in the machines registry and Sentinels generated configuration files (exml files excluding the CK files), so that PAYware Ocius Sentinel is forced to perform the activation process. Why did the hosted login process fail? In order to successfully complete the hosted login process, PAYware Ocius Sentinel must provide sufficient information to validate the installation and the users credentials.
Possible Causes XML missing or wrong format Description This indicates that the login request message does not match the expected format and as such cannot be processed This indicates that System ID is invalid Steps To Resolve Contact Merchant Helpdesk
Invalid Merchant Details
Login Failed
The supplied user details are invalid or terminal details are incorrect or any other unexpected error
Invalid License
The license details supplied are invalid
License Mismatch
Maximum License Install Exceeded Terminal Registration Failed Unknown Terminal
The supplied terminal details are invalid for the re-installation of PAYware Ocius Sentinel under the identified existing installation slot There are no more free installation slots available The hosted server failed to successfully activate the installation slot or the terminal details The terminal details supplied are invalid
Ensure that the merchant system has been configured Check that the configuration details that being used are correct Ensure that if activating PAYware Ocius Sentinel that the correct license key file is being used Contact Merchant Helpdesk if any of the details are incorrect Check that the user ID and password details are correct Check that the merchant details are correct Check that the terminal details are correct including the MAC list Contact Merchant Help Desk if any of the details are incorrect Check that the license key file is the correct file Check that the merchant details are correct Contact Merchant Helpdesk if any of the details are incorrect Check that the license key details are correct Check the installation slot details are valid Free up slots that are no longer in use Order more installation slots from the account manager Try the activation process again Contact Merchant Helpdesk Check the terminal details being supplied are correct Contact Merchant Help Desk if any of the details are incorrect Contact Merchant Help Desk Try the login process again Contact Merchant Help Desk
Terminal Has Been Deactivated General Enqueue Error
The terminal has been deactivated Failed to initialise the configuration / software download preparation process
Author ND
Phone 08444 828 200
Public
Version V1.15
How do I allow PAYware Ocius Sentinel to be installed on more machines? PAYware Ocius Sentinel is restricted based upon the number of installation slots generated as part of the order process. If you need more installation slots, it will be necessary to follow the defined order process through Halo. How do I move an PAYware Ocius Sentinel license to a new machine? Contact Merchant Helpdesk to release the installation slot. To do this, it is necessary to know the merchant system details and the PTID of the PAYware Ocius Sentinel install to be moved. Once released, it will be possible to perform the activation process on the new machine. When does the offline voice referral floor limit take into effect? The offline voice referral floor limit is only used when a transaction requires a voice referral to be performed due to a comms down scenario. Voice referrals due to instructions received from the acquirer will still require the voice referral process to be followed. Why is the offline voice referral floor limit process different? PAYware Ocius Sentinels voice referral floor limit process differs from that deployed with PAYware Ocius for PC. This is because PAYware Ocius Sentinels transaction process is implemented to standardise the transaction process in line with EMV, acquirer and card scheme rules. EMV rules dictate that in the event of a communications failure, ICC transactions should be completed as per standard EMV rules, whereby the transaction is completed informing the ICC that the transaction is subject to Comms Down.

PAYware Ocius Sentinel - Integration Guide V1.15 - October 2012

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PAYware Ocius Sentinel - Integration Guide V1.15 - October 2012

Uploaded by

Copyright:

Available Formats

Integration Guide

Author: ND Circulation: Public Date: 01/10/2012

Phone 08444 828 200

Phone 08444 828 200

1.4.1. Removed Features.................................................................................................. 11 1.5. PCI DSS Compliance ............................................................................................... 12

4.6.1. Text File .................................................................................................................. 23 4.6.2. XML File .................................................................................................................. 24

Phone 08444 828 200

Phone 08444 828 200

Phone 08444 828 200

Example EFT Scenarios ..........................................................................................111 SVS Offline Functionality .........................................................................................113

Phone 08444 828 200

1.1. Sentinel Software

Phone 08444 828 200

1.2. Supported PEDs

Phone 08444 828 200

Phone 08444 828 200

1.3. Operation Modes

Phone 08444 828 200

1.4. Backward Compatibility

Phone 08444 828 200

1.5. PCI DSS Compliance

Phone 08444 828 200

2.1. EFT Merchant Account

2.1. Merchant Stores

2.2. Testing Procedures

Phone 08444 828 200

3. EFT Transaction Types

3.1. Customer Present

3.1. Customer Not Present

Phone 08444 828 200

Phone 08444 828 200

Phone 08444 828 200

Phone 08444 828 200

4.1. Integration Process

4.2. Testing Values

Phone 08444 828 200

4.3. Integration Methods

Phone 08444 828 200

4.4. Integration Version

Phone 08444 828 200

4.5. Ocius.ini File

/DISABLEFUNCTION /DISABLEPEDPOLLING /ENABLEVISIBLELOGOUT /EXTENDLOG

Optional Optional Optional Optional

Phone 08444 828 200

An example of an Ocius.ini file:

Phone 08444 828 200

4.6. Receipt Printing

Phone 08444 828 200

Required Mandatory Mandatory Mandatory Mandatory (Or <ExpiryDate>) Mandatory Mandatory

Mandatory Mandatory Mandatory

Phone 08444 828 200

Mandatory (Or <AppExp>)

Mandatory Mandatory Mandatory

Mandatory Mandatory Mandatory Mandatory

Phone 08444 828 200

Phone 08444 828 200

<Amount> <Cashback> <Total>

<Amount> <Cashback> <Total>

Phone 08444 828 200

Chip & PIN:

Phone 08444 828 200

<PTID> <MID> <TID> <TxnDateTime> <EFTSN> <Reference> <AID> <AppEff> <AppSeq>