background image

 

Universal Transaction Gateway 

Using Legacy External Devices 

 

© 2019 Shift4 Payments, LLC. All rights reserved.   

Version 1.4 

External Use NDA 

 

Page 63 of 64 

Appendix B – Device Maintenance 

The UTG Stand Alone contains a Device Maintenance screen that provides a number of functions for 

merchants using external devices, such as PIN pads. 

 

To get to the Device Maintenance screen, complete the following steps: 
4.  In UTG Stand Alone, right click anywhere in the main Stand Alone page. 
5.  Select Device Maintenance. 

 

 

The Device Maintenance screen displays any devices that have been configured in UTG and a number of 

buttons. A description for the use of each button is provided in the table below. 

 

Button Name 

Description 

Select All 

Selects all displayed devices. 

De-select All 

De-selects all displayed devices. 

Key Exchange 

Used to resync an Ingenico iPP320 (CAN) device. See the 

iPP320 

Interac Debit Key Exchange

 section for more information. 

Check Update(s) 

Checks the version of selected devices against the version in 

Lighthouse Transaction Manager and downloads an update if 

Summary of Contents for UTG Ingenico 3070

Page 1: ...Join us for treats Thursday Month Day at 3 00 p m in the kitchen Using Legacy External Devices Copyright 2019 Shift4 Payments LLC All rights reserved UTG ...

Page 2: ...in a retrieval system or transmitted in any form or by any means without prior written permission of Shift4 Payments The contents of this publication are the property of Shift4 Payments Shift4 Payments reserves the right to revise this document and to periodically make changes to the content thereof without any obligation or notification to any organization of such revisions or changes unless requ...

Page 3: ...devices are no longer supported on UTG versions 2288 and higher Ingenico 3070 Ingenico i6550 Ingenico i6780 Verifone PINpad 1000 Verifone PINpad 1000SE Verifone MX 850 Verifone MX 870 Using Legacy External Devices with UTG This document is intended for vendors and developers using external devices in their POS PMS systems The Universal Transaction Gateway UTG supports a variety of external devices...

Page 4: ...l Use NDA Page 4 of 64 Configuring Ingenico Devices Configuring Ingenico 3070 Requirement Verify that UPOS Interface Application displays on the Ingenico 3070 screen on boot up If the version information is not displayed contact the Shift4 Customer Support team at 702 597 2480 option 2 Ingenico 3070 U S Ingenico 3070 Canada ...

Page 5: ...etup Port and select the correct port number 6 Select the baud rate Shift4 recommends a baud rate of 19200 7 When finished press the Cancel button until the device restarts Other Settings Verify that the following settings have been applied on the UTG Stub IP to Serial window Data Bits Byte Size 8 Parity None Stop Bits 1 Flow Control None Requirement You must load the Shift4 template forms on the ...

Page 6: ...utines flash briefly on the screen 10 On the SSA System menu select Configuration Ticket 11 On the Configuration Ticket menu select App Ticket 12 On the Application Config screen verify the following applications are loaded on the device in the Application List section CA0300_IBMEF 3 US0901_UIA__ 9 13 To return to the SSA System menu press the Cancel button twice Verifying Device Settings Device s...

Page 7: ...Bits Set 8 Stop Bits Set 1 Parity Set None LAN Address Verify 101 Retry Count Verify 3 Response TMO Verify 1000 Poll TMO Verify 3000 Turnaround TMO Verify 300 17 Press the Cancel button until the Configuration menu returns Other Settings Verify that the following settings have been applied on the UTG Stub IP to Serial window Data Bits Byte Size 8 Parity None Stop Bits 1 Flow Control None Requireme...

Page 8: ...on information is not displayed contact the Shift4 Customer Support team at 702 597 2480 option 2 Booting the Device To boot the Ingenico i6780 complete the following steps 18 Simultaneously press and hold the 1 3 Cancel and Enter buttons and then release 19 To open the SSA System menu press and hold the Clear button During boot up the device beeps and startup routines flash briefly on the screen ...

Page 9: ...d Contact the Shift4 Customer Support team at 702 597 2480 option 2 for the default password 26 To open and set the Supervisor menu options enter the password and complete the following steps Select Sys Parameters Select Setup Port Select Port 1 Set or verify port settings as listed in the following table Ingenico 6780 Configuration Settings Setting Action Required Value Interface Type Set RS232 B...

