| IDTech Universal SDK 1.0.35.027 API reference for C++

libIDT_UniPayI_V.h
Go to the documentation of this file.
1 #ifndef __LIBIDT_UNIPAYI_V_H___
2 # define __LIBIDT_UNIPAYI_V_H___
3
4
5 # define IN
6 # define OUT
7 # define IN_OUT
8 # include "IDTDef.h"
9
15 typedef void (* pMessageHotplug)(int, int);
16
21 typedef void (* pSendDataLog)(BYTE *, int);
22
27 typedef void (* pReadDataLog)(BYTE *, int);
28
33 typedef void (* pEMV_callBack)(int, int, BYTE *, int, IDTTransactionData *, EMV_Callback *, int);
34
39 typedef void (* pMSR_callBack)(int, IDTMSRData);
40
45 typedef void (* pMSR_callBackp)(int, IDTMSRData *);
46
51 typedef void (* pPIN_callBack)(int, IDTPINData *);
52
57 typedef void (* pCMR_callBack)(int, IDTCMRData *);
58
63 typedef void (* pCSFS_callBack)(BYTE status);
64
76 typedef void (* ftpComm_callBack)(int, int, int);
77
82 typedef void (* httpComm_callBack)(BYTE *, int);
83
90 typedef void (* v4Comm_callBack)(BYTE, BYTE, BYTE *, int);
91
92
93 # ifdef __cplusplus
94 extern "C" {
95 # endif
96
100 void
101 registerHotplugCallBk(pMessageHotplug pMsgHotplug);
102
106 void
107 registerLogCallBk(pSendDataLog pFSend, pReadDataLog pFRead);
108
112 void
113 emv_registerCallBk(pEMV_callBack pEMVf);
114
118 void
119 msr_registerCallBk(pMSR_callBack pMSRf);
120
124 void
125 msr_registerCallBkp(pMSR_callBackp pMSRf);
126
130 void
131 pin_registerCallBk(pPIN_callBack pPINf);
132
136 void
137 device_registerCameraCallBk(pCMR_callBack pCMRf);
138
142 void
143 device_registerCardStatusFrontSwitchCallBk(pCSFS_callBack pCSFSf);
144
150 void
151 comm_registerHTTPCallback(httpComm_callBack cBack);
152
158 void
159 comm_registerV4Callback(v4Comm_callBack cBack);
160
165 char *
166 SDK_Version();
167
176 int
177 setAbsoluteLibraryPath(const char * absoluteLibraryPath);
178
186 int
187 device_init();
188
230 int
231 device_setCurrentDevice(int deviceType);
232
238 int
239 device_close();
240
241
301 void
302 device_getIDGStatusCodeString(IN int returnCode, OUT char * despcrition);
303
304
309 int
310 device_isConnected();
311
318 int
319 device_isAttached(int deviceType);
320
331 int
332 device_getFirmwareVersion(OUT char * firmwareVersion);
333
343 int
344 device_getFirmwareVersion_Len(OUT char * firmwareVersion, IN_OUT int * firmwareVersionLen);
345
354 int
355 device_pingDevice();
356
362 int
363 device_getCurrentDeviceType();
364
366 // * Send a Command to device
367 // *
368 // * Sends a command to the device .
369 // *
370 // * @param cmd buffer of command to execute.
371 // * @param cmdLen, the length of the buffer cmd.
372 // *
373 // * @param data buffer of IDG command data.
374 // * @param dataLen, the length of the buffer data.
375 // *
376 // * @param response Response data
377 // * @param respLen, the length of Response data
378 //
379 // * @return RETURN_CODE: Values can be parsed with device_getIDGStatusCodeString()
380 // */
381 //
382 // int device_SendDataCommand(IN BYTE* cmd, IN int cmdLen, IN BYTE* data, IN int dataLen, OUT BYTE* response, IN_OUT int *respLen);
383
400 int
401 device_SendDataCommandNEO(IN int cmd, IN int subCmd, IN BYTE * data, IN int dataLen, OUT BYTE * response,
402 IN_OUT int * respLen);
403
414 int
415 device_enablePassThrough(int enablePassThrough);
416
430 int
431 device_setMerchantRecord(int index, int enabled, char * merchantID, char * merchantURL);
432
454 int
455 device_getMerchantRecord(IN int index,
456 OUT BYTE * record);
457
478 int
479 device_getMerchantRecord_Len(IN int index,
480 OUT BYTE * record, IN_OUT int * recordLen);
481
490 int
491 device_getSDKWaitTime();
492
502 void
503 device_setSDKWaitTime(int waitTime);
504
513 int
514 device_getThreadStackSize();
515
523 void
524 device_setThreadStackSize(int threadSize);
525
536 int
537 config_getSerialNumber(OUT char * sNumber);
538
548 int
549 config_getSerialNumber_Len(OUT char * sNumber, IN_OUT int * sNumberLen);
550
555 void
556 emv_allowFallback(IN int allow);
557
563 void
564 emv_setAutoAuthenticateTransaction(IN int authenticate);
565
571 void
572 emv_setAutoCompleteTransaction(IN int complete);
573
578 int
579 emv_getAutoAuthenticateTransaction();
580
585 int
586 emv_getAutoCompleteTransaction();
587
609 int
610 emv_startTransaction(IN double amount, IN double amtOther, IN int exponent, IN int type, IN int timeout, IN BYTE * tags,
611 IN int tagsLen, IN int forceOnline);
612
613
632 int
633 emv_activateTransaction(IN int timeout, IN BYTE * tags, IN int tagsLen, IN int forceOnline);
634
651 int
652 emv_authenticateTransaction(IN BYTE * updatedTLV, IN int updatedTLVLen);
653
671 int
672 emv_authenticateTransactionWithTimeout(IN int timeout, IN BYTE * updatedTLV, IN int updatedTLVLen);
673
693 int
694 emv_completeTransaction(IN int commError, IN BYTE * authCode, IN int authCodeLen,
695 IN BYTE * iad, IN int iadLen, IN BYTE * tlvScripts, IN int tlvScriptsLen, IN BYTE * tlv, IN int tlvLen);
696
703 int
704 emv_cancelTransaction();
705
718 int
719 emv_retrieveApplicationData(IN BYTE * AID, IN int AIDLen, OUT BYTE * tlv, IN_OUT int * tlvLen);
720
733 int
734 emv_setApplicationData(IN BYTE * name, IN int nameLen, IN BYTE * tlv, IN int tlvLen);
735
748 int
749 emv_setApplicationDataTLV(IN BYTE * tlv, IN int tlvLen);
750
760 int
761 emv_removeApplicationData(IN BYTE * AID, IN int AIDLen);
762
772 int
773 emv_removeAllApplicationData();
774
786 int
787 emv_retrieveAIDList(OUT BYTE * AIDList, IN_OUT int * AIDListLen);
788
802 int
803 emv_retrieveTerminalData(OUT BYTE * tlv, IN_OUT int * tlvLen);
804
819 int
820 emv_setTerminalData(IN BYTE * tlv, IN int tlvLen);
821
835 int
836 emv_setTerminalMajorConfiguration(IN int configuration);
837
859 int
860 emv_retrieveCAPK(IN BYTE * capk, IN int capkLen, OUT BYTE * key, IN_OUT int * keyLen);
861
880 int
881 emv_setCAPK(IN BYTE * capk, IN int capkLen);
882
893 int
894 emv_removeCAPK(IN BYTE * capk, IN int capkLen);
895
904 int
905 emv_removeAllCAPK();
906
917 int
918 emv_retrieveCAPKList(OUT BYTE * keys, IN_OUT int * keysLen);
919
930 int
931 emv_retrieveCRL(OUT BYTE * list, IN_OUT int * lssLen);
932
945 int
946 emv_setCRL(IN BYTE * list, IN int lsLen);
947
958 int
959 emv_removeCRL(IN BYTE * list, IN int lsLen);
960
970 int
971 emv_removeAllCRL();
972
983 int
984 icc_getICCReaderStatus(OUT BYTE * status);
985
995 int
996 icc_powerOnICC(OUT BYTE * ATR,
997 IN_OUT int * inLen);
998
1009 int
1010 icc_powerOffICC();
1011
1026 int
1027 icc_exchangeAPDU(IN BYTE * c_APDU,
1028 IN int cLen,
1029 OUT BYTE * reData,
1030 IN_OUT int * reLen);
1031
1032
1038 int
1039 msr_cancelMSRSwipe();
1040
1048 int
1049 msr_startMSRSwipe(IN int _timeout);
1050
1051
1058 void
1059 parseMSRData(IN BYTE * resData, IN int resLen, IN_OUT IDTMSRData * cardData);
1060
1061 # ifdef __cplusplus
1062 }
1063 # endif
1064
1065
1066 #endif // ifndef __LIBIDT_UNIPAYI_V_H___
1067
emv_retrieveApplicationData
int emv_retrieveApplicationData(IN BYTE *AID, IN int AIDLen, OUT BYTE *tlv, IN_OUT int *tlvLen)
emv_setTerminalMajorConfiguration
int emv_setTerminalMajorConfiguration(IN int configuration)
pEMV_callBack
void(* pEMV_callBack)(int, int, BYTE *, int, IDTTransactionData *, EMV_Callback *, int)
Definition: libIDT_UniPayI_V.h:33
registerLogCallBk
void registerLogCallBk(pSendDataLog pFSend, pReadDataLog pFRead)
icc_powerOnICC
int icc_powerOnICC(OUT BYTE *ATR, IN_OUT int *inLen)
device_SendDataCommandNEO
int device_SendDataCommandNEO(IN int cmd, IN int subCmd, IN BYTE *data, IN int dataLen, OUT BYTE *response, IN_OUT int *respLen)
emv_setApplicationData
int emv_setApplicationData(IN BYTE *name, IN int nameLen, IN BYTE *tlv, IN int tlvLen)
device_getThreadStackSize
int device_getThreadStackSize()
registerHotplugCallBk
void registerHotplugCallBk(pMessageHotplug pMsgHotplug)
emv_retrieveTerminalData
int emv_retrieveTerminalData(OUT BYTE *tlv, IN_OUT int *tlvLen)
emv_startTransaction
int emv_startTransaction(IN double amount, IN double amtOther, IN int exponent, IN int type, IN int timeout, IN BYTE *tags, IN int tagsLen, IN int forceOnline)
msr_cancelMSRSwipe
int msr_cancelMSRSwipe()
emv_registerCallBk
void emv_registerCallBk(pEMV_callBack pEMVf)
emv_allowFallback
void emv_allowFallback(IN int allow)
device_getSDKWaitTime
int device_getSDKWaitTime()
emv_setTerminalData
int emv_setTerminalData(IN BYTE *tlv, IN int tlvLen)
device_init
int device_init()
IN
#define IN
emv_removeApplicationData
int emv_removeApplicationData(IN BYTE *AID, IN int AIDLen)
pMessageHotplug
void(* pMessageHotplug)(int, int)
Definition: libIDT_UniPayI_V.h:15
IN_OUT
#define IN_OUT
pin_registerCallBk
void pin_registerCallBk(pPIN_callBack pPINf)
icc_powerOffICC
int icc_powerOffICC()
ftpComm_callBack
void(* ftpComm_callBack)(int, int, int)
Definition: libIDT_UniPayI_V.h:76
device_getCurrentDeviceType
int device_getCurrentDeviceType()
device_registerCameraCallBk
void device_registerCameraCallBk(pCMR_callBack pCMRf)
config_getSerialNumber_Len
int config_getSerialNumber_Len(OUT char *sNumber, IN_OUT int *sNumberLen)
device_setThreadStackSize
void device_setThreadStackSize(int threadSize)
pCMR_callBack
void(* pCMR_callBack)(int, IDTCMRData *)
Definition: libIDT_UniPayI_V.h:57
emv_authenticateTransaction
int emv_authenticateTransaction(IN BYTE *updatedTLV, IN int updatedTLVLen)
emv_removeAllCAPK
int emv_removeAllCAPK()
emv_authenticateTransactionWithTimeout
int emv_authenticateTransactionWithTimeout(IN int timeout, IN BYTE *updatedTLV, IN int updatedTLVLen)
emv_removeAllApplicationData
int emv_removeAllApplicationData()
emv_removeAllCRL
int emv_removeAllCRL()
comm_registerHTTPCallback
void comm_registerHTTPCallback(httpComm_callBack cBack)
pSendDataLog
void(* pSendDataLog)(BYTE *, int)
Definition: libIDT_UniPayI_V.h:21
device_isConnected
int device_isConnected()
emv_getAutoCompleteTransaction
int emv_getAutoCompleteTransaction()
httpComm_callBack
void(* httpComm_callBack)(BYTE *, int)
Definition: libIDT_UniPayI_V.h:82
emv_setAutoCompleteTransaction
void emv_setAutoCompleteTransaction(IN int complete)
SDK_Version
char * SDK_Version()
device_setSDKWaitTime
void device_setSDKWaitTime(int waitTime)
OUT
#define OUT
device_isAttached
int device_isAttached(int deviceType)
device_getMerchantRecord_Len
int device_getMerchantRecord_Len(IN int index, OUT BYTE *record, IN_OUT int *recordLen)
device_setMerchantRecord
int device_setMerchantRecord(int index, int enabled, char *merchantID, char *merchantURL)
emv_retrieveAIDList
int emv_retrieveAIDList(OUT BYTE *AIDList, IN_OUT int *AIDListLen)
device_getFirmwareVersion
int device_getFirmwareVersion(OUT char *firmwareVersion)
pPIN_callBack
void(* pPIN_callBack)(int, IDTPINData *)
Definition: libIDT_UniPayI_V.h:51
device_pingDevice
int device_pingDevice()
emv_setCAPK
int emv_setCAPK(IN BYTE *capk, IN int capkLen)
emv_setApplicationDataTLV
int emv_setApplicationDataTLV(IN BYTE *tlv, IN int tlvLen)
emv_activateTransaction
int emv_activateTransaction(IN int timeout, IN BYTE *tags, IN int tagsLen, IN int forceOnline)
device_getFirmwareVersion_Len
int device_getFirmwareVersion_Len(OUT char *firmwareVersion, IN_OUT int *firmwareVersionLen)
emv_retrieveCRL
int emv_retrieveCRL(OUT BYTE *list, IN_OUT int *lssLen)
emv_completeTransaction
int emv_completeTransaction(IN int commError, IN BYTE *authCode, IN int authCodeLen, IN BYTE *iad, IN int iadLen, IN BYTE *tlvScripts, IN int tlvScriptsLen, IN BYTE *tlv, IN int tlvLen)
device_registerCardStatusFrontSwitchCallBk
void device_registerCardStatusFrontSwitchCallBk(pCSFS_callBack pCSFSf)
config_getSerialNumber
int config_getSerialNumber(OUT char *sNumber)
emv_getAutoAuthenticateTransaction
int emv_getAutoAuthenticateTransaction()
pMSR_callBackp
void(* pMSR_callBackp)(int, IDTMSRData *)
Definition: libIDT_UniPayI_V.h:45
device_getIDGStatusCodeString
void device_getIDGStatusCodeString(IN int returnCode, OUT char *despcrition)
icc_getICCReaderStatus
int icc_getICCReaderStatus(OUT BYTE *status)
v4Comm_callBack
void(* v4Comm_callBack)(BYTE, BYTE, BYTE *, int)
Definition: libIDT_UniPayI_V.h:90
parseMSRData
void parseMSRData(IN BYTE *resData, IN int resLen, IN_OUT IDTMSRData *cardData)
msr_registerCallBk
void msr_registerCallBk(pMSR_callBack pMSRf)
device_setCurrentDevice
int device_setCurrentDevice(int deviceType)
emv_retrieveCAPK
int emv_retrieveCAPK(IN BYTE *capk, IN int capkLen, OUT BYTE *key, IN_OUT int *keyLen)
emv_setAutoAuthenticateTransaction
void emv_setAutoAuthenticateTransaction(IN int authenticate)
setAbsoluteLibraryPath
int setAbsoluteLibraryPath(const char *absoluteLibraryPath)
msr_startMSRSwipe
int msr_startMSRSwipe(IN int _timeout)
emv_setCRL
int emv_setCRL(IN BYTE *list, IN int lsLen)
pMSR_callBack
void(* pMSR_callBack)(int, IDTMSRData)
Definition: libIDT_UniPayI_V.h:39
emv_cancelTransaction
int emv_cancelTransaction()
emv_removeCRL
int emv_removeCRL(IN BYTE *list, IN int lsLen)
icc_exchangeAPDU
int icc_exchangeAPDU(IN BYTE *c_APDU, IN int cLen, OUT BYTE *reData, IN_OUT int *reLen)
comm_registerV4Callback
void comm_registerV4Callback(v4Comm_callBack cBack)
pCSFS_callBack
void(* pCSFS_callBack)(BYTE status)
Definition: libIDT_UniPayI_V.h:63
device_getMerchantRecord
int device_getMerchantRecord(IN int index, OUT BYTE *record)
msr_registerCallBkp
void msr_registerCallBkp(pMSR_callBackp pMSRf)
device_enablePassThrough
int device_enablePassThrough(int enablePassThrough)
device_close
int device_close()
pReadDataLog
void(* pReadDataLog)(BYTE *, int)
Definition: libIDT_UniPayI_V.h:27
emv_retrieveCAPKList
int emv_retrieveCAPKList(OUT BYTE *keys, IN_OUT int *keysLen)
emv_removeCAPK
int emv_removeCAPK(IN BYTE *capk, IN int capkLen)