MagTek Excella STX99875340 - Manual (Page 4)

iv
TABLE OF CONTENTS
SECTION 1. OVERVIEW ............................................................................................................................. 1
REQUIREMENTS .................................................................................................................................... 1
SECTION 2. EXCELLA SOFTWARE ARCHITECTURE ............................................................................. 3
TERM DESCRIPTION ............................................................................................................................. 4
DEVICES ATTACH THROUGH USB NETWORK CARD........................................................................ 4
RNDIS SUPPORT FOR A USB NETWORK DEVICE ............................................................................. 5
SUPPORT FOR EXCELLA DEVICE ON PC SIDE: ................................................................................. 6
HOW TO COMMUNICATE WITH EXCELLA USING WEB BROWSER ................................................. 6
Get Device Status ................................................................................................................................... 8
Get Device Usage ................................................................................................................................... 9
HOW TO COMMUNICATE WITH EXCELLA USING THE EXCELLA API ............................................ 10
API FUNCTIONS.................................................................................................................................... 11
SOFTWARE FLOW FOR CHECK PROCESSING ................................................................................ 12
HOW TO PROCESS DOCUMENT USING EXCELLA API ................................................................... 13
HOW TO GET CHECK IMAGES ........................................................................................................... 14
PROCESS OPTIONS ............................................................................................................................ 14
ERROR REPORTING ............................................................................................................................ 14
DEBUGGING API................................................................................................................................... 14
SECTION 3. EXCELLA API ....................................................................................................................... 15
MTMICRGetDevice ................................................................................................................................ 15
Parameters .......................................................................................................................................... 15
Return Values ....................................................................................................................................... 15
Remarks .............................................................................................................................................. 15
Example ............................................................................................................................................... 15
MTMICROpenDevice ............................................................................................................................. 16
Parameters .......................................................................................................................................... 16
Return Values ....................................................................................................................................... 16
Remarks .............................................................................................................................................. 16
Example ............................................................................................................................................... 16
MTMICRCloseDevice ............................................................................................................................. 17
Parameters .......................................................................................................................................... 17
Return Values ....................................................................................................................................... 17
Remarks .............................................................................................................................................. 17
Example ............................................................................................................................................... 17
MTMICRDeviceConnect ........................................................................................................................ 18
Parameters .......................................................................................................................................... 18
Return Values ....................................................................................................................................... 18
Remarks .............................................................................................................................................. 18
Example ............................................................................................................................................... 19
MTMICRDeviceDisconnect .................................................................................................................... 19
Parameters .......................................................................................................................................... 19
Return Values ....................................................................................................................................... 19
Remarks .............................................................................................................................................. 19
Example ............................................................................................................................................... 19
MTMICRSetValue .................................................................................................................................. 20
Parameters .......................................................................................................................................... 20
Return Values ....................................................................................................................................... 20
Remarks .............................................................................................................................................. 20
Example ............................................................................................................................................... 21
MTMICRSetIndexValue ......................................................................................................................... 21
Parameters .......................................................................................................................................... 21
Return Values ....................................................................................................................................... 21
Remarks .............................................................................................................................................. 22
Example ............................................................................................................................................... 22
MTMICRGetValue .................................................................................................................................. 22
Parameters .......................................................................................................................................... 22