Page 10: ...age 10 of 64 Other Settings Verify that the following settings have been applied on the UTG Stub IP to Serial window Data Bits Byte Size 8 Parity None Stop Bits 1 Flow Control None Requirement You must load the Shift4 template forms on the Ingenico i6780 device Refer to the sections regarding forms for Ingenico devices in this document ...

Page 11: ...on where totals sub totals or tip should print on the form you must customize and specify a Coordinates File by doing the following 1 Under the Devices tab select the PIN Pad and then click the Edit button 2 Click Browse The following message appears 3 Select the desired Coordinates File A default Coordinates File should have been downloaded with the Shift4 forms Each device will have its own coor...

Page 12: ...ield 4 is the Y coordinate you want this field displayed at For example the line 6 Total 75 50 means that for screen 6 display the Total field at X coordinate 75 and Y coordinate 50 If Field 1 is not a digit it will flag an error and all X Y coordinates will be restored to default values If you wish to use the default value for one of the X or Y coordinates you may leave that field blank in the li...

Page 13: ...iSC480 offer keypad multiple card reader signature capture and touch screen functionality The iSC250 can also be purchased as or converted to be used as a point to point encryption P2PE device and can connect to the UTG using TCP IP The Touch iSC250 350 480 and iPP320 U S 350 are capable of reading card swipes magnetic stripe and an optional contactless card reader All Telium devices support BIN m...

Page 14: ...ce on boot up Ingenico Telium Devices UIA Versions Supported and Known Issues Ingenico Firmware Supported P2PE Supported Description of Issue Telium UIA 1 5 No No Ingenico forms do not allow leading zeros in the Enter Exp Date and Enter Card Number prompts This prevents use of manual card entry Telium UIA 1 6 Yes No Ingenico forms do not allow leading zeros in the Enter Card Number prompt Telium U...

Page 15: ...skip all other manual card entry screens use the Enter button A card number entered on the MCE screen must be at least 12 digits Telium UIA 6 0 1 0149 Yes Yes Only tested on the Touch iSC480 A card number entered on the MCE screen must be at least 12 digits Telium UIA 8 0 12 Yes Yes Works with iSC devices only This version fixed an Apple Pay issue with MasterCard Telium UIA 9 0 4 Yes Yes No known ...

Page 16: ...0 350 480 Simultaneously press and hold the Clear and Minus buttons and then release During boot up the device beeps and startup routines flash briefly on the screen iPP320 U S 350 Simultaneously press and hold the Clear and Period buttons and then release During boot up the device beeps and startup routines flash briefly on the screen 29 To open the TSA System menu Touch iSC250 350 480 Press 2 6 ...

Page 17: ... following table Ingenico Telium Device Configuration Settings Setting Action Required Value Baud Rate Set 115200 Stop Bits Set 1 Bits per Byte Set 8 Parity Set None Flow Control Set None 34 Press the Cancel Clear button until the Configuration menu returns Other Settings If you are using a UTG Stub verify that the following settings have been applied on the UTG Stub IP to Serial window Data Bits ...

Page 18: ... with tip screen Loading Shift4 Template Forms on Ingenico Devices You must load Shift4 template forms on the following Ingenico devices in order to incorporate and display greeting input and error information associated with transactions Ingenico 3070 Ingenico i6550 Ingenico i6780 Requirement Before you can load the template forms the Ingenico OPOS driver and Ingenico Form Designer application mu...

Page 19: ...nico 3070 iSeries OPOS To configure the Ingenico iSeries OPOS complete the following steps 35 From the Start menu select Programs Ingenico OPOS for the Ingenico iSeries Ingenico iSeries Setup 36 In the Ingenico iSeries OPOS Configuration window on the General tab in the Device Connection section select the following required settings From the Device Connection Type list select Serial Port From the...

Page 20: ...Universal Transaction Gateway Using Legacy External Devices 2019 Shift4 Payments LLC All rights reserved Version 1 4 External Use NDA Page 20 of 64 37 Click OK ...

