Magtek IMAGESAFE Specifications

IMAGESAFE WINDOWS API SPECIFICATIONS PROGRAMMING REFERENCE MANUAL MANUAL PART NUMBER 99875500-4 APRIL 2012 REGISTERED TO ISO 900

ImageSafe Windows API Specifications 2

ImageSafe Windows API Specifications 92 Fmt 60xx: [transit] '/' [ac

Appendix A. Format List 93 Fmt 64xx: [transit] [acct #] [check #] [amount] • [transit]: - all characters in the field - keep dash

ImageSafe Windows API Specifications 94 Fmt 68xx: [transit] <TAB> [acct

Appendix A. Format List 95 Fmt 71: [acct #] '?' [check #] • [acct #]: - work with a window of N characters in the acct field

ImageSafe Windows API Specifications 96 Fmt 76xx: 'T' [transit] &apo

97 APPENDIX B. ERROR CODES AND MESSAGES The following are Error Codes and Error Messages from ImageSafe device API MTXMLMCR.dll. Error Code Err

ImageSafe Windows API Specifications 98 Error Code Error Message Error Code Err

99 APPENDIX C. HOW TO PROCESS CHECKS AND GET IMAGE QUALITY ASSURANCE Note This procedure is only for ImageSafe Software installed with ImageScore

ImageSafe Windows API Specifications 100 default values for all Image QA test m

101 INDEX A API Functions ... 3 D Debugging API...

3 SECTION 2. IMAGESAFE SOFTWARE ARCHITECTURE API FUNCTIONS Table 2-1 lists functions provided by MTXMLMCR.dll. Please refer to Section 3 for a co

ImageSafe Windows API Specifications 4 SOFTWARE FLOW FOR CHECK PROCESSING Figu

Section 2. ImageSafe Software Architecture 5 HOW TO PROCESS DOCUMENT USING IMAGESAFE API To process document, follow these steps: 1. Fin

ImageSafe Windows API Specifications 6 HOW TO GET CHECK IMAGES To get a check

7 SECTION 3. IMAGESAFE API MTMICRGetDevice MTMICRGetDevice function returns the device name of the device present in the system. ULONG MTMICRGet

ImageSafe Windows API Specifications 8 MTMICROpenDevice MTMICROpenDevice funct

... Section 3. ImageSafe API 9

ImageSafe Windows API Specifications 10 MTMICRSETVALUE MTMICRSetValue function

... Section 3. ImageSafe API 11

ii Copyright© 2004 – 2012 MagTek®, Inc. Printed in the United States of America Information in this document is subject to change without notice.

ImageSafe Windows API Specifications 12 Remarks The function returns MICR_ST_N

... Section 3. ImageSafe API 13

ImageSafe Windows API Specifications 14 MTMICRGetIndexValue MTMICRGetIndexValu

... Section 3. ImageSafe API 15

ImageSafe Windows API Specifications 16 Parameters pcDevName Pointer to null t

... Section 3. ImageSafe API 17

ImageSafe Windows API Specifications 18 Example char szResult [4096]; char szD

... Section 3. ImageSafe API 19

ImageSafe Windows API Specifications 20 MTMICRGetImage MTMICRGetImage function

... Section 3. ImageSafe API 21

iii SOFTWARE LICENSE AGREEMENT IMPORTANT: YOU SHOULD CAREFULLY READ ALL THE TERMS, CONDITIONS AND RESTRICTIONS OF THIS LICENSE AGREEMENT BEF

ImageSafe Windows API Specifications 22 MTMICRGetImages MTMICRGetImages is sim

... Section 3. ImageSafe API 23

ImageSafe Windows API Specifications 24 Example #define BUFFER_LEN 512 // Doc

... Section 3. ImageSafe API 25

ImageSafe Windows API Specifications 26 MTMICRGetSectionName MTMICRGetSectionN

... Section 3. ImageSafe API 27

ImageSafe Windows API Specifications 28 Parameters pcData Pointer to null term

... Section 3. ImageSafe API 29

ImageSafe Windows API Specifications 30 MTMICRGetKeyName MTMICRGetKeyName func

... Section 3. ImageSafe API 31

iv TABLE OF CONTENTS SECTION 1. OVERVIEW ...

ImageSafe Windows API Specifications 32 MTMICRSetTimeout MTMICRSetTimeout func

... Section 3. ImageSafe API 33

ImageSafe Windows API Specifications 34 MTMICRLogEnable MTMICRLogEnable enable

... Section 3. ImageSafe API 35

ImageSafe Windows API Specifications 36 Return Values No value is returned fro

... Section 3. ImageSafe API 37

ImageSafe Windows API Specifications 38 MTMICRSetConfigFile MTMICRSetConfigFil

39 SECTION 4. COMMANDS SENT TO DEVICE Section 4 describes device commands that can be sent to the MagneSafe Reader MTMICRSendCommand (see Section

41 SECTION 5. KEYS SENT TO DEVICE Section 5 describes all the Sections (and their corresponding Key-Value pairs) to be sent by the application to

v MTMICRGetImage ...

ImageSafe Windows API Specifications 42 SECTION = Application The Application s

Section 5. Keys Sent to Device 43 DocFeed This key determines the input tray to be used for document processing. Values Value Descriptio

ImageSafe Windows API Specifications 44 INTFONT1 Selects internal Font 1 (5x7 b

Section 5. Keys Sent to Device 45 SECTION = ImageOptions The ImageOptions section includes keys that control various options to process the

ImageSafe Windows API Specifications 46 ImageSide# This key determines which si

Section 5. Keys Sent to Device 47 SECTION = MICROptions The MICROptions section includes keys that control various options to get MICR char

49 SECTION 6. KEYS RECEIVED FROM DEVICE Section 6 describes all the Sections (and their corresponding Key-Value pairs) automatically reported by

ImageSafe Windows API Specifications 50 The following keys are included in the

Section 6. Keys Received From Device 51 SECTION = CommandStatus This CommandStatus section includes keys that report various error condit

vi Return Values ...

ImageSafe Windows API Specifications 52 ResponseType This key is a general flag

Section 6. Keys Received From Device 53 Table 6-4. Path Path (200-299) ReturnCode ReturnMsg 201 “Access Guide Unlatched” 202 “No Doc Pres

ImageSafe Windows API Specifications 54 Table 6-7. Scan/Image Scan/Image (400

Section 6. Keys Received From Device 55 SECTION = DocInfo The DocInfo section includes keys that report on various attributes of the check

ImageSafe Windows API Specifications 56 MICRAmt This key specifies the amount M

Section 6. Keys Received From Device 57 MICROnUs This key specifies the On-Us MICR field read from the check. Values Value Description s

ImageSafe Windows API Specifications 58 MICRParseSts0 This key specifies a 4-di

Section 6. Keys Received From Device 59 MICRParseSts1 This key specifies a 2-digit status/error code reported by the device after parsing

ImageSafe Windows API Specifications 60 SECTION = ImageInfo The ImageInfo secti

Section 6. Keys Received From Device 61 SECTION = MSRInfo The MSRInfo section includes keys that report on the information captured from t

vii MICRDecode ...

ImageSafe Windows API Specifications 62 TrackStatus2 This key indicates whethe

Section 6. Keys Received From Device 63 DUKPTserialnumber This key specifies the DUKPT serial number from MagneSafe Reader. Values Valu

65 SECTION 7. OTHER KEYS AVAILABLE FROM DEVICE Section 7 describes other Sections (and their corresponding key-value pairs) available from the de

ImageSafe Windows API Specifications 66 SECTION = DeviceCapabilities The Dev

Section 7. Other Keys Available from Device 67 Image This key indicates what check scanning capabilities are available on the device. Val

ImageSafe Windows API Specifications 68 SECTION = DeviceStatus The DeviceStatu

Section 7. Other Keys Available from Device 69 USBSpeed This key specifies the protocol of USB connection. Values Value Description HI Th

71 SECTION 8. EXAMPLES OF KEY-VALUE PAIRS This section contains examples of key-value pairs send to the ImageSafe device and the key-value pairs

viii EXAMPLE 3: DEVICE CAPABILITIES REPORTED BY EXCELLA DEVICE ... 75 EXAMPLE 4: DEVICE USAGE REPORTED BY E

ImageSafe Windows API Specifications 72 Key-Value Pairs Sent by STXDemo Applica

Section 8. Examples of Key-Value Pairs 73 Section DocInfo Key Value DocHeight 2990 DocUnits ENGLISH DocWidth 8000 MICRAcct 123456789 MICRAm

ImageSafe Windows API Specifications 74 <AccessGuide>LATCHED</AccessGu

Section 8. Examples of Key-Value Pairs 75 EXAMPLE 2: DEVICE STATUS REPORTED BY IMAGESAFE DEVICE Section = DeviceStatus Key Value AccessGu

ImageSafe Windows API Specifications 76 Endorse BOTH ExpressCapable TRUE Firmwa

Section 8. Examples of Key-Value Pairs 77 EXAMPLE 4: DEVICE USAGE REPORTED BY EXCELLA DEVICE Section=DeviceUsage Key Value CardsRead 15

79 APPENDIX A. FORMAT LIST For check reading, the ImageSafe device provides the flexibility to format the MICR fields and build a specific output

ImageSafe Windows API Specifications 80 Fmt 02xx: Parsed Text Format with E

Appendix A. Format List 81 Fmt 09xx: [transit] [acct #] • [transit]: - all characters in the field - keep dashes • [acct #]:

1 SECTION 1. OVERVIEW The sections of this manual are as follows: Section 1. Overview Section 2. ImageSafe Software Architecture – includes flo

ImageSafe Windows API Specifications 82 Fmt 14xx: [transit] [acct #] [check #

Appendix A. Format List 83 Fmt 20xx: [transit] [acct #] <CR> [check #] • [transit]: - all characters in the field - keep da

ImageSafe Windows API Specifications 84 Fmt 24xx: [transit] 'T' [ac

Appendix A. Format List 85 Fmt 29xx: 'C' '/' [transit] '/' [acct #] '/' [check #] '/' [

ImageSafe Windows API Specifications 86 Fmt 3300: '=' [transit] &ap

Appendix A. Format List 87 Fmt 37xx: [ABA] [chk dgt] [acct #] • [ABA], [chk dgt]: - all characters in the field - keep spaces

ImageSafe Windows API Specifications 88 Fmt 42xx: US check : [transit] [acct

Appendix A. Format List 89 Fmt 47xx: [transit] 'T' [acct #] 'A' [check #] • [transit]: - all characters in the fie

ImageSafe Windows API Specifications 90 Fmt 52xx: 'T' [transit] &ap

Appendix A. Format List 91 Fmt 56xx: [transit] <CR> [acct #] <CR> [check #] <CR> [amount] • [transit]: - all characte