Home

NOTE - Motorola Solutions

1. Field Description Length Value Token Field ID 2 CC FS Field Separator 1 FS 0x1C Token Field ID New Value 2 NV Data New contrast value 1 3 ASCII Numeric FS Field Separator 1 FS 0x1C Token Field ID Previous 2 PV Value Data Previous contrast value 1 3 ASCII Numeric Example contrast configuration response which contains information of the new contrast value set to 28 and previous value as 32 lt STX gt p lt FS gt CC lt FS gt NV28 lt FS gt PV32 lt ETX gt lt LRC gt CC Contrast Setup timeout Field Description Length Value Token Field ID 2 CC FS Field Separator 1 FS 0x1C Token Timeout 2 TO Example timeout response lt STX gt p lt FS gt CC lt FS gt TO lt ETX gt lt LRC gt CL Touch screen calibration Field Description Length Value Token Field ID 2 CL FS Field Separator 1 FS 0x1C Data Return code 1 ASCII chars T Success Calibration Passed F Failure Calibration Failed Example touch screen calibration response when operation is successful lt STX gt p lt FS gt CL lt FS gt T lt ETX gt lt LRC gt 80 FPE Interface Specification CL Touch screen calibration timeout Field Description Length Value Token Field ID 2 CL FS Field Separator 1 FS 0x1C Token Timeout 2 TO Example timeout response lt STX gt p
2. 86 Field tokens used in File download d message see ee ee ee AA ee AA ee ee 87 Field tokens used in File Download 5 87 jeu cru BEN 0070 0000 0000 87 C Request file s information isi rettet ccr teet a EE OE td iuda 87 Field tokens sent by FPE in response to File download d messages 87 Field tokens sent by FPE in response to File Download Requests descriptions 87 ie ER iter etn tide beste n RE 87 L Eile s infOrmatlOn zit itcr eei P a eeu EE cau 88 Customer activation ees reens eek ee Kaak GE RR RARR RARR RAGE nhanh hn RR ee ER anne RR ee RR aman 88 ABOUT THIS GUIDE Introduction This guide provides the events and methods initiated by the Symbol FPE Server This guide is intended for network administrators merchants operators technicians or those who oversee the configuration and daily maintenance of the terminals v NOTE Screens and windows pictured in this guide are samples and can differ from actual screens T IMPORTANT This guide includes information about the events and methods initiated by the FPE Server a Symbol OEM product from Hypercom Corporation Any references in this guide to Hypercom Corporation Hypercom logo Hypercom file names and file paths Hypercom software and terminals reflect hardware and software manufactured by Hypercom Corporation for
3. FS Field Separator 1 FS 0x1C Token Timeout 2 TO Example timeout response lt STX gt p FS TD FS TO ETX LRC CP ECR port configuration Configure Port Field Description Length Value Token Field ID 2 CP FS Field Separator 1 FS 0x1C Token Field ID Previous Port 2 PP Data Previous Port varies ASCII FS Field Separator 1 FS 0x1C Token Field ID New Port 2 NP Data New Port varies ASCII If New Port is TCP IP FS Field Separator 1 FS 0x1C Token Field ID IP Address 2 IP Data IP Address varies ASCII FS Field Separator 1 FS 0x1C Token Field ID Port No 2 PO Data Port No varies ASCII If New Port is Serial FS Field Separator 1 FS 0x1C Token Field ID Baud Rate 2 BR Data Baud Rate varies ASCII FS Field Separator 1 FS 0x1C Token Field ID Parity 2 PA Data Parity varies ASCII FS Field Separator 1 FS 0x1C Token Field ID Data Bits 2 DB Data Data Bits 1 ASCII Numeric Token Field ID Stop Bits 2 SB Data Stop Bits 1 ASCII Numeric Token Field ID Flow Control 2 FC Data Flow Control varies ASCII If New Port is USB then no further configuration required Example ECR port configuration responses when new port is Serial lt STX gt p lt FS gt C lt STX gt p lt FS gt C lt FS gt PO5112 lt lt STX gt p lt FS gt C
4. Request Tokens PD87xx PD4700 PD4750 T Initiate Code Download l Yes Yes Yes J Poll Customer Data J All Yes Yes Yes K Disable Enable Keyboard No Yes Yes Toggle K L File Delete L Yes Yes Yes M Update Display M C1 C30 Yes Yes Yes M Update Display DL Yes Yes Yes N Clear All Display Lines N Yes Yes Yes P File Load P Yes Yes Yes p Setup Parameters p All Yes Yes Yes Q Form Information Q All Yes Yes Yes S Terminal Status S No No No T Terminal Type T Yes Yes Yes V Form Request C1 C30 Yes Yes Yes V Form Request P1 P7 Yes Yes Yes V Form Request AC DL ET FN Yes Yes Yes Mi SP SM ST no signature SU TK WK capture V Form Request D Yes Yes Yes V Form Request BO B9 DT EF Yes Yes Yes EO E9 SB SS no signature TS capture V Form Request HP No No No O Hardware Reset Yes Yes Yes N Set NMS IPConfig All No No No Keyboard Lock No Yes Yes Terminal Type Codes PD8700 7 0x37 PD4700 N 0x41 PD4750 B 0x42 Key Codes and Tender Type Codes FuncKey1 Credit N 0x41 FuncKey2 Debit B 0x42 FuncKey3 EBT 0 43
5. 10 FPE Interface Specification Response Field Description Length 1 Value Message Type Message ID 1 B Parameters Field tokens varies ASCII Field tokens used in Port command B messages v NOTE Field tokens are in the format FS Field Token Data Token Description PN Port number AC Action BR Baud rate CP Configuration parameters DT Data to send to or received from the port Port command field token descriptions PN Port number Field Description Length 1 Value Token Field ID 2 PN Parameter Port number 1 1 RS232 1 2 RS232 2 3 RS232 3 4 Pin Example lt FS gt PN2 AC Action Field Description Length Value Token Field ID 2 AC Parameter Action to take 1 O pen C lose W rite Example lt FS gt ACO BR Baud rate Field Description Length 1 Value Token Field ID 2 BR Parameter Baud rate 1 1 300 2 1200 8 2400 4 4800 5 9600 e 19200 Example lt FS gt BR6 v NOTE Must be sent when Action is Open CP Configuration parameters Field Description Length Value Token Field ID 2 CP 11 Field Description Length Value Parameter Port configuration 1 1 7N1 7 data No parity 1 stop 2 701 7 data Odd parity 1 stop 9 7E1 7 data Even parity 1 stop 4 7N2 7 data No p
6. ETX gt lt LRC gt CP ECR port configuration timeout P lt FS gt PPTCP IP lt FS gt NPSerial lt FS gt BR19200 lt FS gt PANone lt FS gt DB8 lt FS gt SB1 lt FS gt FCNone lt ETX lt LRC gt when new port is TCP IP P lt FS gt PPSerial lt FS gt NPTICP IP lt FS gt IP172 16 0 12 ETX gt lt LRC gt when new port is USB P lt FS gt PPSerial lt FS gt NPUSB lt Field Description Length Value Token Field ID 2 CP FS Field Separator 1 FS 0x1C 81 82 FPE Interface Specification Token Timeout 2 TO Example timeout response lt STX gt p lt FS gt CP lt FS gt TO lt ETX gt lt LRC gt Setup Parameters examples Request lt STX gt p lt FS gt PWMULTILANE lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Request lt STX gt p lt FS gt PUY lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Request lt STX gt p lt FS gt QP lt ETX gt lt LRC gt Response lt STX gt p lt FS gt PWMULTILANE lt ETX gt lt LRC gt Request lt STX gt p lt FS gt QU lt ETX gt lt LRC gt Response lt STX gt p lt FS gt PUY lt ETX gt lt LRC gt Request lt STX gt p lt FS gt QHTMS lt ETX gt lt LRC gt Response lt STX gt p lt FS gt PHTMSY 192 168 0 1 5112 lt ETX gt lt LRC gt Beeper control b This message causes the terminal to sound beep with specified duration ECR Request b Terminal v NOTE This token is
7. Field Description Length Value Token Field ID 2 TT Parameter Tender type code see Key Codes 1 ASCII table v NOTE The tender type is needed so FPE knows the transaction flow to follow after the Form that it received Example lt FS gt TTA DF Delete Fields Field Description Length 1 Value Token Field ID 2 DF Parameter Clear pole display fields 1 A for Delete all Fields or P for Delete partial v NOTE If DF has a P parameter Sub field tokens are in the format lt FS gt lt Field Token gt lt FS gt Token Description T Track data PD PIN data Token Description TT Tender type FS Current FPE customer activated state CB Cash back amount F Frequent shopper track data v NOTE This token is needed to know if FPE needs to clear the customer data previously obtained Example lt FS gt DFP lt FS gt TT lt FS gt F lt FS gt T lt FS gt CB lt FS gt Return to Idle example Request lt STX gt A lt FS gt FNMYIDLEFRM lt FS gt CPY lt FS gt TTA lt FS gt DFA lt ETX gt lt LRC gt lt STX gt A lt FS gt FNMYIDLEFRM lt FS gt CPY lt FS gt TTA lt FS gt DFP lt FS gt TT lt FSsF lt FS gt T lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Response None Port command B Used to configure a pass through port and send or receive data from that port It allows ECR to communicate with
8. 10 Transition to CBKeyboard Cancel Transition to IDLE State Event Action CBKeyboard Init Display the cash back form for the current tender Amount entered If frequent shopper is on for this tender transition to FreqShopper Else transition to Wait Cancel Transition to IDLE State Event Action CBClerk Init Display the cash back form for the current tender Timer expires If frequent shopper is on for this tender transition to FreqShopper Else transition to Wait Cancel Transition to IDLE State Event Action FregShopper Init Display FREQSHPFRM Card swipe Transition to Wait Cancel Transition to Wait Bad card swipe Display BADSWIPE form and stay in this state State Event Action GetPIN Init Display the PIN form for the current tender PIN entered If cash back Yes No prompting is on for this tender transition to CBYesNo Else if cash back is on for this tender transition to the state to get the configured cash back type CBClerk CBKeyboard or CBButtons Else if frequent shopper is on for this tender transition to FreqShopper Else transition to Wait Cancel Transition to IDLE State Event Action Wait Init Display WAITFRM Cancel Transition to IDLE 91 Symbol Technologies Inc One Symbol Plaza Holtsville New York 11742 1300 http www symbol com 72E 91526 01 Revision A
9. 4 EBTFoodStamps D 0x44 FuncKey5 EBTCashBenefits E 0x45 FuncKey6 Check F 0x46 FuncKey7 User1 G 0x47 FuncKey8 User2 0x48 FuncKey9 User3 T 0x49 FuncKey10 User4 4 Screen Menu One K 0x4B Screen Menu Two 41 0 4 Screen Menu Three M Ox4D Screen Menu Four N 0x4E Screen Menu Five O Ox4F Screen Menu Six P 0x50 Cancel Q 0x51 4 FPE Interface Specification Customer activated states Idle A 0x41 MSR B 0x42 Tender 0 43 PIN D 0x44 Cash Back E 0x45 Purchase Balance F 0x46 Cash Back Yes No G 0x47 Wait H 0x48 Select EBT m 0x49 Not In Customer 4 Activated Mode Freguent Shopper K 0x4B Message Type Codes Return to Idle A 0x41 Port command B 0x42 MAC Data C 0x43 Directory of files D 0x44 Configure Tender E 0x45 Form Request V 0x56 Global Parameters 0 47 Split Message H 0x48 Initiate Code T 0x49 Download Poll Customer Data 4 Disable enable K 0x4B Keyboard File Delete 0x4C Update Display 0x4D L M Clear all Display Lines N 0x4E File Load P 0x50 Form Information Q 0x51 Terminal Status S 0x53 Terminal Type T 0x54 Version Information F 0x46 Error Response X 0x58 TCPIP ACK Z 0x5A Keyboard Lock ph 0x5F Hardware Reset 0 40 SetNMSIP
10. KS DUKPT key serial number PD PIN block T Track data TS Track data source TT Tender type Poll customer data example Request lt STX gt J lt ETX gt lt LRC gt Send all data lt STX gt J lt FS gt T lt FS gt PD lt FS gt TT lt FS gt CB lt RC gt send only data requested Response Field Description Length Value Message Type Message ID 1 42 FPE Interface Specification Data Field tokens ASCII varies Field tokens sent by FPE in response to Poll Customer Data J messages v NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description CB Cash back amount F Frequent shopper track data FS Current FPE customer activated state KS DUKPT key serial number PD PIN block T Track data TS Track data source TT Tender type XM MSR error XP PIN error XT Frequent shopper MSR error Field tokens in response to Poll Customer Data J messages descriptions T MSR track data Field Description Length Value Token Field ID 1 T Parameter Track ID 1 ASCII numeric 1 2 8 4 Data Track data varies ASCII and ASCII numeric Example lt FS gt T1B4012000000001 HYPERCOM TEST CARD 050201234567890 Example FS5T240120000000012050201234567890 Example FS PD PIN block data 3HYPERCOM
11. Account number Sets account number in the request for PIN entry Required for PIN entry v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 AC Parameter Account number to use for PIN 12 19 ASCII numeric encryption Example FS AC4012000000001 BO B9 Global button text Global button text 9 Sets text to Global button caption Optional v NOTE These tokens are processed PD87xx PD47xx terminals Field Description Length Value Token Field ID 2 BO B9 Text Text to display 1 42 ASCII chars v NOTE The length of the text which can be displayed depends on used font 23 24 FPE Interface Specification Example FS BlDebit FS B2Credit C1 C30 Pole display prompt 1 Pole display prompt 30 Sets text to Pole display prompt Optional v NOTE PDxxxx terminals process 1 to 30 pole display prompts The length of the text which can be displayed depends on terminal type and font used Field Description Length Value Token Field ID 2 3 C1 C30 Parameter Scroll flag 1 Y or N Parameter Text to display varies ASCII chars Example FS C1NThis text goes on pole display line one Example lt FS gt C2NThis text goes on pole display line two Example lt FS gt C3NThis text goes on pole display line th
12. Description Get file T Request file s information Field tokens used in File Download descriptions G Get file Field Description Length Value Token Message ID 1 G Parameter File name 1 256 ASCII Example lt STX gt d lt FS gt GERROR log lt ETX gt lt LRC gt L Request file s information Field Description Length Value Token Message ID 1 IN Parameter Directory or file name 1 256 ASCII v NOTE If directory or file name has relative path it will be prefixed by C Example lt STX gt d lt FS gt Ld lt ETX gt lt LRC gt Field tokens sent by FPE in response to File download d messages v NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description G File data T File s information Field tokens sent by FPE in response to File Download Requests descriptions G File data Field Description Length Value Token Field ID 1 G Parameter Return code 1 ASCII numeric see table below Parameter More data flag 1 Y more file packets are coming N final file packet Parameter Data size 3 ASCII numeric 001 999 Parameter File name 1 256 ASCII FS Field separator 1 FS 0x1C Data File data 1 999 Binary values 0 255 88 FPE Interface Specification Return code Description
13. Form message examples Request lt STX gt V lt FS gt FNSIGSCREEN lt FS gt ST3 lt FS gt SP1024064011 lt ETX gt lt LRC gt FPE responds with any data entered on the form in this case signature data Response lt STX gt V lt SD025 lt 25 bytes of signature data gt lt ETX gt lt LRC gt Request lt STX gt V lt FS gt FNEDITSCREEN lt FS gt ETM lt FS gt M3 lt FS gt AC4012000000001 lt ETX gt lt LRC gt FPE responds with any data entered on the form in this case master session PIN data Response lt STX gt V lt FS gt PD1BCF5FDE1B8FAC9A lt ETX gt lt LRC gt Request lt STX gt F lt FS gt FNBUTTONSCR lt FS gt P2Display this as prompt two lt ETX gt lt LRC gt FPE responds with the button return key of the button that was selected to end processing of the form In this case the button pressed has a return key of FuncKey2 B Response lt STX gt V lt FS gt BFB lt ETX gt lt LRC gt Displaying the Form FN token sets a name of the screen to display It is the only required token in Form Request message Pn tokens where 1 n 9 set text to Global prompt fields Form may contain up to 9 Global prompt fields or not to have them at all Global prompt fields formats and positions are set on the form development stage and cannot be changed by FPE application Cn tokens where 1 lt n 30 set text to Pole display prompt fields Form may contain up to 30 Pole displ
14. with text Ttem2 text and 003 with Ttem3 text Update item with ID 001 in this scrolling receipts list Request lt STX gt M lt FS gt FNRECEIPT lt FS gt 1U010012001 lt ETX gt lt LRC gt FPE responds with results of the update operation execution Response Update operation failed due to Invalid or not supported parameter error return code in IU token is 4 Invalid or not supported parameter lt STX gt M lt FS gt 1IU010014 lt ETX gt lt LRC gt o Remove an item or set of items in one request from a control or several controls 55 56 FPE Interface Specification Request M with IR Optimum ECR Cae PIN pad Terminal Response M with IR tokens Ce a Figure 5 Remove an item Scenatio1 Scrolling receipts list with ID 001 has items with Ids 001 002 003 Remove items with IDs 001 and 002 from this scrolling receipts list Request lt STX gt M lt FS gt FNRECEIPT lt FS gt IRO1001001 lt FS gt IROO2 lt ETX gt lt LRC gt FPE responds with results of the remove operation execution Response Two items were successfully return code in both IR tokens is 0 success removed from the list with ID 001 lt STX gt M lt FS gt IR010010 lt FS gt IR010010 lt ETX gt lt LRC gt v NOTE Update Display M message sent in the response will contain same number and the seq
15. 0 Success T Failure File not found L File s information Field Description Length Value Token Field ID 1 L Parameter Return code 1 ASCII numeric see table above Parameter String in the following varies ASCII format file name gt t lt type gt t lt size gt n where lt file name gt name of the file or directory without path information type F file or D directory and size in bytes v NOTE If request contains directory name information for all files directories in given directory is returned Customer activation These forms are needed for customer activation They must be created using the Form Builder tool and downloaded to FPE before entering the customer activated mode IDLEFRM Displayed at the IDLE state GETTENDFRM Displayed at the GetTender state BADSWIPE Displayed when a bad card swipe occurs CLOSEDFRM The first form displayed after a power cycle Use to stop customer activation FREQSHPFRM Displayed at the FreqShopper state WAITFRM Displayed at the Wait state after all customer data is entered Customer activation starts in the IDLE state when the Return to Idle A message is sent to FPE Send a Form Request V message with the Form Name token FN set to CLOSEDFRM to exit customer activation Before FPE s customer activated mode is enabled by sending the Return to Idle A comma
16. Field Description Length Value Message Type Message ID 1 R Data File name 1 256 ASCII Response Respond to FPE vvith a File Load P message 61 File Reguest example Request FPE requests lt STX gt RLOGO PCX lt ETX gt lt LRC gt Response ECR responds lt STX gt PY500LOGO PCX lt FS gt lt 500 bytes of file data gt lt ETX gt lt LRC gt Terminal Status S Get the ready status of FPE ECR Request S Terminal v NOTE This token is processed on ICE terminals and may not apply to Symbol payment terminals Request Field Description Length Value Message Type Message ID 1 5 Field Description Length Value Message Type Message ID 1 S Data Terminal status 1 ASCII numeric 1 ready 0 busy Terminal Status example Request lt STX gt S lt ETX gt lt LRC gt FPE responds with the current ready status Response lt STX gt S1 lt ETX gt lt LRC gt 62 FPE Interface Specification Terminal Type T Get the type of terminal FPE is running on v NOTE This request is processed on all types of terminals identically Request Field Description Length Value Message Type Message ID 1 T Response Field Description Length Value Message Type Message ID 1 r Data Terminal type 1 ASCII numeric 7 PD8700 A PD4700 B PD4750 Term
17. Frequent shopper yes no Field Description Length Value Token Field ID 2 FS Parameter Purchase Balance Yes No prompting 1 Y or N Example lt FS gt FSY Y NOTE Turn on or off Frequent Shopper Card processing Configure Tender example Request lt STX gt E lt FS gt T TB lt FS gt RP lt FS gt CT2 lt FS gt C1iPlease Press Enter lt FS gt CFCBKEYFRMK lt FS gt CYY lt FS gt Y1Do You Want Cash Back lt FS gt Y2Select Yes or No lt FS gt YFCBYNFRM lt FS gt ETD lt FS gt P1Please Enter Cash Back Amount lt FS gt C2And Enter Your PIN lt FS gt P2And Press Enter lt FS gt PFPINFRM lt FS gt S1Please Swipe Your lt FS gt S2Debit Card lt FS gt SFD Response None EBITFRM lt FS gt FSN lt ETX gt lt LRC gt 22 FPE Interface Specification Form Request V Display and process a form Form Request V is used for following purposes To display any form assigning texts to global prompts pole display global buttons and entry fields It also allows displaying text lines over the form To receive track data from magnetic or EFID card To receive signature data image To enter PIN To enter data from the terminal manually Terminal v NOTE There may be none or one or more response messages on one request message v NOTE Some of this request tokens are dependent on terminal type See notes below Request Field Descrip
18. amp Boot loader version 0 36 ASCII FS Field separator 1 FS 0x1C Data Packing list version 4 ASCII FS Field separator 1 FS 0x1C Data Terminal serial number 12 ASCII Parameters Field tokens varies ASCII Field tokens used Version Information F response v NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description MV Minor version supported only on PDxxxx PIN pads RF Contactless Card Reader firmware version supported only on PDxxxx PIN pads Field tokens used in Version Information F response MV Minor Version Field Description Length Value Token Field ID 2 MV Parameter Minor Version 2 4 ASCII 65 RF Contactless Card Reader Firmware version Field Description Length Value Token Field ID 2 RF Parameter Contactless Card Reader Firmware 0 50 ASCII version Version Information examples Request to PDxxxx terminal lt STX gt F lt FS gt MVY lt ETX gt lt LRC gt Response lt STX gt F0002C013 lt FS gt 0S 20050422 L4100Boot 20041130 x4100 lt FS gt 0001 lt FS gt 100004525940 lt FS gt MV54 lt ETX gt lt LRC gt Request to PDxxxx terminal lt STX gt F lt FS gt RFY lt ETX gt lt LRC gt Response lt STX gt F0002C013 lt FS gt 0S 20050422 L4100Boot 20041130 x4100 lt FS gt 0001 lt FS gt 100004525940 lt FS gt RFSCI1 PYPS PIPS VMSD GPMT 9600 050225 012901 lt ETX gt lt LRC gt 66 FPE Interface Sp
19. seconds 999 to wait for ever for user input 000 for returning back the existing parameter any value lt 999 will be set as timeout period FS Field Separator 1 FS 0x1C Token Field ID Form Name 2 FN Data Form Name varies ASCII 77 Comments To omit the Form Name from the reguest is same specify 000 parameter in Timeout period field a response with values currently set will be sent immediately without displaying DUKPT Encryption test form on the PIN pad It is recommended to use default ECP port configuration form named ECRSETUP built into PIN pad application Example to request ECR port configuration where ECRSETUP a name of the custom form screen for port configuration 60 operation timeout in seconds lt STX gt p lt FS gt CP lt FS gt TO60 lt FS gt FNECRSETUP lt ETX gt lt LRC gt Response For requests that contain PW and or PU tokens FPE does not respond other than the protocol ACK If QP and or QU token present in a request then terminal responds with p message containing queried value s Field Description Length 1 Value Message Type Message ID 1 p Data Field tokens varies ASCII Field tokens used in Setup Parameters p response NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Descript
20. 17 18 FPE Interface Specification CT Cash back type Field Description Length Value Token Field ID 2 CT Parameter Cash back type 1 ASCII N OFF 1 Clerk 2 Keyboard 3 Buttons Example lt FS gt CT3 C1 Cash back prompt one Field Description Length Value Token Field ID 2 C1 Parameter Cash back prompt one varies ASCII Example lt FS gt C1 Please Enter Cash Back Amount C2 Cash back prompt two Field Description Length Value Token Field ID 2 C2 Parameter Cash back prompt two varies ASCII Example lt FS gt C2And Press Enter CF Cash back form name Field Description Length Value Token Field ID 2 CF Parameter Cash back form name 1 11 ASCII upper case characters Example lt FS gt CFCBKEYFRM CY Cash back yes no prompting on or off Field Description Length Value Token Field ID 2 CY Parameter Cash back Yes No prompting on or 1 Y or N off Example lt FS gt CYN Y1 Cash back yes no prompt one Field Description Length Value Token Field ID 2 Parameter Cash back Yes No prompt one varies ASCII Example lt FS gt Y1Do You Want Cash Back Y2 Cash back yes no prompt two Field Description Length Value Token Field ID 2 Y2 Parameter Cash back Yes No prompt two varies ASCII Example FS Y2Select Yes o
21. 2 P1 P9 Text Text to display varies ASCII chars Example FS P1Display this as global prompt one Example lt FS gt P2Display this as global prompt two Example for PDxxxx terminals FS PlDisplay this as global prompt one lt FS gt P2Display this as global prompt two lt FS gt P5Display this as global prompt fivesFS P6Display this as global prompt six lt FS gt P7Display this as global prompt seven SB Signature capture buffer size Is used to change usually increase default Signature capture buffer size If request message contains SB token response message will contain SB token instead SD Optional v NOTE This token is processed on PD8700 and PD4750 terminals only Field Description Length Value Token Field ID 2 SB Parameter Buffer size specified in bytes 1 5 ASCII numeric Example lt FS gt SB11111 SM Signature capture message Is used to change signature capture default warning message text Optional v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 SM Parameter Message text varies ASCII chars v NOTE The length of the text which can be displayed depends on terminal type Example lt FS gt SMPlease sign inside signature box SP Signature capture resolution Sets signature capture resolution Optional v NOTE This token is processed on
22. ER EE EE RE S 16 Field tokens used in Configure Tender E messageS issie ee ee ee ee se ee ee ee ee ke ee ee dk ee ge ee 16 Field tokens used in Configure Tender descriptions 17 Tl lt TONGS Ly PC MR ER EE RR AE RO AR OE 17 RP de lu OE RE AE RE E eren Ya M 33 17 Ga sh pack type mimara aaa aa EL RE OR aod eia 18 C1 Cash back prompt 6 5 ananin AR RA Ge AA Re AA AA AA Ge Re ee AA Ge ee ee 18 C2 Cash back prompt WO ee se ee ee AA AA RR AA Ge AA Ge AR GR AA Ge AA AR ee AA ee nennen 18 CF Cash back form name esse ee ee Ge AA ee ee AA Ge AR AA Ge AA Ke ee RA ee ke ee ee 18 CY Cash back yes no prompting on or off 18 Y1 Cash back yes no prompt one esse ee Ge nnne nnne nnn nnne 18 Y2 Cash back yes no prompt WO ese es se ee RA AA Re eraya eee aaa eraya area lilin 18 YF Cash back Yes No form ener enne 19 RR ecrit RE Fe Den EE EG 19 M Master key to use for master session PIN 5 19 WK Working key for master session PIN 2 ee ee RA AA ee ee 19 PT PIN promptorie t EE ORE ER ARE EE EE ED 19 P2 PIN prom Pt WO a tent e eme arti e e etn A se ec ees 19 PESPIN om ae UL dn M EE OE EE Ge ee 19 BY Purchase balance yes no prompting on or Off
23. FS gt CL lt FS gt TO60 lt FS gt FNCALIBRFRM lt ETX gt lt LRC gt TL Touch screen calibration Test Test Calibration Field Description Length Value Token Field ID 2 TL FS Field Separator 1 FS 0x1C Token Field ID Timeout 2 TO Data Timeout period in 1 3 ASCII Numeric seconds 999 to wait for ever for user input 000 for returning back the existing parameter any value lt 999 will be set as timeout period FS Field Separator 1 FS 0x1C Token Field ID Form Name 2 FN Data Form Name varies ASCII Comments If Form Name is omitted from the request then the default calibration form built into PIN pad application named CALIBRFRM will be displayed Example to request device touch screen calibration test where CALIBRFRM a name of the custom form screen for testing calibration 60 operation timeout in seconds xSTXsp FSsTL FSs TO60 FSsSFNCALIBRFRM ETXs LRC 75 76 FPE Interface Specification TD DUKPT Encryption Test DUKPT Field Description Length Value Token Field ID 2 TD FS Field Separator 1 FS 0x1C Token Field ID Timeout 2 TO Data Timeout period in 1 3 ASCII Numeric seconds 999 to wait for ever for user input 000 for sending response with current KSN PIN and other values any value 999 will be set as timeout period FS Field Separator
24. September 2006
25. delivered hereunder and to include the same on any authorized copies it makes in whole or in part The user agrees not to decompile disassemble decode or reverse engineer any licensed program delivered to the user or any portion thereof Symbol reserves the right to make changes to specification and any software or product to improve reliability function or design Symbol does not assume any product liability arising out of or in connection with the application or use of any product circuit or application described herein No license is granted either expressly or by implication estoppel or otherwise under any Symbol Technologies Inc intellectual property rights An implied license only exists for equipment circuits and subsystems contained in Symbol products Symbol Spectrum One and Spectrum24 are registered trademarks of Symbol Technologies Inc Bluetooth is a registered trademark of Bluetooth SIG Microsoft Windows and ActiveSync are either registered trademarks or trademarks of Microsoft Corporation Other product names mentioned in this manual may be trademarks or registered trademarks of their respective companies and are hereby acknowledged Symbol Technologies Inc One Symbol Plaza Holtsville New York 11742 1300 http www symbol com ii FPE Technical Specifications Revision History Changes to the original manual are listed below Change Date Description 01 Rev A 11 2006
26. have any other tokens allowed for V request but they will not affect on the content of the response message Only one V response containing signature data may be received per one Form Request V PIN Entry Form Request V allows entering a PIN using DUKPT or Master Session encoding FN token sets a name of the screen for the PIN entry This screen must have special PIN entry field FN token is required for PIN entry AC required token which determines Account number ET required token which sets one of two available encryption types Master Session M or DUKPT D M token which sets Master key index This token is required only for Master Session encryption type WK token which sets Working key for master session PIN encryption This token is required only for Master Session encryption type Manual Data Entry Form Request V allows entering data manually using screen controls edit fields buttons radio buttons and check boxes To enter any data you have to display screen containing required controls enter required data and press Enter button Response message will contain BF token with Button return key and as many Fn Cn Rn tokens as non empty entry fields check boxes and radio button groups are on the screen Global Parameters G Download global parameters to the terminal v NOTE This request is processed on all types of terminals Request Field D
27. ie dese ee ee ee ee ed R s ee ee ee ee ee ee a ee ee ee 70 POS Event command field token descriptions 70 KD Keyboard button irae ecu eec dg un de N epe deed 70 KB Form DUHOM RE EE EE gente eee tpe ipee gne ad res ep e dp eee etas 70 XM Frack read error iia iet etu eee edge dp ee eee a ve ddp e aues 70 TE Track datas iid tdt dg He ic alee ae 71 Edele AE RE EE OE RA RE aed 71 TS Track data 50 anie AR yaa Ge AA AA Ge nass Ge Ak AR ee AA ee 71 Screen Protector Status 71 Hequest 2 5 etta RE p dei db EE OE rere 72 Setup Parameters pieni b UL este eL c D E DUUM E 72 Hequest ELTE 73 Field tokens used in Setup Parameters p request 73 Field tokens used in Setup Parameters 5 see ed ee AA Ge AA ee Ge AA ee AA ee Re ee 73 PW Set New PasswoOrd esse see ee ee AA ee AR yam Re ee ee AA Re Re ee AA ee ee ee 73 Query current 55 AAA Ae eee GRA ERA ERA AR AR RR ER Re ee ee ee ee 7a PU Set PowerUp ee se se AR Ge AA Ge AA AR ee AA Ge AA Aa Ge ek AA ee Aa nenas 73 QU Query PowerUp parameteF iese ee ee ee Ge AA ee ee eraya Ge AA ee ee AA ee ee ee 74 PHTMS Set HTMS connection 74 QHTMS Query HTMS connection 74 CC C
28. processed on all Optimum PIN pads PDxxxx Request Field Description Length Value Message Type Beeper Control 1 b Data Duration in 1 10 of a 2 ASCII Numeric 01 99 second Response None 83 Examples Request lt STX gt b10 lt ETX gt lt LRC gt Response None PowerUp message r FPE sends this message on power up on terminal enter of the CLOSED state after restart to ECR v NOTE These messages should be enabled by Setup Parameters p message with PU token field Example lt STX gt p lt FS gt PUY lt ETX gt lt LRC gt ECR Terminal v NOTE This message is supported only on PDxxxx platform Request Field Description Length Value Message Type Message ID 1 r 0x72 Response None PowerUp message example Request FPE requests lt STX gt r lt ETX gt lt LRC gt Response None ECR does not respond other than the protocol ACK 84 FPE Interface Specification UPOS Statistics u Request u Optimum PIN pad Terminal v NOTE This request is processed on Optimum PDxxxx terminals only Request Field Description Length 1 Value Message Type Message ID 1 u Parameters Field tokens varies ASCII Response Field Description Length 1 Value Message Type Message ID 1 u Data Field tokens varies ASCII Field tokens used in UPOS Statistics messages NOTE Field tokens are in
29. ves ene ed eee 62 Version Information ie oe LE OE AE EE 63 Hequesb PR 63 Field tokens used in Version Information F messageS iss ee se de ee ee ee ee ee ee 63 Version Information field token descriptions 5 ee ee RR AA Ge AA esi RR ia 63 MV Minor Version PDxxxx only se ee ee ee Ge ee Ge ee Ge AA ee Ge AA ee Ge 63 RF RFID Firmware version PDxxx only emnes 63 RESPONSE ME EE 64 Field tokens used Version Information F 5 ss see ee ee de ee Ge ee ee Re ee 64 Field tokens used in Version Information F response 64 MV Minor VerSIOT N ME RE HE EE x De eva RALAR 64 RF Contactless Card Reader Firmware version iese se ee esse ee ee ke ee ee ee ee ee ke ee ee ee 65 Hardware Reset M OMM 66 Bed El 66 FSDORS e AE in ER EO EE OE OE EE EE is 66 Error TeSpOHSB X ie GE EE L AD 66 RESPONSE EE R ana ER OE ER RE ER 66 lie uote Z mE 67 Keyboard Lock ceci hane EE OE NUN ossia 67 Set NMS IPGonflg Ai eiecti anre iori reas 68 perpe EE 68 Field tokens used in Set NMS IPConfig N 55 965 sss 68 Set NMS IPConfig command field token descriptions 68 UP eel NE EE EE EE ER OR N 68 goals EE EE 68 RESPONSE P m 69 POS Event EE E 70 si LE 00070 0007000 EN 0000000000 70 Field tokens used in POS Event messages
30. 0 lt 200 bytes of the 325 byte response gt lt ETX gt lt LRC gt lt STX gt HN125 lt the remaining 125 bytes of the response gt lt ETX gt lt LRC gt Initiate Code Download Put the terminal into the code download mode Request I ECR Terminal v NOTE This request is processed on all types of terminals identically Request Field Description Length Value Message Type Message ID 1 T Parameter Baud rate 4 6 ASCII numeric 9600 19200 57600 115200 153600 Response None Initiate Code Download example Request lt STX gt I19200 lt ETX gt lt LRC gt 40 FPE Interface Specification FPE does not respond other than the protocol ACK Response None Poll Customer Data J Poll the terminal for any data collected in customer activated mode If any tokens are included in the request message FPE will send back only the requested token data otherwise all available data is sent Request J v NOTE This token is processed on all types of terminals identically ECR Terminal Request Field Description Length 1 Value Message Type Message ID 1 None Field tokens used in Poll Customer Data N messages NOTE Field tokens are in the format lt FS gt lt Field Token Token Description CB Cash back amount F Frequent shopper track data FS Current FPE customer activated state
31. 1 FS 0x1C Token Field ID Form Name 2 FN Data Form Name varies ASCII Comments o To omit the Form Name from the request is same as specify 000 parameter in Timeout period field a response with values currently set will be sent immediately without displaying DUKPT Encryption test form on the PIN pad o t is recommended to use default DUKPT encryption test form named DUKPTNEVV built into PIN pad application o Ifa custom form should be used for DUKPT Encryption test the following three forms should be available on the PIN pad 1 Aform for Account and PIN input 2 Aform for displaying successful encryption results Assuming that the name of the form specified in 1 is lt name gt then the name of this form should be like lt name gt 2 3 A form for displaying unsuccessful encryption result If a name of the form specified in 1 is lt name gt then the name of this form should be like lt name gt 3 Example to request DUKPT encryption test where DUKPTNEW a name of the custom form screen for DUKPT encryption test 60 operation timeout in seconds lt STX gt p lt FS gt TD lt FS gt TO60 lt FS gt FNDUKPTNEW lt ETX gt lt LRC gt CP ECR port configuration Field Description Length Value Token Field ID 2 CP FS Field Separator 1 FS 0x1C Token Field ID Timeout 2 TO Data Timeout period in 1 3 ASCII Numeric
32. 20 B1 Purchase balance yes no prompt One see ee se ee ee Ee AA ee ee AA ee ee 20 B2 Purchase balance yes no prompt two ese ee se ee Ge AA ee AA ee nennen 20 BF Purchase balance yes no form name ese dee ee se Re Ge AA Ge AA ee RR ee ee ee ee 20 S1 Swipe prompt 6 5 ee RA AA Ke Ge AA AR Ge AA Ge AA RA de AA AR ee AA nnne innen 20 S2 Swipe prompt se see s RA see Re RR AA raya AR araya Ge AR Ge AA nnns innen 20 SF Swipe form name A AAA RA AG AA Ge AA RA AG AA Ge AA Ge AA Ge AA ee ee AA ee ee ee 20 FS Frequent shopper yes no eds se de se ee ee ee ek AA Ge ee eyes Ge AA entree entr de ee nnne 21 Form RedtieSt Missie sad es treed eN Ns aba UE Dk Re ed DERE dae Aa AD Ee 22 ad EE 22 ac AM LE EE 22 Field tokens used in Form Request V 55 465 ee se ee emnes 22 Field tokens used in Form Requests descriptions sene 23 AG Account number cii cosine tre t d euer EER Ge EG see ee RR Ee 23 BO B9 Global button text Global button text 9 see ee ek Ge AA ee ek ee 23 C1 C30 Pole display prompt 1 Pole display prompt 80 esse se ee ee ee ke ee 24 DE Display Line TEN 24 DT Screen saver timeout AR Ge asas ee RA AA AA Ge Re ee AA ee ke eek de 24 EO E9 Edit field text O Edit field 9 ese ees see ee se ee ee ee ee
33. AA Ge ed ke ee RA ee ee ee ee 25 EF Edit field format iss ss ee ee ee se a AA Ge AA Ge eee ee innen Ge AA Ge aan Aaaa aE AG AA ee ee 25 ET Encryptlonitype iine cine EER EE ER EE EE N 25 MEN eu AE RE RE ER OE OE OE N 25 HP HyperPass Contactless Card Reader enable ese ese se ee se sess 25 Mi Master key 86 see de se Re Ge AA AA Re ee AR Ge AA nnne nennen Ge AA ee RA AA ee ee ee 26 Di DUKPT key Indexs tte nep see se EE Ee RS ER ORN ans Bee EE Gees eut ea euren koes E bee ie 26 PT P9 Global prompt 1 RR RE RE AN 26 SB Signature capture buffer size see RA ee RA ee Re ee ener 27 SM Signature capture 55 6 AR Re ee RA ee Re ee ee Ee AA ee ee Re ee ee nnns 27 SP Signature capture ee Re Ge s AR AA Re Re ee AA nens 27 SS Signature capture message enabled ee RA Ge AA ee AA ee ee ee 27 ST Signature capture time out iis ee se de AR Ge AA Re AR Ge AA Re AR Ak AA Ge nnne 28 SU Signature capture uuencode ee AA ee AR Ge AA Ge AA ee ee RA ee ee ee 28 TF Text format Alignment s sidien iiaea teiaa AA Ge AA ee AA Ge AA Ge enn AA ee 29 TT e MSRitrack to ER ee eee AE ve ee Ee net e eit 29 Tho Track data sources tice ted erat Pe ene bae De Ee 30 WK Working key for master session PIN encryption ie se ee RA ee ee 30 F
34. Config IN 0x5E POS Event di 0x60 Upload file system T 0x5B Setup Parameters p 0x70 UPOS Statistics u 0x75 File Upload d 0x64 Return to Idle A Returns FPE to customer activated mode idle This request is processed on all types of terminals identically Request Field Description Length Value Message Type Message ID 1 A Parameters Field tokens varies ASCII Response None Field tokens used in Return to Idle A messages Token 1 Pescription FN ldle form name CP Clear pole display fields TT Tender type field DF Delete Fields v NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt 6 FPE Interface Specification Return to Idle field token descriptions FN Form name Field Description Length Value Token Field ID 2 FN Parameter Form name to process 1 11 ASCII form name v NOTE If this token is included in the message this form will be displayed at the customer activated idle state instead of the default form name IDLEFRM Example lt FS gt FNMYIDLEFRM CP Clear pole display fields Field Description Length Value Token Field ID 2 CP Parameter Clear pole display fields 1 Y or N v NOTE This causes any pole display lines that were set using the Cn token in a Form Request or Update Display message Example lt FS gt CP TT Tender type
35. D 2 DT Data Timeout in seconds 1 9 ASCII numeric Example lt FS gt DT100 E0 E9 Edit field text 0 Edit field 9 Sets text into edit fields Optional Field Description Length Value Token Field ID 2 EO E9 Text Text to display varies ASCII chars Example FSsElEdit field 1 EF Edit field format Sets specific data entry formats date phone number and SSN for numeric entry fields Optional Field Description Length Value Token Field ID 2 EF Data Edit field number 1 ASCII numeric 0 9 Edit field number Data Edit field format 1 ASCII numeric 0 3 0 no format 1 social security number 2 date 3 phone number Example lt FS gt EF12 lt FS gt EF22 ET Encryption type Sets Encryption type in the request for PIN entry Required for PIN entry v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 ET Parameter Encryption type 1 M for Master Session D for D KPT VV encryption vvithout account number Example lt FS gt ETM FEN Form name Sets a name of the screen to display Required v NOTE This token is processed on all types of terminals identically Field Description Length Value Token
36. D 2 Mi Parameter Master key number to use for MAC 1 ASCII numeric 1 9 calculation 13 Example lt FS gt M3 MK MAC Key Field Description Length Value Token Field ID 2 MK Parameter MAC key to use for MAC calculation 16 ASCII hex Example lt FS gt MK20AFBD34AA23F0D8 MD MAC Data Field Description Length 1 Value Token Field ID 2 MD Parameter Length of data 3 ASCII numeric 001 400 Parameter Data to be MACed 1 400 Binary values 0 255 Example lt FS gt MD016Data to be MACed MAC data example Request lt STX gt C lt FS gt M 3 lt FS gt MK20AFBD34AA23F0D8 lt FS gt MD016Data to be MACed lt ETX gt lt LRC gt FPE responds with an eight digit ASCII Hex MAC value Response lt STX gt CFE27E632 lt ETX gt lt LRC gt v NOTE If the MAC key token is not used the MAC will be calculated using the Master key selected by the Master key index token If the MAC key token is used it is assumed to be the MAC working key encrypted under the Master key selected by the Master key index token Directory of Files D Get a directory of all files contained in the terminal s file system This request is processed on all types of terminals identically 15 16 FPE Interface Specification Request Field Description Length 1 Value Message Type Message ID 1 D Response Field Description Length 1
37. E HE RE EE N sas n D n 10 Field tokens used in Port command B 95 065 ee se ee ee ene 10 Port command field token descriptions sse 10 PN Port number ea RE N EK 10 Atom EE eto ettet e aede ducet tee tust 10 BR Baud rate otium etre bet entree Mte tied Hte E este 10 CP Configuration parameters se ee ee RR Ge AA Ge AR eraya eraya kayak nnne renis 10 DT Data to send to or received from the esse ee ee ee AA Ge AA ee RR iii ee ee 11 Field tokens sent by FPE in response to Port command B messages 11 MAC Data E mer T 13 ater E 13 rn E 13 Field tokens used in MAC Data C message se ee ER AA Ge AA Ge AR GRA nennen 13 MAC Data field token descriptions ee ee Re AR AA Ge AA Re GR AA eee ee rama ee AA ee ee ee 13 ME Masterkey 1 1 06 Ee ie ae rape eee reete e ip d etui 13 Mu MAC EE 15 iv FPE Technical Specifications MD MAG Data ER OR EE ER eger N ER EE Hm dta 15 Directory of Files D autre Cops eps Rd ire rooies ssas 15 ROQUOS ts OE xr Pte ub dara ied irr ei a FU iot REO 16 HOSpOLSO AE iie S Ud ie p EE EE EE diet 16 Field tokens used in Directory of Files 55 65 16 Gonligure Tehder Ezan cuins tios ed a ED uncta eee 16 Ete VA N EE EE N EE RR N 16 Ip rennrcKd N ER
38. Ee Ee ee eie 35 Getting Signature Data ns hsm n ttm ass 35 PIN EDU AE ice Ee s n EE EE 36 Manual Data Entry i e t Site Ge Re ab ee e rit EE Ee IO 36 Global Parameters iue eint oce te DAR LOAD 37 Req est dee teu ete n teer iie rise etat ridet OR 37 F SDORSO Em 37 Field tokens used in Global Parameters messages 37 Field tokens used in Global Parameters descriptions 37 PS Communications packet size iese ee AR RA AA GR AA Ge AR ee AA ee ee ee 37 FA Idle state first se ee ani AA AR AA Ge AA Ge AA AR ee AA ia AA Ge ee AA ee ee ee 37 KD Key Down POS Event ees ee ee de ee de ee ee Ak AA Ge RA AA AA Ge ee ee AA nnne rennes 37 SW MSR POS Events ses Ede as RE eaaa naa GE WED ek BR hehe cule eva er KUR EE 38 MOP Screen Protector iic EE EN EE 38 sia Mes ad Ho Dems 38 FeSsponse OE RE OE ER OE ER RR ER fines bit 39 Initiate Code Download REKE Re SEER RENE EER 39 gie 39 FSDORDSe EE EE ii a Se ER RE EE EA EE 39 Poll Gustomer Data d i EE a tae ca ee de enun tie ioc ee ee seek 41 PROQUCS EMT RE ER OE siken 41 Field tokens used in Poll Customer Data J messages is ed se AA Ge AA ee ee Re ee 41 aile MM 41 Field tokens sent by FPE in response to Poll Customer Data J messages 42 Fi
39. FPE Interface symbol The Enterprise Mobility Company FPE Interface Technical Specifications 72E 91526 01 Revision A November 2006 symbol The Enterprise Mobility Company 2006 by Symbol Technologies Inc All rights reserved No part of this publication may be reproduced or used in any form or by any electrical or mechanical means without permission in writing from Symbol This includes electronic or mechanical means such as photocopying recording or information storage and retrieval systems The material in this manual is subject to change without notice The software is provided strictly on an as is basis All software including firmware furnished to the user is on a licensed basis Symbol grants to the user a non transferable and non exclusive license to use each software or firmware program delivered hereunder licensed program Except as noted below such license may not be assigned sublicensed or otherwise transferred by the user without prior written consent of Symbol No right to copy a licensed program in whole or in part is granted except as permitted under copyright law The user shall not modify merge or incorporate any form or portion of a licensed program with other program material create a derivative work from a licensed program or use a licensed program in a network without written permission from Symbol The user agrees to maintain Symbol s copyright notice on the licensed programs
40. Field ID 2 EN Parameter Form name to process 1 11 ASCII form name Example lt FS gt FNEDITSCREEN HP HyperPass Contactless Card Reader enable Enables HyperPass Contactless Card Reader on ICE 5K terminals and may not apply to Symbol payment terminals 25 26 FPE Interface Specification Field Description Length Value v NOTE There is no parameter for this token Example lt FS gt HP Mi Master key index Sets Master key index This token is required for PIN entry in case of Master Session encryption ype v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 Parameter Master key number to 1 ASCII numeric 1 9 use for MS encryption Example lt FS gt M 3 D DUKPT key index Sets DUKPT key index This token is required for PIN entry in case of DUKPT encryption type Field Description Length Value Token Field ID 2 DE Parameter DUKPT key number to 1 2 ASCII numeric 1 12 use for DUKPT encryption Example lt FS gt D 9 P1 P9 Global prompt 1 9 Sets text to Global prompt line Optional Y NOTE PDxxxx terminals process global prompts 1 to 9 The length of the text which can be displayed depends on terminal type and font used Field Description Length Value Token Field ID
41. I010010001 IR Results of an item remove from a control Results of an item remove from the control if requested by IR token of Update Display M request Refer to Manipulating the scrolling receipts list control items section for more information v NOTE FPE 3 0 010 supports only one control type ID which is 01 Scrolling receipts list control Field Description Length Value Token Field ID 2 IR Parameter Control Type ID 2 ASCII numeric 01 Scrolling receipts list control Parameter Control ID 3 ASCII numeric Parameter Return code 1 ASCII numeric see table below for details Return code Description 0 Success T Failure Item ID not found Example Successfully removed an item with ID 001 from a control of a type 01 Scrolling receipts list control and control ID 001 and an item 002 from a control of a type 01 and control ID 002 removal failed FS IR010010 FS IRO10021 IU Results of an item update in the control Results of an item update in a control if requested by IU token of Update Display M request See Manipulating the scrolling receipts list control items section for more information v NOTE FPE 3 0 010 supports only one control type ID which is 01 Scrolling receipts list control Field Description Length Value Token Field ID 2 IU Parameter Cont
42. ID The control is uniquely identified by control type and ID These values are specified in corresponding parameters see below v NOTE FPE32 3 0 010 supports only one type of the controls list of scrolling receipts Control Type ID is 01 If Location ID parameter is I application will ignore value specified in the Item ID parameter and will insert an item to the top or bottom of the list based on scrolling receipts list control configuration in FormBuilder We are assuming the length of the text which can be displayed depends on terminal type and font used 49 v NOTE This token is processed only on Optimum PIN pads Refer to Manipulating the scrolling receipts list control items section for more information Field Description Length Value Token Field ID 2 ln Parameter Control Type ID 2 ASCII numeric 01 Scrolling receipts list control Parameter Control ID 3 ASCII numeric Parameter Item ID 3 ASCII numeric 001 002 etc Parameter Location ID 1 ASCII chars l Ignore B before A after Text Text to display varies Example insert item with text Item2 text after item with ID 001 to the control with type 01 and ID 001 FS II01001001AItem2 text IR Remove an item from a control Allows removal of an item from a control The control is uniquely identified by control type and ID These values are specified in corresponding par
43. Initial Symbol Release Hypercom Version 3 23 Table of Contents Revision HIStory ama dra ee RS cc TE EG ii Lui teddie le EE AE ER A EE ED EN ix Notatlonal Conventions e eit ee eie ix Related Doeuli nts em X Services Intorin atl el EE AE X Communication Parameters ASYNC ER RR RR RR RR RR RE EER ER RR RR RR RE Ee Gee 1 dele 1 ASYNG EE PT Inm 1 ME MO ES n EE EE OE At AE AE AE rere 1 Requests supported by terminal 55 55 1 Terminal Type Codes gr 3 Key Codes and Tender Type Codes ii ani 3 Customer activated states DL a aa al 4 Message Type Codes EE IE EE N 4 Retirn to Idle A iss Si a SG adco aya aaa 5 ER ER ER EE 0 5 ER RE EE EE N 5 Field tokens used in Return to Idle A messages ies se de Re ee ee AA ee ee e 5 Return to Idle field token descriptions ee RR AA AA ee AR s s Ge AA ee RA AA ee ee ee ee 6 EN S el UI OE RE ER EO DA RA leks 6 CP Clear pole display 145 2 aie AA Ge AA AA RA AA Ea entente ee ee 6 ET eie MOM me 6 na ESE SA ER ariete de to Date i n OR Re 6 Return to lde example AE RA RE RE EE ER as 7 Port command m ee ei aac Se ea Sew N N we ee GE RR EG ke 7 Openr port 2e ER ER EE SO o id EE ced 7 e 9 pns EE O
44. PIN encryption Sets Working key This token is required for PIN entry in case of Master Session encryption type v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 WK Parameter Working key 16 ASCII Hex Example FS WK01D5FE020304ABEF Field tokens sent by FPE in response to Form Request V messages NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description BF Button selection C Check box checked state F Edit field data KS DUKPT key serial number PD PIN block H Radio button selection SB Signature data specified size SD Signature data T Track data TS Track data source XM MSR error XP PIN error FN Form Name IC Integrated Circuit Card ICC insertion and or removal Field tokens sent by FPE in response to Form Requests descriptions BF Button selected Contains return code of pressed key or button May be only one in the response message Field Description Length Value Token Field ID 2 BF Parameter Button return key 1 ASCII binary 1 for Enter button Example lt FS gt BFB C Check box checked state Contains information about check box state One per each check box on the screen Field Description Length Value Token Field ID 1 Ch
45. R connection Send data to port 1 lt STX gt B lt FS gt PN1 lt FS gt DT006 lt FS gt lt STX gt QM lt CR gt lt ETX gt lt LRC gt lt ETX gt lt LRC gt The device connected to port 1 responds with data and FPE passes it on to the ECR 12 FPE Interface Specification Response lt STX gt B lt FS gt PN1 lt FS gt DT019 lt STX gt MR2300 VER 1 45 lt CR gt lt ETX gt lt LRC gt lt ETX gt lt LRC gt v NOTE Responses will be sent unsolicited by FPE anytime data is received from the device connected to the port The ECR should be ready to receive Port command responses whenever a port is open MAC Data C Perform a MAC calculation on data ECR Request C Terminal v NOTE This token is processed on ICE terminals and may not apply to Symbol payment terminals Request Field Description Length 1 Value Message Type Message ID 1 Parameters Field tokens varies ASCII Response Field Description Length 1 Value Message Type Message ID 1 Data MAC value 8 ASCII hex Field tokens used in MAC Data C messages v NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description Master key index to use for calculation MK Key to use for MAC calculation MD Data to be MACed MAC Data field token descriptions Mi Master key index Field Description Length 1 Value Token Field I
46. S Data Track data source 1 0 TRACK READER 1 RDIF EXPRESS PAY 2 RFID PAY PASS 3 RFID VISA WAVE 4 RFID UNKNOWN APP Example lt FS gt TS1 Screen Protector Status a Received from FPE PD87xx and PD4750 only This message is sent by FPE to notify ECR about screen protector status change or as regular notifications with specified interval Interval is assigned by sending G command to the terminal and specifying desired interval by means of SP parameter 72 FPE Interface Specification ECR Terminal Request Field Description Length Value Message Type Message ID 1 a 0x61 Data Screen Protector on off 1 Y On N Off Data Number of days elapsed 2 ASCII numeric without screen protector Data Number of days left for the 2 ASCII numeric next reminder Screen Protector Status example Request FPE requests lt STX gt aN0503 lt ETX gt lt LRC gt v NOTE In this example terminal does not have screen protector installed It has spent 5 days without screen protector and the next reminder will take place in 3 days Response ECH does not respond other than the protocol ACK Setup Parameters p Setup Parameters p message should be used to configure device settings such as password to enter Setup Mode Setup Password enable disable PowerUp message configure HTMS connection activate PIN pad setup functionality and e
47. STX M FS FNRECEIPT FS IU010011001 FS 1U010011002NEW ltem2 text lt ETX gt lt LRC gt FPE responds with results of the update operation execution Response Two items were successfully return code in both IU tokens is 0 success updated lt STX gt M lt FS gt IU010010 lt FS gt IU010010 lt ETX gt lt LRC gt v NOTE Update Display M response will contain same number and the sequence of the IU tokens as in the request Scenatio2 Scrolling receipts list with ID 002 has items with IDs 001 with text Item1 text 002 with text Ttem2 text and 003 with Item3 text Update item with IDs 004 and 001 in this scrolling receipts list Item 004 should appear crossed Item 001 should appear crossed like Itemd text Request lt STX gt M lt FS gt FNRECEIPT lt FS gt 1IU010021004 lt FS gt IU1001 lt ETX gt lt LRC gt FPE responds with results of the update operation execution Response Update operation failed due to Item ID not found error return code in IU token is 1 Item ID not found for the first item with ID 004 Update operation was successful return code in IU tokens is 0 success for item 001 lt STX gt M lt FS gt 1U010021 lt FS gt 1IU010020 lt ETX gt lt LRC gt Scenatio3 Scrolling receipts list with ID 001 has items with IDs 001 with text Ttem1 text 002
48. Symbol Technologies Inc Notational Conventions The following conventions are used in this document If applicable the term FormBuilder in this guide refers to software Italics are used to highlight the following o Chapters and sections in this and related documents o Drop down list and list box names o Check box and radio button names Icons on a screen Bold text is used to highlight the follovving o Names of windows o Dialog box components bullets indicate o Action items o Lists of alternatives o Lists of required steps that are not necessarily sequential Sequential lists e g those that describe step by step procedures appear as numbered lists Special icons X FPE Technical Specifications NOTE Notes contain neutral or positive information supplementing the main text It is often information that applies only to special cases IMPORTANT Important statements draw attention to information crucial to using the product successfully Pay special attention to Important statements WARNING Warnings provide information that is essential to the safety of the user the Ed CAUTION Cautions advise that a negative result such as a loss of data may occur equipment or both Failure to do as instructed may result in physical damage Related Documents For the latest version of this and all payment solutions guides go to http www symbol com manuals Service Information For service information warra
49. TD DUKPT Encryption timeout ees sees se ee ee ee se ee ee Re ee ee Re ee ee ee ee nennen ee ee ee 80 CP ECR port configuration Configure 81 CP ECR port configuration sesse ee ee ee ee ee AR RA AA Re ee nennen nnne 81 Setup Parameters examples sss senes ee ee ee Re sensn enne 82 Beeper COMMON DA ER T 82 acere 82 ateis RR V 82 PowerUp message Tun Ee n de a a aa de dr EE 83 Hequest aided tit tim tad ed EED te et 83 RESPONSE RE ER E 83 UPOS Statisties Ui ENE ES a et 84 ate VI EE 84 H SDOT S Z EE 84 Field tokens used in UPOS Statistics messages is ee Re Ge AA Ge RR Ge AA ee ee Re ee 84 Field tokens used in UPOS Statistics descriptions 84 RI Retrieve Statisties oe qe dt d eth ded ee e b e deeds 84 RS Reset Statistics Er EER do ente e eee bee ED i ene pee a 85 Field tokens sent by FPE in response to UPOS Statistics messages 85 Field tokens sent by FPE in response to UPOS Statistics descriptions 85 RT Retrieve Statistics ee se ee RA Ge AA Ge ee AR AA AA Ge AA entente nitri nennen nnns nnne 85 RS sl ei iS ee OE EE OE N 85 File download de aa E p RR Ee ea SR ER Ge aa FARA ARENIS we gas 86 lace em 86 acrem
50. TEST CARD 1234567890 Field Description Length Value Token Field ID 2 PD Data PIN block 16 ASCII hex Example FS5SPD BCF5FDE1B8FAC9A KS DUKPT key serial number Field Description Length Value Token Field ID 2 KS Data Key serial number 20 ASCII numeric Example lt FS gt KS10000004598000000035 TT Tender type Field Description Length Value Token Field ID 2 TT Data Tender type 1 ASCII see key codes table Data Purchase Balance flag 1 ASCII P urchase or Balance Example lt FS gt TTA 43 FS Current customer activated state Field Description Length Value Token Field ID 2 FS Data State 1 See customer activated states table Example lt FS gt FSA CB Cash back amount Field Description Length Value Token Field ID 2 CB Data Cash back amount 0 50 ASCII Example lt FS gt CB12345 Entered on the keyboard Implied decimal 123 45 Example lt FS gt CBS 5 00 Selected from a button Example FS CB No cash back amount entered v NOTE If the cash back amount was entered from the keyboard the cash back amount will be in the form nnnnn The decimal point is implied If the cash back amount was selected from a button the data will be the button s text F Frequent shopper track data Field Descriptio
51. Value Message Type Message ID 1 D Data Remaining file memory 1 7 ASCII numeric Data List of files separated by varies ASCII Field tokens used in Directory of Files D messages None Directory of files example Request lt STX gt D lt ETX gt lt LRC gt FPE responds with the amount of remaining file memory and a list of all files in its file system separated by Response lt STX gt D650345 CONFIG SYS 2 SIGSCREEN 345 CBSCR 340 lt ETX gt lt LRC gt Configure Tender E Configure a tender type This request is processed on all types of terminals identically v NOTE Only one tender type should be configured per Configure Tender message Request Field Description Length 1 Value Message Type Message ID 1 E Parameters Field tokens varies ASCII Response None Field tokens used in Configure Tender E messages NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description TT Tender type code see Key Codes table HP Resets all parameters for this tender to default values Token Description CT Cash back type N OFF 1 Clerk 2 Keyboard 3 Buttons C1 Cash back prompt one C2 Cash back prompt two CF Cash back form name 1 11 characters CY Cash back Yes No prompting on or off Y or N Y1 Cash back Yes No prompt
52. Value Message Type Message ID 1 Q Parameters Field tokens varies ASCII Response Field Description Length Value Message Type Message ID 1 Q Data Form name 1 11 ASCII Data Form version 4 ASCII numeric Data Form creation date 12 ASCII numeric Data Separator 1 T 59 Field tokens used in Form Information Q messages v NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description FN Form Name Held tokens used in Form nformation descriptions See field token descriptions under Form Request above Form nformation example Request lt STX gt Q lt FS gt FNEDITSCR lt FS gt FNSIGSCR lt ETX gt lt LRC gt FPE responds with information for all forms requested Response lt STX gt QEDITSCR lt SP gt 1234052301143101 SIGSCR lt SP gt 9999052401122442 lt ETX gt lt LRC gt 60 FPE Interface Specification File Request R Received from FPE These messages are sent by FPE when processing the packinglist file After a file named packinglist is loaded into the terminal FPE sequentially reads names and lengths of the files containing screen forms for the terminal It checks terminals memory and if it does not find a file with the same name and length sends File Request R to ECR to load the file File Load P File n Load Terminal packinglist loaded v NOTE This message is the same from all types of terminals Request
53. all types of terminals identically Field Description Length Value Token Field ID 2 SP Parameter X axis resolution 4 ASCII numeric Max 1024 zero filled left Parameter Y axis resolution 4 ASCII numeric Max 1024 zero filled left Parameter X axis extended line limit 1 ASCII numeric 0 9 Parameter Y axis extended line limit 1 ASCII numeric 0 9 Example lt FS gt SP1024064011 SS Signature capture message enabled flag Sets Signature capture message enabled flag On or Off Optional By default message enabled flag is On v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 SS Parameter Message enabled 1 Y or N Yes No Example lt FS gt SSN 28 FPE Interface Specification ST Signature capture time out Sets Pen up time out what means the time interval in seconds between the moment when the pen is up and the response message sending If signature buffer is completely filled by signature data Pen up time out is ignored and response message is sending immediately Pen up time out 0 means that terminal responds on Enter button is pressing v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 ST Parameter Pen up time out value in 1 ASCII numeric 0 9 seconds 0 n
54. ameters see below If Flag parameter is application will ignore value specified in the Item ID parameter and will remove all items of the specified control uniquely identified by Control Type ID and Control ID v NOTE FPE32 3 0 010 supports only one type of the controls list of scrolling receipts Control Type ID is 01 This token is processed only on Optimum PIN pads Refer to Manipulating the scrolling receipts list control items section for more information Field Description Length Value Token Field ID 2 IR Parameter Control Type ID 2 ASCII numeric 01 Scrolling receipts list control Parameter Control ID 3 ASCII numeric Parameter Item ID 3 ASCII numeric 001 002 etc Parameter Flag 0 1 ASCII char delete all the items from a control v NOTE FPE does not pose any limitations on the number of IR tokens allowed per Update Display message Example o To remove items with 001 and 002 Ids from the control with type 01 and ID 002 FS IR01002001 FS IR01002002 o To remove all items from the control with type 01 and ID 002 Please note value specified in Item ID will be ignored by FPE lt FS gt IRO1002000 IU Update an item in a control Used to update an item in a control The control is uniquely identified by control type and ID These values are specified in corresponding parameters see below 50 FPE Inte
55. any device connected to the terminal This request is processed on all types of terminals Open port EC Terminal External R device 8 FPE Interface Specification Write data av Rsp B ACK l Terminal External device li Request Data i Close port ECR Rq B Terminal 7 The following terminal s ports can be used with the Port command as a source and destination ports Platform Active ECR Port External device port PD8700 RS232 1 Ethernet or USB 1 RS232 1 2 RS232 2 PD4700 Ethernet or USB 1 RS232 1 PD4750 Ethernet or USB 1 RS232 1 v NOTE The same port cannot be used simultaneously as ECR port and an external device port PD87xx terminals equipped with Contactless card reader use the COM2 port internally to communicate with the Contactless card reader so the COM2 port is not available for port command B in this case The following picture shows possible port usage variants for PD87xx terminals PD87xx ECR Terminal External Contactless Card PD87xx External USB or Terminal w o C cow 77 Ethernet Contactless Card Reader External device 2 PD87xx Terminal External with cow gt PIN pad Contactless Card Supported on PD8700 also called PD87xx in this document starting from release 3 0 010 Request Field Description Length 1 Value Message Type Message ID 1 B Parameters Field tokens varies ASCII
56. arity 2 stop 5 7O2 7 data Odd parity 2 stop 6 7E2 7 data Even parity 2 stop 7 81 8 data No parity 1 stop 8 801 8 data Odd parity 1 stop 9 8E1 8 data Even parity 1 stop A 8N2 8 data No parity 2 stop B 8C2 8 data Odd parity 2 stop C 8E2 8 data Even parity 2 stop Example lt FS gt CP7 v NOTE Must be sent when Action is Open DT Data to send to or received from the port Field Description Length 1 Value Token Field ID 2 DT Parameter Data length 3 ASCII Numeric 001 925 FS Field separator 1 FS Parameter Data 1 925 Binary values 0 255 Example lt FS gt DT006 lt FS gt lt STX gt 123 lt ETX gt lt LRC gt Field tokens sent by FPE in response to Port command B messages v NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description PN Port number DT Data to send to or received from the port Port command response field token descriptions See descriptions for field tokens in Port command request messages v NOTE See Error Response X for error messages in response to Port command messages Port command example Request Open port 1 at 9600 8N1 lt STX gt B lt FS gt PN1 lt FS gt ACO lt FS gt BR5 lt FS gt CP7 FPE does not respond other than the protocol ACK unless there is an error opening the port or the port is already in use as the EC
57. ase balance prompting is on for this tender transition to PurchaseBalance Else if PIN encryption is on for this tender transition to GetPIN Else if cash back Yes No prompting is on for this tender transition to CBYesNo Else if cash back is on for this tender transition to the state to get the configured cash back type CBClerk CBKeyboard or CBButtons Else if frequent shopper is on for this tender transition to FreqShopper Else transition to Wait Cancel Transition to IDLE Bad card swipe Display BADSWIPE form and stay in this state State Event Action PurchaseBalanc lnit Display the purchase balance form for the current e tender Button F1 Purchase or F2 Balance If PIN encryption is on for this tender transition to GetPIN Else if frequent shopper is on for this tender transition to FregShopper Else transition to Wait Cancel Transition to IDLE State Event Action CBYesNo Init Display the cash back yes no form for the current tender Button F1 Yes If cash back is on for this tender transition to the state to get the configured cash back type CBClerk CBkeyboard or CBButtons F2 No If frequent shopper is on for this tender transition to FreqShopper Else transition to Wait Cancel Transition to IDLE State Event Action CBButtons Init Display the cash back form for the current tender Button F1 through F9 If frequent shopper is on for this tender transition to FreqShopper Else transition to Wait
58. ay GETTENDFRM Tender selection EBT Transition to SelectEBT Default If purchase balance prompting is on for this tender transition to PurchaseBalance Else if PIN encryption is on for this tender transition to GetPIN Else if cash back is on for this tender transition to the state to get the configured cash back type CBClerk CBKeyboard or CBButtons Else if frequent shopper is on for this tender transition to FregShopper Else transition to Wait Cancel Transition to IDLE State Event Action SelectEBT Init Display the swipe form for the current tender Tender selection If a card was swiped prior to entering this state If purchase balance prompting is on for this tender transition to PurchaseBalance Else if PIN encryption is on for this tender transition to GetPIN Else if cash back Yes No prompting is on for this tender transition to CBYesNo Else if cash back is on for this tender transition to the state to get the configured cash back type CBClerk CBKeyboard or CBButtons Else if frequent shopper is on for this tender transition to FreqShopper Else transition to Wait If no card has been swiped Transition to GetMSR Cancel Transition to IDLE 89 90 FPE Interface Specification State Event Action GetMSR Init Display the swipe form for the current tender Card swipe If purch
59. ay prompt fields or not to have them at all Pole display prompt fields formats and positions are set on the form development stage and cannot be changed by FPE application If Form request V contains only Cn tokens it may not have FN token In this case Pole display prompt text lines will be put on currently displayed form 35 Bn tokens where n 9 set text to Global button captions Form may contain up to 10 Global buttons or not to have them at all Global buttons sizes colors and positions are set on the form development stage and cannot be changed by FPE application DL token allows displaying a specific format text line to the specific position of the screen This position and format does not depend on displayed form outlook En tokens where 0 n lt 9 set text into edit fields Form may contain up to 10 edit fields or not to have them at all Edit fields sizes positions and some other parameters are set on the form development stage and cannot be changed by FPE application En token just put specified text into corresponding edit field without any check so you may put alpha data into numeric field EF token allows setting specific data entry formats date phone number and SSN for numeric entry fields Getting Track Data To receive track data from magnetic or EFID card Form Request V must contain FN and TK tokens To receive information about track data source TS token has to be add
60. e ETX All messages implemented with ACK NAK handshaking TCP IP lt FP gt lt Message Length Message Type gt lt Data gt The FP at the start of the message is used to identify a FPE message to the host software The Message Length field is Two Hex digits LSB containing the total length of the message type and data fields FPE will respond to TCP IP messages that do not have a response with a Z TCPIP ACK FPE will also send TCPIP Keep Alive message Y periodically to detect the network failure if sitting idle for more than a minute Terminal will be responsible for the Keep Alive message and Server PC application should never send this message to the terminal Requests supported by terminal types Request Tokens PD87xx PD4700 PD4750 A Return to Idle A All Yes Yes Yes b Beeper control b s Yes Yes Yes B Port command B All Yes Yes Yes C MAC Data All No No No D Directory of Files D Yes Yes Yes E Configure Tender E All Yes Yes Yes F Version Information F E Yes Yes Yes F Version Information F MV RF Yes Yes Yes Global Parameters G FA KD PS SW Yes Yes Yes G SP Screen Protector SP Yes No Yes H Split Message H Yes Yes Yes 2 FPE Interface Specification
61. e item was successfully return code in II token is 0 success inserted into the list assigned item ID is 003 lt STX gt M lt FS gt 1I1I010020003 lt ETX gt lt LRC gt Scenatio3 insert an item with text Item4 text before item with ID 004 to a scrolling receipts control with ID 001 Scrolling receipts control with ID 001 has items with Ids 001 003 002 Request lt STX gt M lt FS gt FNRECEIPT lt FS gt II01001004BItem4 text lt ETX gt lt LRC gt FPE responds with results of the insert operation execution Response Item insert operation failed due to Item ID not found error return code in II token is 1 Item ID not found Item ID is not available in the response lt STX gt M lt FS gt 1I1I010011 lt ETX gt lt LRC gt o Update an item or set of items in one request in one or several controls Request M with IU tokens Optimum ECR Cae PIN pad Terminal Response M with IU tokens Figure 4 Update an item Scenatio1 Scrolling receipts list with ID 001 has items with Ids 001 with text Item1 text 002 with text Ttem2 text and 003 with Item3 text Update items with ID 001 and 002 in the scrolling receipts list Item 001 should appear crossed like Itemd text item 002 should be crossed and the text should be NEVV Hemz2 text Reguest
62. ecification Hardware Reset It reboots a terminal v NOTE This request is processed on all types of terminals identically Request Field Description Length 1 Value Message Type Message ID 1 Response None Hardware reset example Request lt STX gt lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Response None Error response X FPE sends this message when an error is encountered while processing a command from the ECR v NOTE This request is processed on all types of terminals identically Response Field Descriptio Length Value n Message Message 1 X Type ID Data Error type 1 ASCII C Input cancelled D Device error E Port open error F File system error L Port close failed M MSR device failed could not read card N Port in use by ECR Can t open O Form not found error P PIN pad device failed encryption failed T Frequent shopper MSR error could not read card W Port write error Error response example Request lt STX gt PY500IMAGE DAT lt 491 bytes of file data ETX LRC FPE was unable to store the file and responds with a File System Error F response Response lt STX gt XF lt ETX gt lt LRC gt TCPIP ACK Z Sent by FPE when connected by TCP IP in response to a message that has no other response such as the Return
63. eck box number 1 ASCII numeric 0 9 Data Check box state 1 ASCII numeric 1 checked 0 not checked Example lt FS gt c01 Example lt FS gt C1 Example lt FS gt C20 np v NOTE Check box numbers correlate to the order of the check box fields on the form F Edit field data Contains edit field data One per each non empty edit field on the screen Field Description Length Value Token Field ID 1 F Parameter Field number 1 ASCII numeric 0 9 Data Field data 1 99 ASCII and ASCII numeric Example lt FS gt F123 99 Example lt FS gt F2123456 Example lt FS gt F3Mary Smith NOTET Field numbers correlate to the order of the fields on the form Data entered in the first edit field on the form will be returned in F1 data entered in the second edit field will be return in F2 etc The type of data returned is determined by the field type numeric alpha amount etc 2 Master session and edit field data is returned in PD and KS fields KS DUKPT key serial number Response on PIN entry Field Description Length Value Token Field ID 2 KS Data Key serial number 20 ASCII numeric Example lt FS gt KS10000004598000000035 31 32 FPE Interface Specification PD PIN block data Response on PIN entry Field Description Length Value Token Field ID 2 PD Data PIN block 16 ASCII hex Exa
64. ed Request message may have any other tokens allowed for V request but they will not affect on the content of the response message Only one V response containing track data may be received per one Form Request V Examples 1 Request lt STX gt V lt FS gt FNSWIPEFRM lt FS gt TK4 lt FS gt TS lt ETX gt lt LRC gt FPE responds with track data source and track data of swiped card Response lt STX gt V lt FS gt TSO lt FS gt TKl lt track 1 data gt lt FS gt TK2 lt track 2 data gt lt ETX gt lt LRC gt 2 Request lt STX gt V lt FS gt FNSWIPEFRM lt FS gt TK2 lt ETX gt lt LRC gt FPE responds with data of requested track from swiped card Response lt STX gt V lt FS gt TK2 lt track 2 data gt lt ETX gt lt LRC gt Getting Signature Data Form Request V to receive signature image must contain FN token It is the only required token Screen for the signature entry must have special Signature capture entry field FN token sets a name of the screen for the signature entry This screen must have special Signature capture entry field It is the only required token ST token sets Pen up time out what means the time interval in seconds between the moment when the pen is up and the response message sending If signature buffer is completely filled by signature data Pen up time out is ignored and response message is sending immediately Pen up time out 0 means that terminal responds on Ente
65. eld tokens in response to Poll Customer Data J messages descriptions 42 a velare eei MEE TEE 42 vi FPE Technical Specifications PD PIN block data c EE diede ca EE OO ie P ox 42 KS DUKPT key serial number sesse ee se ee se ee GR AA Ge AA Re Ge nnne nnne nnns nnns 42 LI Tender type ueniet de ee edit d dd deed ed ie Rode d iid 42 FS Current customer activated state 43 GB GaskrbackamounE ie ES Reto eee eee dentin 43 F Frequent shopper track data iese ees se ee ee Re ee ee Re ee ee ee E Re ee ee ed AR ee ee 43 ES Track data soutrce ite eat e Ala ade teta 43 XP XM XT See Error response X description sees ee se ee ee ee ee AA ee AA ee ee ke ee 43 Disable Enable Keyboard toggle K sees RR EE EER RE EE EE RR RR RR KERE EE ER RR KAR RR RE EE Re Gee 45 aerem 45 FROSPONSE ER tiioe eda aiii EE i x op d ML i M d 45 File Delete n dana a a Ra d nin 45 Request rae RR aa RE RE 45 RESPONS RR US 45 Update Display cra Ra ada i i ick wa s da FR 47 FReq est RE OE doe ded RE N N N bsn 47 Response to M request with C1 C30 DL TF tokens 48 Response to M request having Il IU and IR tokens iese 48 Field tokens used in Update Display M messages ii see ee ed Ge AA Ge ee n s ee ee 48 Il Insert an item i
66. escription Length Value Message Type Message ID 1 Parameters Field tokens Varies ASCII Response None Field tokens used in Global Parameters G messages v NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description FA Idle state first action swipe tender or either KD Key Down POS Event PS Communications packet size SP Screen protector SW MSR POS Event Field tokens used in Global Parameters descriptions PS Communications packet size Field Description Length Value Token Field ID 2 PS Parameter Packet size 3 ASCII Numeric zero filled left 009 975 FA Idle state first action Field Description Length Value Token Field ID 2 FA Parameter First action 1 S wipe T ender or E ither KD Key Down POS Event Field Description Length Value Token Field ID 2 KD 37 38 FPE Interface Specification Parameter Event on off 1 Yes SW MSR POS Event Field Description Length Value Token Field ID 2 SW Parameter Event on off 1 Yes SP Screen Protector Field Description Length Value Token Field ID 2 SP Parameter Notify ECR 1 Y Yes N No on off Parameter ECR Notification 2 Number of days ASCII Numeric interval Parameter Text to display Varies Reminder message ASCII Y NOTE SP token is
67. etup screen Field Description Length Value Token Field ID 2 QP Example lt FS gt QP PU Set PowerUp parameter This parameter enables disables PowerUp message sending Field Description Length Value Token Field ID 2 PU Parameter Enable or disable Y N 1 Y or N 73 74 FPE Interface Specification PowerUp message Example lt FS gt PUY QU Query PowerUp parameter This parameter identifies whether PowerUp message sending is enabled or disabled Field Description Length Value Token Field ID 2 QU Example lt FS gt QU PHTMS Set HTMS connection configuration Field Description Length Value Token Field ID 5 PHTMS Parameter Enable or disable Y N 1 Y or N HTMS connection Parameter IP address of HTMS varies ASCII Parameter Port of HTMS varies ASCII numeric v NOTE Field data parameters are separated by 7 Example lt FS gt PHTMSY 192 168 0 1 5112 QHTMS Query HTMS connection configuration Field Description Length Value Token Field ID 5 QHTMS Example lt FS gt QHTMS Contrast Setup Configure Contrast Field Description Length Value Token Field ID 2 CC FS Field Separator 1 FS 0x1C Token Field ID Timeout 2 TO Data Timeout period in 1 3 ASCII Numeric seconds 999 to wait for ever for user inp
68. ield tokens sent by FPE in response to Form Request V messages 30 Field tokens sent by FPE in response to Form Requests descriptions 30 BE Button selected eee e e en teet uendere i SEED eeu tg 30 C Check box checked state esses entrent nennen nnne 31 Fe Edit tleld data i metet ter ott decet tb icon tute EI Le ee s 31 KS DUKPT key serial 2 ed se ek ee GR AA Ge Ak AR RA AG AA Ge RR ee AA ee ee 31 BD PIN bloek data 1 err dc eerte b rb idea 32 R Radio button selection ese se ee ee i YR ee AR Re ee ARAR YR nnne nnn nennen nenas 32 SB Signature data specified size se ee Ge AA Ge AR GR AA Ge Re Ge AA ee ee ee 32 BDsSignatute data ba eb ett Pe a oe bed dents 32 STSSMSR tFack dataset waite Ge ED ee ge ge a Ge cid Ee ee ee ve ee 33 To Track data Ee fete eet eb err fd ettet e de denda 33 XP XM See Error response X 33 FN el it EE EE 33 IC ICC Card or Smart Card insertion and or sesse de ee sss 34 Form message examples ee Ee e ee eene ee Ee ee ee ee RE an enn nensis 34 Displaying the Form tinted a e as ee RA ener entren AR aaa AA nnns enne seen sn aa aN ee eek 34 Getting Track Bata eite tet rd e Ree fed teet ea Idi pecie
69. inal Type example Request lt STX gt T lt ETX gt lt LRC gt FPE responds with the terminal type Response lt STX gt T6 lt ETX gt lt LRC gt 63 Version nformation F Get FPE OS and FLASH version information ECR Request F Terminal v NOTE This reguest is processed on all types of terminals Response s format depends on terminal type Reduest Field Description Length Value Message Type Message ID 1 F Parameters Field tokens varies ASCII Field tokens used in Version Information F messages NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description MV Minor Version FPE32 only RF RFID Firmvvare version FPE32 only Version Information field token descriptions MV Minor Version PDxxxx only Field Description Length Value Token Field ID 2 MV Parameter Event on off 1 Y es RF RFID Firmware version PDxxx only Field Description Length Value Token Field ID 2 RF Parameter Event on off 1 Yes 64 FPE Interface Specification Response PDxxxx terminals Field Description Length Value Message Type Message ID 1 F Data FPE application version 4 ASCII numeric Data Xilinx version 0 20 ASCII FS Field separator 1 FS 0x1C Data OS
70. ion BY Purchase balance yes no prompting on or off Field Description Length Value Token Field ID 2 BY Parameter Purchase Balance Yes No prompting 1 Y or N Example FS BYY B1 Purchase balance yes no prompt one Field Description Length Value Token Field ID 2 B1 Parameter Purchase Balance Yes No prompt varies ASCII one Example lt FS gt B1Please Select B2 Purchase balance yes no prompt two Field Description Length Value Token Field ID 2 B2 Parameter Purchase Balance Yes No prompt two varies ASCII Example lt FS gt B2Purchase or Balance BF Purchase balance yes no form name Field Description Length Value Token Field ID 2 BF Parameter Purchase Balance Yes No form name 1 11 ASCII upper case characters Example lt FS gt BFPBYNFRM S1 Swipe prompt one Field Description Length Value Token Field ID 2 S1 Parameter Swipe prompt one varies ASCII Example lt FS gt S1 Please Swipe Your S2 Swipe prompt two Field Description Length Value Token Field ID 2 S1 Parameter Swipe prompt two varies ASCII Example lt FS gt S2Credit Card SF Swipe form name Field Description Length Value Token Field ID 2 SF Parameter Swipe form name 1 11 ASCII upper case characters Example lt FS gt SFSWIPEFRM 21 FS
71. ion PW Current password PU Current PowerUp parameter value PHTMS Current HTMS connection configuration CC Contrast Setup Configure Contrast CL Touch screen calibration Configure Calibration TL Touch screen calibration Test Test Calibration TD DUKPT Encryption Test DUKPT CP ECR port configuration Configure Port PW Current password Response to the Setup Parameters p request with token QW will contain this field token Field Description Length Value Token Field ID 2 PW Data Password 0 10 ASCII Example lt FS gt PWHYPERCOM PU Current PowerUp parameter value Response to the Setup Parameters p request with token OU will contain this field token Field Description Length Value Token Field ID 2 PU Data Value of PowerUp 1 Y PowerUp message enabled parameter or N PowerUp message disabled PHTMS Current HTMS connection configuration Response to the Setup Parameters p request with token QHTMS will contain this field token Field Description Length Value Token Field ID 5 PHTMS Data HTMS connection 1 Y enabled or N disabled Enabled or disabled Y N Data IP address of HTMS varies ASCII Data Port of HTMS varies ASCII numeric v NOTE Field data is separated by 77 Example lt FS gt PHTMSY 192 168 0 1 5112 CC Contrast Setup Configure Contrast
72. k read error POS Event command field token descriptions KD Keyboard button Field Description Length Value Token Field ID 2 KD Parameter Key code 1 ASCII character code Example lt FS gt D1 KB Form button Field Description Length Value Token Field ID 2 KB Parameter Key code 1 ASCII button code Example FS KB XM Track read error Field Description Length Value Token Field ID 2 XM Example lt FS gt XM 71 v NOTE In FPE earlier than v3 0 020 this message is sent after 39 bad card swipes Track Reads T Track data Field Description Length Value Token Field ID 1 Parameter Track ID 1 ASCII numeric 1 2 8 4 Data Track data Track 1 79 ASCII and ASCII numeric Track 2 40 Track 3 100 Track 4 100 Example FS T1B4012000000001 HYPERCOM TEST CARD 050201234567890 Example lt FS gt T24012000000001 050201234567890 Example lt FS gt T3HYPERCOM TEST CARD 1234567890 Response Respond to FPE with lt ACK gt Key notification example Request FPE requests lt STX gt lt FS gt D2 lt ETX gt lt LRC gt Response ECR responds ECR does not respond other than the protocol ACK TS Track data source Track data source if requested by TS token of V request Field Description Length Value Token Field ID 2 T
73. lt FS gt CL lt FS gt TO lt ETX gt lt LRC gt TL Touch screen calibration test Field Description Length Value Token Field ID 2 TL FS Field Separator 1 FS 0x1C Data Return code 1 ASCII chars T Success Calibration test passed F Failure Calibration test failed Example touch screen calibration test response when operation is successful lt STX gt p lt FS gt TL lt FS gt T lt ETX gt lt LRC gt TL Touch screen calibration test timeout Field Description Length Value Token Field ID 2 TL FS Field Separator 1 FS 0x1C Token Timeout 2 TO Example timeout response lt STX gt p lt FS gt TL lt FS gt TO lt ETX gt lt LRC gt TD DUKPT Encryption Field Description Length Value Token Field ID 2 TD FS Field Separator 1 FS 0x1C Token Field ID Pin Data 2 PD Data Pin Block 16 ASCII FS Field Separator 1 FS 0x1C Token Field ID KSN 2 KS parameter Data KSN 20 ASCII Example response to the DUKPT encryption test request lt STX gt p lt FS gt TD lt FS gt PD1234567890ABCDEF lt FSsKS 1234567890ABCDEF1234 lt ETX gt lt LRC gt Example Encryption Failed Response See Error response X description for details lt STX gt XP lt ETX gt lt LRC gt TD DUKPT Encryption timeout Field Description Length Value Token Field ID 2 TD
74. mple FS PD1BCF5FDElB8FACOA R Radio button selection Contains information about Radio button selection One per each radio button group on the Screen Field Description Length Value Token Field ID 1 R Parameter Group number 1 ASCII numeric 0 9 Parameter Group index 1 ASCII numeric 0 9 Example lt FS gt R11 v NOTE The radio button returned is the one in its group that was selected when the form completed SB Signature data specified size Entered signature image if buffer size was specified by SB token of V request Field Description Length Value Token Field ID 2 SB Data Size of the entered 1 5 ASCII numeric signature in bytes Data Signature data 1 99999 Binary data can contain NULLS and other control characters Example FS SB00011 11 bytes of signature data SD Signature data Entered signature image if buffer size was not specified by SB token of V request Field Description Length Value Token Field ID 2 SD Data Data length 3 ASCII numeric Data Signature data 1 500 Binary data can contain NULLs and other control characters Example lt FS gt SD087 lt 87 bytes of signature data MSR track data Data received from one track of MSR or RFID card Field Description Length Value Token Field ID 1 E Parameter Track ID 1 ASCII numeric 1 2 S Data Track data
75. n Length Value Token Field ID 1 F Parameter Track ID 1 ASCII numeric 1 2 3 Data Track data Track 1 79 ASCII and ASCII numeric Track 2 40 Track 3 100 Example lt FS gt F1B4012000000001 HYPERCOM TEST CARD 050201234567890 Example lt FS gt F24012000000001 050201234567890 Example lt FS gt F3HYPERCOM TEST CARD 1234567890 TS Track data source Field Description Length Value Token Field ID 2 TS Data Track data source 1 0 TRACK READER 1 RDIF EXPRESS PAY 2 RFID PAY PASS 3 RFID VISA WAVE 4 RFID UNKNOWN APP Example lt FS gt TS1 XP XM XT See Error response X description 44 FPE Interface Specification Poll customer data example Request lt STX gt J lt ETX gt lt LRC gt FPE responds with any data entered by the customer Response lt STX gt J lt FS gt TTAP lt FS gt FSA lt FS gt T1B4012000000001 HYPERCOM TEST CARD 050201234567890 lt FS gt T24012000000001 050201234567890 lt FS gt CBS 5 00 lt FS gt F224000000000000001 050201234567890 lt FS gt TS1 lt ETX gt lt LRC gt 45 Disable Enable Keyboard Toggle K v NOTE This token is processed on ICE terminals and may not apply to Symbol payment Toggle the keyboard on and off terminals Request Field Description Length 1 Value Message Type Message ID 1 K Response None Disable Enable Keyboard toggle example Reque
76. nd the application needs to be configured by sending Configure Tender E messages for any tender types needed One message is sent to FPE for each tender type desired The global parameters G message should be sent to set the desired first action the action that will cause an exit from the IDLE state tender selection or swipe card After configuration send the return to idle A message to start customer activation If the optional Idle Form Name FN token is not included in this message FPE will display IDLEFRM Use the Poll Customer Data J message to determine which customer activated state FPE is currently preocessing and for collecting any data entered by the customer At any point the host application ECR may interrupt customer activation and take over driving the customer through data entry To do this just send Form Request V messages and process the response messages If first action in the customer activation is card swipe or either and user uses the RFID card the terminal skips the tender selection screen automatically make the transaction and credit Customer activated state machine definition State Event Action IDLE Init Display IDLEFRM or form specified in A message Swipe card Transition to GetTender Tender selection EBT selected Transition to SelectEBT Any other tender type Transition to GetMSR State Event Action GetTender Init Displ
77. nto a control esse ee se ee EE Ee ee Re e Re de ee ee atai 48 IR Remove an item from a control l l se ee AR GR AA Ge AA enne 49 IU Update an item in a control sesse se ee Ee Ee ee Re Ee nnns 49 Field tokens sent by FPE in response to Update Display M messages 50 II Results of an item insert into a control 50 IR Results of an item remove from a control 52 IU Results of an item update in the 1 se ee AA Ge AA ee RA ee ee 52 Update Display example venrei 54 ie ce ee nte eee d stet en da Pe e ed Ee 53 Manipulating the scrolling receipts list control items ies ee ee ee ee Re ee ee Re ee ee ee 53 Clear All Display Lines N RS ee Al va EER cp annee Ede 57 BAZ S 0707000 000000 i ae ee 57 giam a 57 File Load eS 57 acere THEE 57 latin 58 Fori Infomatlon Qiu op diio DIE uineis 58 EIE 58 RESPONSE EIE ER Ee aaa Ra a ee dale le 58 Field tokens used in Form Information Q messages 59 File H quest Hoo Rek Nee SANE CHF HERR AREE S UI NAR VANS dee ie 60 aere Ert 60 Fesponse a sen decals p oca ip p IS MU SER US 60 Terminal Status 8 soin pei EE eat aes ees nn ben 61 FROGUOS ts x 61 nile Mr EC VE 61 Terminal T i sauna aaa Seca din D ie dus ed ATE a CU 62 Request eint de 000 dec 000000 62 FIeSpOLS accedit a ER eee
78. nty information technical assistance or problems with the equipment contact the regional Symbol Global Customer Interaction Center in your area by visiting www symbol com contactsupport Before calling have the model number serial number and several bar code symbols at hand Call the Global Customer Interaction Center from a phone near the scanning equipment so that the service person can try to troubleshoot the problem If the equipment is found to be working properly and the problem is reading bar codes the Support Center will request samples of the bar codes for analysis at our plant If the problem cannot be solved over the phone it may be necessary to return the equipment for servicing If that is necessary the Global Customer Interaction Center will provide specific directions v NOTE Symbol Technologies is not responsible for any damages incurred during shipment if the approved shipping container is not used Shipping the units improperly can possibly void the warranty If the original shipping container was not kept contact Symbol to have another sent If the Symbol product was purchased from a Symbol Business Partner contact that Business Partner for service SPECIFICATIONS Communication Parameters ASYNC 19200 or 9600 Baud No Parity 1 Stop Bit 8 Data Bits Protocol ASYNC lt STX gt lt Message Type gt lt Data gt lt ETX gt lt LRC gt The LRC is an XOR of each character of Message Type Data and th
79. o time out Example lt FS gt ST3 SU Signature capture uuencode flag Sets Signature capture uuencode flag On or Off If flag is On signature data containing in SD or SB token of response message should be uuencoded Default value of Signature capture uuencode flag is Off v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 SU Parameter Signature Uuencode Yes No 1 Y or N Example FS SUY v NOTE Uuencode is an algorithm which allows transmitting binary data over transmission mediums that do not support other than simple ASCII data Uuencode repeatedly takes in a group of three bytes adding trailing zeros if there are less than three bytes left These 24 bits are split into four groups of six which are treated as numbers between 0 and 63 Decimal 32 is added to each number and they are output as ASCII characters which will lie in the range 32 space to 32463 95 underscore As the result each three input binary data are converted into four ASCII characters Uuencode flag defaults to No TF Text format Alignment Aligns text in pole display lines global prompts and edit fields Optional Default alignment for pole display and global prompts Left for edit fields Right v NOTE This token is processed on all types of terminals identically Field Descrip
80. okens sent by FPE in response to UPOS Statistics messages NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description RT Retrieve Statistics RS Reset Statistics Field tokens sent by FPE in response to UPOS Statistics descriptions RT Retrieve Statistics Field Description Length Value Token Field ID 2 RT Data Return code 1 ASCII numeric see table below for details Return code Description 0 Success XML format file with statistics info successfully created on the PIN pad T Failure Failed to create XML format file with statistics on the PIN pad Example lt FS gt RT1 RS Reset Statistics Field Description Length 1 Value Token Field ID 2 RS Data Return code 1 ASCII numeric 0 success 86 FPE Interface Specification Example lt FS gt RS1 File download d This message should be used to load data files from the device onto the ECR or PC Request Field Description Length Value Message Type Message ID 1 di Parameters Field tokens Varies ASCII Response Field Description Length 1 Value Message Type Message ID 1 d Data Field tokens varies ASCII 87 Field tokens used in File download d message NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token
81. one Y2 Cash back Yes No prompt two YF Cash back Yes No form name 1 11 characters ET Encryption type N None M Master Session D DUKPT M Master key number to use for master session PIN encryption WK Working key for master session PIN encryption P1 PIN prompt one P2 PIN prompt two PF PIN form name 1 11 characters BY Purchase Balance Yes No prompting on or off Y or N B1 Purchase Balance Yes No prompt one B2 Purchase Balance Yes No prompt two BF Purchase Balance Yes No form name 1 11 characters 51 Swipe prompt one S2 Swipe prompt two SF Swipe form name 1 11 characters FS Frequent shopper Yes No v NOTE Tender type default values are Cash back type N Cash back Yes No prompting N Encryption type N Purchase Balance yes No prompting N all prompts and form names Frequent shopper N If used the RP token should be sent as the first field token after token TT Field tokens used in Configure Tender descriptions TT Tender type Field Description Length Value Token Field ID 2 TT Parameter Tender type code see Key Codes 1 ASCII table Example lt FS gt TTA v NOTE This token must be the first token in the message RP Reset parameters Field Description Length Value Token Field ID 2 RP Parameter None Example lt FS gt RP NOTE If used the RP token should be sent as the first field token after token TT
82. ontrast Setup Configure Contrast essen 74 CL Touch screen calibration Configure Calibration 75 TL Touch screen calibration Test Test Calibration 75 TD DUKPT Encryption Test DUKPT ee ee Re Ge AA Ge AA Re Ge AA Ge ee ee 76 CP ECR port ee ee ee se de AR ee AA Ge AA eee RA AR ee ee AA ee innen 76 Vil viii FPE Technical Specifications pied EE RE ER cies 77 Field tokens used in Setup Parameters p 5 2 ee ee AA Ge ee Ge AA ee ee ge ee 77 PW Current password se ee AA Ge AR Ge AA Re AA AA Ge ee ee isis ee ee ee 77 PU Current PowerUp parameter value 5 de ee ee ee ee ee ee ee ee ee Ge ee ee Ge ee ee ee ee 77 PHTMS Current HTMS connection configuration 2 ee ee ee ee ee ee ee ee ee ke ee AA ee ee 79 CC Contrast Setup Configure Contrast ee ee ee Ge AA Ge AA ee RA ee ee ee 79 GE s Contrast Setup timed t Ee eere ee eer eg 79 CL Touch screen calibration riirii se ee AA Ge eee RA eene entente nnne 79 CL Touch screen calibration ee ee AR s s Ge AR Ge AA Ge ee ee 80 TL Touch screen calibration test se ee e a AA ee ee nenne 80 TL Touch screen calibration test timeOUut ee ee RA AA AA ee RA ee ee ee 80 LD DUKP FEncGryption t sen irent er teet ean ete 80
83. processed on PD8700 and PD4750 terminals only Global Parameters examples Request lt STX gt G lt FS gt PS325 lt FS gt FAS lt ETX gt lt LRC gt Request lt STX gt G lt FS gt KDY lt FS gt SWY lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Response None Split Message H Sent by FPE when the response to a command would exceed the packet size configured with the Global Parameters G message This message is the same from all types of terminals ECR Terminal 39 Response Field Description Length Value Message Type Message ID 1 H Data More Data Flag 1 Y or N Data Data length 3 001 965 ASCII numeric Data Data 1 965 Binary values 255 Split Message example Request lt STX gt V lt FS gt FNSIGSCRE IEN lt FS gt ST3 lt FS gt SP1024064011 lt ETX gt lt LRC gt The response to this Form Request contains signature capture data making the message length longer than the communications packet size 200 configured with the Global Parameters message FPE splits the Form Request response into as many Split Messages as required to transmit the entire response The ECR is responsible for re assembling the response parts The re assembled message will look exactly like the response if it had not been split except the lt STX gt lt ETX gt and lt LRC gt will be striped Response lt STX gt HY20
84. r No YF Cash back Yes No form name Field Description Length Value Token Field ID 2 YF Parameter Cash back Yes No form name 1 11 ASCII upper case characters Example FS YFCBYNFRM ET Encryption type Field Description Length Value Token Field ID 2 ET Parameter Encryption type 1 N None M MS D DUKPT Example lt FS gt ETD M Master key to use for master session PIN encryption Field Description Length Value Token Field ID 1 M Parameter Master key number to use for MS PIN 1 H 9 encryption Example lt FS gt M3 WK Working key for master session PIN encryption Field Description Length Value Token Field ID 2 WK Parameter Working key 16 ASCII Hex Example lt FS gt WK01D5FE020304ABEF P1 PIN prompt one Field Description Length Value Token Field ID 2 P1 Parameter PIN prompt one varies ASCII Example lt FS gt P1 Please Enter Your PIN P2 PIN prompt two Field Description Length Value Token Field ID 2 Po Parameter PIN prompt two varies ASCII Example lt FS gt P2And Press Enter PF PIN form name Field Description Length Value Token Field ID 2 PF Parameter PIN form name 1 11 ASCII upper case characters Example lt FS gt PFPINFRM 19 20 FPE Interface Specificat
85. r button is pressing SS token sets Signature capture message enabled flag On or Off If flag is On terminal displays warning message box always when you touch screen outside signature capture area If 36 FPE Interface Specification flag is Off terminal ignores touches outside signature capture area Signature capture message enabled flag default value is On SM token used to change signature capture default warning message text Please sign in signature box New text will stay actual until next Form request V with SM token or terminal reboot SP token sets signature capture resolution If SP token is omitted response message contains signature data in legacy format resolution 640 x 128 data buffer size 500 bytes If SP token is present response message contains signature data in enhanced format resolution lt 1024 x 1024 data buffer size 900 bytes SB token sets a size of signature capture buffer It is used to increase or to decrease default signature data buffer size In case of SB token in the Form request V message response message V should contain signature data in SB token instead of SD SU token sets Signature capture uuencode flag On or Off If flag is On signature data containing in SD or SB token of response message should be uuencoded Uuencoded data contains only ASCII characters Default value of Signature capture uuencode flag is Off Request message may
86. ree Example lt FS gt C4NThis text goes on pole display line four Example lt FS gt C5NThis text goes on pole display line five Example lt FS gt C6NThis text goes on pole display line six Example lt FS gt C7YThis text goes on pole display line seven Y NOTE If the Scroll flag is Y any text at this screen position will be scrolled up to the next Screen position DL Display Line Allows displaying a specific format text line to the specific position of the screen Optional v NOTE This token is processed on all types of terminals The length of the text which can be displayed depends on terminal type and font used Field Description Length Value Token Field ID 2 DL Parameter Row 2 OO 15 Parameter Column 2 00 42 Font dependant Parameter Display type 1 ASCII Clear EOL C Display Text D Display Text Blinking B Display Text Marquee M Parameter Delay 3 ASCII numeric ms for marquee or blinking 010 990 10 ms increments Parameter Foreground color 2 ASCII Hex 00 FF Parameter Background color 2 ASCII Hex 00 FF Parameter Font 1 ASCII numeric O 1 2 3 4 Text Text to display varies Example FS DLO112M10000FA2This text will marquee DT Screen saver timeout Sets Screen saver timeout in second Optional v NOTE This token is processed on PDxxxx terminals Field Description Length Value Token Field I
87. rface Specification v NOTE This token is processed only on Optimum PIN pads starting from version 3 0 010 See Manipulating the scrolling receipts list control items section for more information Field Description Length Value Token Field ID 2 IU Parameter Control Type ID 2 ASCII numeric 01 Scrolling receipts list control Parameter Control ID 3 ASCII numeric Parameter Item ID 3 ASCII numeric 001 002 etc Parameter Style ID 1 ASCII numeric 0 not crossed 1 crossed Text Text to display varies like Bottle of Ketchup 2 99 Comments If the length of the text field is 0 text of the item will remain as it was before the update operation This may be very helpful when only change of style crossed not crossed is required Y NOTE FPE does not pose any limitations on the number of IU tokens allowed per Update Display message Example To update style of the text for item with ID 001 to not crossed and item 002 to crossed text for the control of the type 01 and ID 001 XFSSIU010010010cFSSIU010010021 Field tokens sent by FPE in response to Update Display M messages Y NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description Results of an item insert into a control FPE 3 0 010 supports only scrolling receipts list control type supports only scrolling receipts li
88. rol Type ID 2 ASCII numeric 01 Scrolling receipts list control Parameter Control ID 3 ASCII numeric Parameter Return code 1 ASCII numeric see table below for details Return code Description 0 Success T Failure Item ID not found 53 4 Failure Invalid or not supported parameter Example First update of the item of control type 01 Scrolling receipts list control and control ID 001 succeeded second update failed lt FS gt IU010010 lt FS gt IU010011 Update Display example Request lt STX gt M lt FS gt CINThis text goes on pole display line one lt FS gt DLO112M10000FA2This text will marquee lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Response None Manipulating the scrolling receipts list control items User can use Update Display M request Il IU and IR tokens to manipulate the scrolling receipts list control items on Optimum PIN pads running FPE version 3 0 010 Example to add two items to scrolling receipts list control Control Type ID is 01 with ID 001 and two items to scrolling receipts list control Control Type ID is 01 with ID 002 STX2M FS FNRECEIPT FS 2II010010011IItem1 text FS II010010011IItem2 text FS II01002001IItem1 text FS II010020011IItem2 text lt ETX gt lt LRC gt Update Display M on Optimum PIN pad allows following operations with
89. ssage ID 1 M Parameters Field tokens Varies ASCII 48 FPE Interface Specification Response to M request with C1 C30 DL TF tokens None v NOTE Supported on all types of terminals Optimum PIN pads Response to M request having II IU and IR tokens v NOTE Supported on Optimum PIN pads only Field Description Length Value Message Type Message ID 1 M Data Field tokens varies ASCII Field tokens used in Update Display M messages NOTE Field tokens are in the format FS Field Token Data Token Description C1 Customer prompt 1 C30 Customer prompt 30 Note PDxxxx terminals utilize C1 C30 DL Display line of text TF Text format Alignment II Insert an item into a control FPE 3 0 010 supports only scrolling receipts list control type IR Remove an item from a control FPE 3 0 010 supports only scrolling receipts list control type IU Update an item in a control FPE 3 0 010 supports only scrolling receipts list control type Field tokens used in Update Display descriptions See 1 30 DL and TF field token descriptions in Form Request V section v NOTE All Customer prompt tokens can be sent with an Update Display message II Insert an item into a control Allows insertion of an item into a control before or after the specified item
90. ssages NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description IP IP Address PN Port number Set NMS IPConfig command field token descriptions IP IP address Field Description Length Value Token Field ID 2 IP Parameter IP address varies ASCII Numeric IP address stored most significant byte first PN Port number Field Description Length Value Token Field ID 2 PN Parameter Port number varies ASCII Numeric IP port number stored most significant byte first Response None Set NMS IPConfig example Request lt STX gt lt FS gt IP 1073544703 lt FS gt PN64255 lt ET X gt lt LRC gt FPE does not respond other than the protocol ACK Response None 69 70 FPE Interface Specification POS Event Received from FPE These messages are sent by FPE to notify host of button pressing or card swiping They are sent only if corresponding global parameter was set ECR Terminal v NOTE This message is the same from all types of terminals Request Field Description Length Value Message Type Message ID 1 0x60 Parameters Field tokens varies ASCII Field tokens used in POS Event messages NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description KD Keyboard button KB Form button T Track data TS Track data source TM Trac
91. st lt STX gt K lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Response None File Delete L Delete a file from the terminal s file system v NOTE This reguest is processed on all types of terminals identically Reduest Field Description Length 1 Value Message Type Message ID 1 L Parameter File name to delete 1 256 ASCII Response None 46 FPE lnterface Specification File Delete example Request lt STX gt LCONFIG SYS lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Response None 47 Update Display M Update Display M message should be used for the following purposes o Update current or put new prompts on the current form Request M Terminal Figure 1 Update prompts NOTE This request with tokens C1 C30 DL and TF is processed on all types of terminals o Manipulate insert update and remove the items of a control which is uniquely identified by control type ID and control ID Request M with II IU and IR tokens ECR Optimum PIN pad Terminal Response M with II IU and RR tokens EN Figure 2 Manipulate the items of a control Y NOTE This request with tokens II IU and IR is processed only on Optimum PIN pads Request Field Description Length 1 Value Message Type Me
92. st control type IR Results of an item remove from a control FPE 3 0 010 supports only scrolling receipts list control type IU Results of an item update in a control FPE 3 0 010 Field tokens sent by FPE in response to Update Display M messages descriptions Il Results of an item insert into a control Results of an item insert into the control if requested by II token of Update Display M request Refer to Manipulating the scrolling receipts list control items section for more information v NOTE FPE 3 0 010 supports only one control type ID which is 01 Scrolling receipts list control Field Description Length Value Token Field ID 2 r Parameter Control Type ID 2 ASCII numeric 01 Scrolling receipts list control Parameter Control ID 3 ASCII numeric Parameter Return code 1 ASCII numeric see table below for details Data Inserted Item ID 0 3 ASCII numeric 001 002 etc When insert operation failed Item D in the response will be empty 51 52 FPE lnterface Specification Return code Description 0 Success T Failure Item ID not found 2 Failure Maximum number of items excided 3 Failure Text parameter missing Example An item was successfully inserted into control of a type 01 Scrolling receipts list control and control ID 001 ID assigned to the item is 001 lt FS gt I
93. t lt LRC gt FPE does not respond other than the protocol ACK Response None File Load P Used to send data files to FPE If file is longer than maximum allowed for this request data size 500 byte a series of File Load P requests has to be send ECR Request P v NOTE This request is processed on all types of terminals identically Terminal Request Field Description Length Value Message Type Message ID 1 P Parameter More data flag 1 Y more file packets coming N final file packet Parameter Data size 3 ASCII 001 950 Parameter File name 1 256 ASCII FS Field separator 1 FS 0x1C 57 58 FPE Interface Specification Data File data 1 950 Binary values 0 255 Response None File Load example Request lt STX gt PY900IMAGE DAT lt FS gt lt first 900 bytes of file data gt lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK lt STX gt PN245IMAGE DAT lt FS gt lt last 245 bytes of file data gt lt ETX gt lt LRC gt FPE does not respond other than the protocol ACK Response None see error responses Form Information Q Get information about a form or forms from FPE Multiple FN tokens may be used ECR Request Q v NOTE This request is processed on all types of terminals identically Terminal Request Field Description Length
94. tc Request p ECR Terminal Terminal sends response message only if request has QP QU QHTMS CC CL TL TD and CP tokens v NOTE This request is processed on PDxxxx terminals only Reduest Field Description Length Value Message Type Message ID 1 p Parameters Field tokens varies ASCII Field tokens used in Setup Parameters p request NOTE Field tokens are in the format lt FS gt lt Field Token gt lt Data gt Token Description PW Set new password QP Query current password PU Set PowerUp message sending QU Query PowerUp parameter PHTMS Set HTMS connection configuration QHTMS Query HTMS connection configuration CC Contrast Setup Configure Contrast CL Touch screen calibration Configure Calibration TL Touch screen calibration Test Test Calibration TD DUKPT Encryption Test DUKPT CP ECR port configuration Configure Port Field tokens used in Setup Parameters descriptions PW Set New Password This token should be used to set Setup Screen password v NOTE If the password is empty default password MULTILANE will be used Field Description Length Value Token Field ID 2 PW Data Password 0 10 ASCII character code Example lt FS gt PWHYPERCOM QP Query current password This token should be used to request plain text value on s
95. the format FS Field Token Data Token Description RT Retrieve Statistics RS Reset Statistics Field tokens used in UPOS Statistics descriptions RT Retrieve Statistics Field Description Length Value Token Field ID 2 RT Parameter Parameter string as specified in varies ASCII chars UPOS 1 8 see note below for details 85 v NOTE This is a comma separated list of name s where an empty string means ALL statistics are to be retrieved U means all UnifiedPOS defined statistics are to be retrieved M means all manufacturer defined statistics are to be retrieved and actual 1 actual name from the XML file definitions means that the specifically defined statistic s are to be retrieved Example lt FS gt RT RS Reset Statistics Field Description Length Value Token Field ID 2 RS Parameter Parameter string as specified in UPOS varies ASCII chars 1 8 see note below for details v NOTE This is a comma separated list of name s where an empty string means ALL statistics are to be retrieved U means all UnifiedPOS defined statistics are to be retrieved M means all manufacturer defined statistics are to be retrieved and actual 1 actual name from the XML file definitions means that the specifically defined statistic s are to be retrieved Example lt FS gt RS Field t
96. the scrolling receipts list control items o Insert an item or set of items in one request into one or several controls Request M with II tokens Optimum ECR PIN pad Terminal Response M with II tokens D Figure 3 Insert an item Scenatio1 Insert two items with text Ttem1 text and Item2 text to the beginning of the scrolling receipts list control type is 01 with ID 001 Request 54 FPE lnterface Specification KSTXSMKFSSFNRECEIPTCFSSII0100100011teml text FS II010010001IItem2 text lt ETX gt lt LRC gt PE responds with results of the insert operation execution Response Two items were successfully return code in both II tokens is 0 success inserted into the list with ID equal to 001 IDs assigned to the items are 001 for Ttem1 text and 002 for Ttem2 text lt STX gt M lt FS gt I1I010010001 lt FS gt I1I010010002 lt ETX gt lt LRC gt v NOTE Update Display M response will contain same number and the sequence of the II tokens as in the request Scenatio2 insert item with text Ttem3 text after item with ID 001 to the scrolling receipts list control type is 01 with ID 002 Request lt STX gt M lt FS gt FNRECEIPT lt FS gt II01002001AItem3 text lt ETX gt lt LRC gt FPE responds with results of the insert operation execution Response On
97. tion Length Value Token Field ID 2 TF Parameter Control type 1 C pole display line P global prompt E edit field Parameter Control number 1 2 ASCII numeric 1 30 for pole display line 1 9 for global prompt 0 9 for edit field Parameter Direction 2 HJ for horizontal justification Parameter Alignment type 1 L Left C Center R Right Example FS TFPIHJC TK MSR track to read Determines which track data to send in the response message Required in request for MSR or RFID card data v NOTE This token is processed on all types of terminals identically Field Description Length Value Token Field ID 2 TK Parameter Tracks to read 1 ASCII numeric 1 2 3 4 4 All tracks Parameter JCB Tracks to read 1 Optional ASCII numeric 4 If present requests reading JIS Il data Example FSST Example FSST Example lt Fs gt 1 Example lt Fs gt T K1 K2 TK3 K4 Example lt Fs gt 1 TK44 29 30 FPE Interface Specification TS Track data source If request has TS token response message will have TS token containing track data source information v NOTE This token is processed on PDxxxx terminals Field Description Length Value Token Field ID 2 TS Example lt FS gt TS WK Working key for master session
98. tion Length Value Message Type Message ID 1 V Parameters Field tokens varies ASCII Response Field Description Length Value Message Type Message ID 1 V Data Field tokens varies ASCII Field tokens used in Form Request V messages v NOTE Field tokens are in the format FS Field Token Data Token Description AC Account number to use for PIN encryption BO Global button text O B9 Global button text 9 Token Description C1 Pole display prompt 1 C30 Pole display prompt 30 DL Display line of text DT Screen saver timeout EO Edit field text O E9 Edit field text 9 EF Edit field format ET Encryption type MS or DUKPT FN Form Name HP HyperPass Contactless Card Reader obsolete and not used any more M Master key number to use for MS PIN encryption D DUKPT key number to use for DUKPT PIN encryption Default DUKPT key number is 12 P1 Global prompt 1 P7 Global prompt 7 SB Signature capture buffer size SM Signature capture message SP Signature capture resolution SS Signature capture message enabled flag ST Signature capture time out value SU Signature capture uuencode flag TF Text format Alignment TK MSR tracks to read TS Track data source WK Working key to use for master session PIN encryption Field tokens used in Form Requests descriptions AC
99. to Idle A message The ECR should not send the next message to FPE until it receives the normal message response or this message Field Descriptio Length Value n Message Type Message 1 7 ID Request lt STX gt A lt FS gt FNIDLEFRM lt FS gt CPY lt ETX gt lt LRC gt FPE sends a TCPIP ACK in response because the command has no other response Response lt FP gt lt 0x01 gt lt 0x00 gt Z Keyboard Lock Locks or unlocks the keypad Unlock turns on all keys Lock turns off the keys specified in the key set parameter ECR Terminal v NOTE This request is processed on ICE terminals and may not apply to Symbol payment terminals Field Description Length Value Message Type Message ID 1 68 FPE Interface Specification Field Description Length Value Data Lock Unlock 1 L Lock U Unlock Data Key set 1 A All N Numeric Keyboard Lock Unlock Examples Request lt STX gt lt Keyboard_Lock gt LA lt ETX gt lt LRC gt Response lt ACK gt or lt NAK gt Set NMS IPConfig Used to set NMS address for program loads ECR Terminal v NOTE This token is processed on ICE 6K terminals and may not apply to Symbol payment terminals Request Field Description Length Value Message Type Message ID 1 A Parameters Field tokens varies ASCII Field tokens used in Set NMS IPConfig N me
100. uence of the IR tokens as in the request Scenatio2 Scrolling receipts list control with ID 002 has items with Ids 001 002 003 Remove items with ID 004 from this scrolling receipts list Request lt STX gt M lt FS gt FNRECEIPT lt FS gt IRO1002004 lt ETX gt lt LRC gt FPE responds with results of the remove operation execution Response Remove operation failed due to Item ID not found return code in both IR tokens is 1 Item ID not found lt STX gt M lt FS gt IRO10021 lt ETX gt lt LRC gt Scenatio3 Scrolling receipts list with ID 001 has items with Ids 001 002 003 Remove all the items from this scrolling receipts list Request lt STX gt M lt FS gt IRO1001000 lt ETX gt lt LRC gt FPE responds with result of the remove operation execution Response All three items were successfully return code in both IR tokens is 0 success removed from the list with ID 001 lt STX gt M lt FS gt IRO10010 lt ETX gt lt LRC gt Clear All Display Lines N Clears all displayed text lines set with the Cn and DL tokens ECR Request N v NOTE This request is processed on all types of terminals identically Terminal Request Field Description Length 1 Value Message Type Message ID 1 N Response None Clear All Display Lines example Request lt STX gt N lt ETX g
101. ut 000 for returning back the existing parameter any value 999 will be set as timeout period FS Field Separator 1 FS 0x1C Token Field ID Form Name 2 EN Data Form Name varies ASCII v NOTE If Form Name is omitted from the request then default form DSPCONTRAST will be used Example to request device contrast configuration where DSPCONTRAST is the name of the custom form screen to open for configuring contrast 60 timeout period in seconds lt STX gt p lt FS gt CC lt FS gt TO60 lt FS gt FNDSPCONTRAST lt ETX gt lt LRC gt CL Touch screen calibration Configure Calibration Field Description Length Value Token Field ID 2 CL FS Field Separator 1 FS 0x1C Token Field ID Timeout 2 TO Data Timeout period in 1 3 ASCII Numeric seconds 999 to wait for ever for user input 000 for returning back the existing parameter any value 999 will be set as timeout period FS Field Separator 1 FS 0x1C Token Field ID Form Name 2 FN Data Form Name varies ASCII Comments If Form Name is omitted from the request then the default calibration form built into PIN pad application named CALIBRFRM will be displayed Example to request device touch screen calibration where CALIBRFRM a name of the custom form screen for configuring calibration 60 operation timeout in seconds lt STX gt p lt
102. varies ASCII and ASCII numeric Example FSST Example FS T Example FSST 1B4012000000001 HYPERCOM TEST CARD 050201234567890 24012000000001 050201234567890 3HYPERCOM TEST CARD 1234567890 TS Track data source Track data source if requested by TS token of V request Field Description Length Value Token Field ID 2 TS Data Track data source 1 0 TRACK READER 1 RDIF EXPRESS PAY 2 RFID PAY PASS 3 RFID VISA WAVE 4 RFID UNKNOWN APP Example lt FS gt TS1 XP XM See Error response X description FN Form name Source Form Name sent by PDxxxx application v 3 0 010 if FN tag sending in Form Request V response is configured in FormBuilder 4 9 5 Field Description Length Value Token Field ID 2 EN Parameter Form name to process 1 11 ASCII form name Example FS FNEDITSCREEN 33 34 FPE Interface Specification IC ICC Card or Smart Card insertion and or removal This field will be sent by PDxxxx application v3 0 020 if Enable Smart Card Reader option is enabled for the MSR control located on the form in FormBuilder 4 9 6 Field Description Length Value Token Field ID 2 IC Data ICC card or Smart 1 Y CC Card inserted Card insertion removal N ICC Card removed Flag Data ATR 0 64 ASCII hex Example lt FS gt ICY

NOTE - Motorola Solutions

Contents

Download Pdf Manuals

Related Search

Related Contents