Page 21: ...Click the OPOS Ingenico 6XXX Setup application 40 In the Ingenico 6XXX OPOS Configuration window under Special Features of Ingenico 6XXX select a Device Model 41 Under Device Connection configure the following From the Device Connection Type list select Serial Port From the Comm Port list select a communications port for the Ingenico Form Designer to use to communicate with the Ingenico device Fro...

Page 22: ...o i6550 https myportal shift4 com downloads i6550forms zip Ingenico i6780 https myportal shift4 com downloads i6780forms zip Ingenico iPP320 U S https myportal shift4 com downloads iPP320forms zip Ingenico iPP350 https myportal shift4 com downloads iPP350forms zip Ingenico Touch iSC250 https myportal shift4 com downloads iSC250forms zip Ingenico iSC350 https myportal shift4 com downloads iSC350for...

Page 23: ...8 In the Form Type Configuration window specify the target device and application From the Device Name list select your Ingenico device From the Target App list select UPOS Apps UIA eN Cmd Click OK 49 In the Ingenico Form Designer open a template form Select File Open Navigate to the directory where you extracted the Shift4 template forms Select a template form file The file extension for Ingenico...

Page 24: ...rify that all device cables are secure Editing Shift4 Template Forms for Ingenico Devices Several of the UTG compatible devices include editable forms This allows merchants to add specific wording and logos on individual forms or in the background of every form Follow the instructions provided by the device manufacturer Portions of the Shift4 template forms can be edited with either the Ingenico F...

Page 25: ...ollowing table provides descriptions for the Shift4 forms or file names Shift4 Template Forms and Descriptions for Ingenico Devices Form Number Form Name Screen Image File Name DO NOT CHANGE Form Description i6550 i6780 Form 1 MainScreen Main Screen Z1 MAIN When the system is idle it rotates through the first four forms to prevent screen burnout Form 2 IdleScreen1 IDLE SCREEN 1 Z2 IDL_1 When the s...

Page 26: ...first four forms to prevent screen burnout Form 5 PleaseWait Please Wait Z5 PlsWt Customer is waiting for system to process Form 6 Used with customer tip entry FBAmount Z6 FBAmt Ticket amount Tip amount and Total amount will be shown Customer to accept the amount change the tip amount or cancel the transaction Form 7 Used without customer tip entry AmountOK Z7 AmtSc Total amount will be shown Cust...

Page 27: ...roved Form 13 Declined DECLINED Z13 Decl Transaction was declined Form 14 Referral Your transaction was not approved Please see cashier Z14 Refl Merchant required to call for voice authorization Form 15 NotProc Unable to process transaction Your card has not been charged Z15 NoPr Shift4 was unable to process the transaction The transaction did not go through and the customer s credit card was not ...

Page 28: ...o Form Designer Any text displayed in blue when viewing the form in the Ingenico Form Designer can be modified The Ingenico i6550 Text Box is shown To edit the Shift4 template forms in the Form Designer 52 In the Form Designer window open the ic file of the form to be edited 53 Double click the text to be edited 54 Complete the text edits 55 Click OK 56 Click Save ...

Page 29: ...raints listed in the following table Ingenico Device Form Constraints Devices B W Color Dimensions pixels i6550 X 322 x 240 i6780 X 320 x 234 3070 X 50 x 30 WARNING Do not add color to forms used on black and white devices Color forms will not run on black and white devices 59 Click Save Verifying Edited Forms After editing the forms complete the following steps 60 If you used graphics software op...

Page 30: ...Select Download then Local Download The PIN pad screen will display LLT 66 Select Start Programs TELIUM Tools LLT 4 4 this version number may vary depending on your download 67 Click LLT 4 4 68 To configure LLT to connect to the correct COM Port see the LLT User Guide pdf for instructions It should be located in the Telium Utilities folder 69 Select Terminal Connection 70 In the All directories pa...

Page 31: ...d with the Telium Form Builder WARNING Do not change the Attribute ID for any item or the UTG will not work properly See the table below for more information Common Controls What can be edited CCTT ctt CCTT ctt controls may be moved but the text and control size should not be changed Image image Image image controls may be changed deleted moved or resized as needed You may also add images and back...

Page 32: ...sion 1 4 External Use NDA Page 32 of 64 Common Controls What can be edited Signature sig Signature sig may not be changed moved or resized However the backgroundcolor inkcolor and pensize may be changed PINEntry pinentry PINEntry pinentry controls may be moved but not resized and the text must NOT be changed ...

Page 33: ...screen burnout IdleScreen2 IDLE SCREEN 2 z3IDL2 K3Z All When the system is idle it rotates through the first four forms to prevent screen burnout IdleScreen3 IDLE SCREEN 3 z4IDL3 K3Z All When the system is idle it rotates through the first four forms to prevent screen burnout PleaseWait Please Wait z5PLE1 K3Z All Customer is waiting for system to process FBAmount z6FBA4 K3Z All Ticket amount tip a...

Page 34: ...roved APPROVED z12Aprv K3Z All Transaction was approved Declined DECLINED z13Decl K3Z All Transaction was declined Referral Your transaction was not approved Please see cashier z14Refl K3Z All Merchant required to call for voice authorization NotProc Unable to process transaction Your card has not been charged z15NoPr K3Z All Shift4 was unable to process the transaction The transaction did not go ...

Page 35: ...l to bypass entry Enter CVV or CID from card z33ManCVV K3Z Prior to UIA v3 x Cardholder to enter CVV or CID from card Leave blank and press Enter to bypass entry Enter CVV or CID from card a33ManCVV K3Z UIA v3 x and above Cardholder to enter CVV or CID from card Leave blank and press Enter to bypass entry Enter Zip Code z34ManZip K3Z Prior to UIA v3 x Cardholder to enter Zip Code Leave blank and p...

Page 36: ...N TGZ PGZ OGZ Requirement UTG 2243 or higher is required to utilize the Form Loading feature UTG 2245 or higher is required to use the UIA Update feature UIA 3 3 is required for P2PE devices To push forms or UIA updates to all compatible devices complete the following steps Requirement Telium P2PE Requirement UIA updates are generic and do not take P2PE into account If a UIA update is pushed to a ...

Page 37: ...nico Touch iSC250 Ingenico Touch iSC350 Ingenico Touch iSC480 Ingenico iPP320 U S Ingenico iPP350 Ingenico Touch iSC250 P2PE Ingenico Touch iSC350 P2PE Ingenico Touch iSC480 P2PE iPP320 P2PE iPP350 P2PE Note There should only be one set of forms in the folder If you have a previous package of forms make a copy and store in another folder for future use ...

Page 38: ...e package or UIA update to the devices 83 Once the package of forms or UIA version update has been pushed to all compatible devices the UTG will reboot all compatible devices 84 For Forms Only When the reboot process is complete the UTG will verify all the forms have loaded The message Verifying Forms Please Wait will be displayed on all compatible devices If any forms are missing the UTG will dis...

Page 39: ...e PIN pad device forms 90 Select the CUSTPROMPT XML file and click Open 91 Click OK to close the Options window To edit the Shift4 template forms in the Telium Form Builder complete the following steps 92 From the Telium Form Builder menu select File Open and select the form to edit 93 Double click the file to be edited 94 With the form loaded in the Telium Form Builder window click the field you ...

Page 40: ...E device it will not work once converted to RBA Converting a P2PE UIA device to RBA via Shift4 Package To convert a P2PE UIA device to run RBA using the Shift4 twb package file perform the following steps Requirement The UIA device must be running UIA 8 or higher in order to push twb files 1 Download the Shift4 RBA forms for the device you are planning to update 2 Modify the forms as needed to mat...

Page 41: ...ding functionality to push the RBA OGZ file to the device The OGZ file can be found in the Manual folder inside the device forms zip folder downloaded in step 1 as displayed below 12 After the RBA OGZ package has been pushed to the device and the device reboots shut down UTG 13 Reconfigure UTG TuneUp to utilize the RBA version of the Ingenico Telium device 14 Start UTG 15 Utilize UTG s automatic f...

Page 42: ...s as needed to match your company s branding 20 Create a TGZ forms package using Ingenico Telium Packaging Tool 21 Utilize UTG s automatic form loading functionality to push the TGZ forms package file to the device Converting a non P2PE UIA device to RBA You will need to send your device back to the key injection facility to load the P2PE key and the RBA application ...

Page 43: ...ps 98 Disconnect and then reconnect the power cord to reset the device 99 If TERMINAL ID displays 19 2 press the yellow CORR button to change the baud to 9600 100 Press the green OK button 101 Disconnect and then reconnect the power cord to reset the device again Note When configuring the UTG TuneUp for this device the Tip 1 option prompts the customer to enter a tip amount manually the Tip 2 opti...

Page 44: ... Clear button and blue Enter button The Verifone PINpad 1000se shown on the right also has 10 number buttons in addition to three blue function keys a red X cancel button a green arrow enter button and a yellow arrow clear button Verifone PINpad 1000 Verifone PINpad 1000se Resetting the Device To reset the Verifone PINpad 1000 or Verifone PINpad 1000se complete the following steps 102 Disconnect a...

Page 45: ...00 device If the Verifone PINpad 1000 is connected directly to the UTG set the baud rate to 9600 Other Settings Verify that the following settings have been applied on the UTG Stub IP to Serial window Data Bits Byte Size 7 Parity Even Stop Bits 1 Flow Control None Configuring Verifone SC 5000 Resetting the Device To verify the Verifone SC 5000 settings complete the following steps 110 Disconnect a...

Page 46: ... Parity 1 8 B No PARITY recommended setting 2 7 B Even PARITY 112 Press the F2 OK button Note When configuring the UTG TuneUp for this device both Tip 1 and Tip 2 options prompt the customer to enter a tip amount manually Other Settings Verify that the following settings have been applied on the UTG Stub IP to Serial window Data Bits Byte Size 8 Parity None Stop Bits 1 Flow Control None ...

Page 47: ... Verifone MX 870 and the Verifone MX 870 Contactless shown with optional field upgradeable module offer full touchpad functionality without a keypad Note When selecting the Verifone MX 850 or MX 870 device in the UTG TuneUp select MX 850N or MX 870N During installation and configuration the special keys on the Verifone MX 850 function as follows F3 next item F4 next tab Enter select highlighted it...

Page 48: ...mAgent Verifone XPI Supported Description of Issue 2 2 0g NA No No known issues 2 2 0k NA Deprecated No known issues 2 2 1s NA Deprecated No known issues 2 2 1t NA Deprecated No known issues 2 2 1w NA Deprecated No known issues 2 2 1o NA Deprecated No known issues 2 3 1q NA Yes Supported if xifm_addmodelprefix is not present or set to 0 2 3 2p NA Yes No known issues 2 3 3i NA TBD No known issues 3...

Page 49: ...s myportal shift4 com downloads MX915Forms zip https myportal shift4 com downloads MX925Forms zip 114 To transfer FormAgent to the device copy the files to a USB drive Note Connect the device using green connector RS 232 cable transfer the files to a USB flash drive and then to the device through the USB port on the RS 232 cable to ensure the fastest transfer rate FormAgent may be transferred dire...

Page 50: ...nu select the File Manager icon 118 To verify successful application load select the Run Application icon Downloading Verifone MX Tools To download Verifone MX Tools click https myportal shift4 com downloads VerifoneMXTools zip to download the zip file and extract the files to a temporary directory The files will include the following MX Downloader Verifone s tool used to push files to Verifone de...

Page 51: ... Type Set RS232 or USB REG cp Comm Port Set REG bd Baud Rate Set 8 REG prot Protocol Format Set 4 REG KSN Key Padding Fs Add 1 If using the Serial Port set the Comm Port according to the label on the Multi Port Connector If not using the Serial Port the Comm Port setting is irrelevant Requirement Entering 8 for the Baud Rate sets the rate of the physical device to 115200 You must also configure th...

Page 52: ...devices Download the zip file for your device s and extract the forms The supported file extensions that UTG will push for Verifone devices include the following TGZ TAR GZ Requirement UTG 2251 or higher is required to utilize the Form Loading feature To push forms or FormAgent updates to all compatible Verifone devices complete the following steps 124 Extract the Shift4 forms from the downloaded ...

Page 53: ...reboot all compatible devices 130 When the reboot process is complete the UTG will verify all the forms have loaded The message Verifying Forms Please Wait will be displayed on all compatible devices If any forms are missing the UTG will display a message on the device indicating which forms are missing The missing forms must be added to the TGZ file before the device can be used If all of the for...

Page 54: ...first four forms to prevent screen burnout idle1 IdleScreen1 IDLE SCREEN 1 idle1 When the system is idle it rotates through the first four forms to prevent screen burnout idle2 IdleScreen2 IDLE SCREEN 2 idle2 When the system is idle it rotates through the first four forms to prevent screen burnout idle3 IdleScreen3 IDLE SCREEN 3 idle3 When the system is idle it rotates through the first four forms...

Page 55: ...re then click Accept Click Clear to reset signature field Click Cancel to exit screen without signature scr12 Approved APPROVED scr12 The transaction was approved scr13 Declined DECLINED scr13 The transaction was declined scr14 Referral Your transaction was not approved Please see cashier scr14 The merchant is required to call for voice authorization scr15 NotProc Unable to process transaction You...

Page 56: ... CVV Security Code associated with the card for CVV2 verification SCR34 Note This screen will read ZIP Code on the MX 850 The MX 850 will have a button below the screen and not in the display where the cardholder may select Non US Postal Code For the MX 870 the text will read Enter Postal ZIP Code scr34 The customer is to enter the ZIP or Postal Code associated with the credit card account for AVS...

Page 57: ...rompts the user for date of birth when applying for a private label card SCR53 Annual Income prompt scr53 This prompts the user for their annual income when applying for a private label card SCR54 Terms and Conditions Signature prompt scr54 This prompts the user for their signature as agreement to the terms and conditions of the private label application SCR55 Terms and Conditions prompt scr55 Thi...

Page 58: ... important to consistently use the same Control ID for buttons of the same type of functionality Follow the table guidelines below for form button Control ID settings Enter Clear and Cancel button configurations Button Configuration Requirement Code Make all Enter buttons the same button Control ID 1 Make all Clear buttons the same button Control ID 3 Make all Cancel buttons the same button Contro...

Page 59: ...6 ManualCard Control ID 1 Enter Non U S Postal Control ID 7 Using Graphics Software Any text displayed in black when viewing the form in the Form Designer can be modified in any graphics editor To edit the Shift4 template forms in your graphics editor complete the following steps 132 In your graphics software open the bmp file of the form to be edited 133 Edit the form according to device constrai...

Page 60: ...he following steps 134 You will need to create a package of forms using the MX Form Manager refer to Verifone s instructions for how to use Form Manager This file should have a TGZ extension and the file name must be 20 characters or less 135 Copy the TGZ file to Shift4 UTG2 Update Forms DeviceType where DeviceType represents the type of Verifone device such as Verifone MX 850 136 Create a new tex...

Page 61: ...splayed on all compatible devices If any forms are missing the UTG will display a message on the device indicating which forms are missing The missing forms must be added before the device can be used If all of the forms are present the UTG will display the idle screens on the devices 141 The UTG will then delete the Update txt file Note There should only be one set of forms in the folder If you h...

Page 62: ...nico i6550 X X X X X X X Ingenico i6780 X X X X X X X X Verifone SC 550 X X X Verifone PINpad 1000 X X Verifone PINpad 1000SE X X Verifone SC 5000 X X X Verifone MX 850 X X X X X X X X X X Verifone MX 870 X X X X X X X X X X X MSR Magnetic Swipe Reader SigCap Signature Capture The process of electronically capturing the cardholder s signature MCE Manual Card Entry Allows a cardholder to enter card...

Page 63: ...ick anywhere in the main Stand Alone page 5 Select Device Maintenance The Device Maintenance screen displays any devices that have been configured in UTG and a number of buttons A description for the use of each button is provided in the table below Button Name Description Select All Selects all displayed devices De select All De selects all displayed devices Key Exchange Used to resync an Ingenic...

Page 64: ...ply Prompts Used to push the corrected MAC values to selected devices See the Ingenico iPP320 CAN MAC Values section for more information Verify Forms Verifies that no Shift4 forms are missing for selected devices Push Forms Can be used to manually push forms to all similar devices that are selected on the Device Maintenance screen See the UTG Automatic Form Loading and FormAgent XPI Update sectio...

Reviews: