![]() |
IDTech Windows SDK Guide
3.2.4.393
API reference for Visual Studio .Net
|
Public Member Functions | |
RETURN_CODE | config_getSerialNumber (ref string response, string ident="") |
RETURN_CODE | device_getDRS (ref byte[] codeDRS, string ident="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ident="") |
RETURN_CODE | device_getFirmwareVersion (ref string response, string ident="") |
RETURN_CODE | device_selfCheck (string ident="") |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response, string ident="") |
RETURN_CODE | device_sendDataCommand_ext (string cmd, bool calcLRC, ref byte[] response, int timeout, bool noResponse, string ident="") |
RETURN_CODE | msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode) |
RETURN_CODE | msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode, ref string ident) |
RETURN_CODE | msr_startMSRSwipe (int timeout, string ident="") |
RETURN_CODE | msr_cancelMSRSwipe (string ident="") |
RETURN_CODE | emv_cancelTransaction (string ident="") |
RETURN_CODE | emv_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | emv_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | device_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | device_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | emv_authenticateTransaction (byte[] updatedTLV, string ident="") |
RETURN_CODE | emv_completeTransaction (bool commError, byte[] authCode, byte[] iad, byte[] tlvScripts, byte[] tlv, string ident="") |
RETURN_CODE | emv_callbackResponseLCD (EMV_LCD_DISPLAY_MODE type, byte selection, string ident="") |
RETURN_CODE | emv_callbackResponsePIN (EMV_PIN_MODE type, byte[] KSN, byte[] PIN, string ident="") |
RETURN_CODE | emv_callbackResponseMSR (byte[] MSR, string ident="") |
RETURN_CODE | emv_getEMVKernelVersion (ref string response, string ident="") |
RETURN_CODE | emv_retrieveTransactionResult (byte[] tags, ref IDTTransactionData tlv, string ident="") |
RETURN_CODE | emv_removeApplicationData (byte[] AID, string ident="") |
RETURN_CODE | emv_removeAllApplicationData (string ident="") |
RETURN_CODE | emv_removeCAPK (byte[] capk, string ident="") |
RETURN_CODE | emv_removeAllCAPK (string ident="") |
RETURN_CODE | emv_removeCRL (byte[] crlList, string ident="") |
RETURN_CODE | emv_removeAllCRL (string ident="") |
RETURN_CODE | emv_retrieveApplicationData (byte[] AID, ref byte[] tlv, string ident="") |
RETURN_CODE | emv_retrieveAIDList (ref byte[][] response, string ident="") |
RETURN_CODE | emv_retrieveCAPK (byte[] capk, ref byte[] key, string ident="") |
RETURN_CODE | emv_retrieveCAPKList (ref byte[] keys, string ident="") |
RETURN_CODE | emv_retrieveCRLList (ref byte[] list, string ident="") |
RETURN_CODE | emv_retrieveTerminalData (ref byte[] tlv, string ident="") |
RETURN_CODE | emv_removeTerminalData (string ident="") |
RETURN_CODE | emv_setApplicationData (byte[] name, byte[] tlv, string ident="") |
RETURN_CODE | emv_setCAPK (byte[] key, string ident="") |
RETURN_CODE | emv_setCRL (byte[] list, string ident="") |
RETURN_CODE | emv_trySetTerminalData (byte[] tlv, ref byte[] rejectedTLV, ref byte[] convertedTLV, bool overwrite=false, string ident="") |
RETURN_CODE | emv_setTerminalData (byte[] tlv, string ident="") |
RETURN_CODE | emv_addTerminalData (byte[] tlv, string ident="") |
RETURN_CODE | emv_setTerminalMajorConfiguration (int configuration, string ident="") |
RETURN_CODE | device_pingDevice (string ident="") |
RETURN_CODE | device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response, string ident="") |
RETURN_CODE | device_sendVivoCommandP2_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ident="") |
RETURN_CODE | device_startRKI (string ident="") |
RETURN_CODE | device_setTerminalData (byte[] tlv, string ident="") |
RETURN_CODE | device_retrieveTerminalData (ref byte[] tlv, string ident="") |
RETURN_CODE | device_setBurstMode (byte mode, string ident="") |
RETURN_CODE | device_setPollMode (byte mode, string ident="") |
RETURN_CODE | device_updateDeviceFirmware (byte[] firmwareData, string ident="") |
RETURN_CODE | icc_getICCReaderStatus (ref byte status, string ident="") |
RETURN_CODE | icc_powerOffICC (string ident="") |
RETURN_CODE | icc_powerOnICC (ref byte[] ATR, byte interfaces, string ident="") |
RETURN_CODE | icc_exchangeAPDU (string c_APDU, ref byte[] response, string ident="") |
RETURN_CODE | device_enablePassThrough (bool enablePassThrough, string ident="") |
RETURN_CODE | emv_getEMVKernelCheckValue (ref string response, string ident="") |
RETURN_CODE | emv_getEMVConfigurationCheckValue (ref string response, string ident="") |
string | device_getResponseCodeString (RETURN_CODE eCode) |
RETURN_CODE | device_StartRKI (int type, string ident="") |
RETURN_CODE | config_setEncryptionControl (bool msr, bool icc, string ident="") |
RETURN_CODE | config_getEncryptionControl (ref bool msr, ref bool icc, string ident="") |
RETURN_CODE | device_getRKIStatus (bool isProd, bool isMultiKey, ref string status, ref Dictionary< string, RKI_KEY_TYPE > keys, string ident="") |
RETURN_CODE | device_getAnyRKIStatus (bool isMultiKey, ref string status, ref Dictionary< string, RKI_KEY_TYPE > keys, string ident="") |
RETURN_CODE | emv_getEMVKernelVersionExt (ref string response, string ident="") |
RETURN_CODE | device_updateFirmwareFromZip (byte[] zipfile, string ident="", bool isForeground=false) |
RETURN_CODE | device_sendConfigurationFromZip (byte[] zip, string filename, VC_OPERATION_TYPE type, bool matchFW, string ident="", bool isForeground=false) |
RETURN_CODE | device_sendConfiguration (string filename, VC_OPERATION_TYPE type, bool matchFW, string ident="", bool isForeground=false) |
RETURN_CODE | device_readConfigurationToMemory (string memo, Configs.InstallRules rules, List< Configs.DeviceCommand > cmds, string ident="", bool isForeground=false) |
RETURN_CODE | device_getConfigurationFromMemory (ref string json, string ident="") |
RETURN_CODE | device_RemoteKeyInjection (RKI_KEY_TYPE type, string keyName, string ident="", bool performOnForeground=false) |
Static Public Member Functions | |
static void | initSC () |
static int | getCommandTimeout (string ident="") |
static void | setCommandTimeout (int milliseconds, string ident="") |
static void | setCallback (CallBack my_Callback) |
static void | setCallback (IntPtr my_Callback, SynchronizationContext context) |
static String | SDK_Version () |
static void | emv_autoAuthenticate (bool authenticate, string ident="") |
static void | emv_autoAuthenticateTags (bool authenticate, byte[] tags, string ident="") |
static void | emv_allowFallback (bool allow, string ident="") |
static void | lcd_retrieveMessage (DisplayMessages.DISPLAY_MESSAGE_LANGUAGE lang, DisplayMessages.DISPLAY_MESSAGE_IDENTIFIER id, ref string line1, ref string line2) |
Properties | |
static IDT_UniPayI_V | SharedController [get] |
Class for UniPayI_V MSR/ICC reader
RETURN_CODE IDTechSDK.IDT_UniPayI_V.config_getEncryptionControl | ( | ref bool | msr, |
ref bool | icc, | ||
string | ident = "" |
||
) |
Get Encryption Control
Get Encryption Control to switch status between MSR and ICC/EMV function. Following Encryption status supported:
msr |
|
icc |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.config_getSerialNumber | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Serial Number
response | Returns Serial Number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.config_setEncryptionControl | ( | bool | msr, |
bool | icc, | ||
string | ident = "" |
||
) |
Set Encryption Control
Set Encryption Control to switch status between MSR and ICC/EMV function. Following Encryption status supported:
msr |
|
icc |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
timeout | Timeout value in seconds. |
tags | The tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_enablePassThrough | ( | bool | enablePassThrough, |
string | ident = "" |
||
) |
Enable Pass Through
Enables Pass Through Mode for direct communication with L1 interface (power on icc, send apdu, etc).
enablePassThrough | true = pass through ON, false = pass through OFF |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_getAnyRKIStatus | ( | bool | isMultiKey, |
ref string | status, | ||
ref Dictionary< string, RKI_KEY_TYPE > | keys, | ||
string | ident = "" |
||
) |
Get RKI Status Polls the RKI servers to validate device RKI eligiblity. Note: if device type is known in advance (production or demo device), it is more efficient to use device_getRKIStatus instead
isMultiKey | True = MultiKey, False = SingleKey |
status | RKI status returned as a string |
keys | Returns all available keys |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_getConfigurationFromMemory | ( | ref string | json, |
string | ident = "" |
||
) |
Read Device Configuration From Memory Retrieves the ViVOconfig configuration data from memory after a successful device_readConfigurationToMemory
json | Returns the .json file data that can be saved to disk |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_getDRS | ( | ref byte[] | codeDRS, |
string | ident = "" |
||
) |
Get DRS Status
Gets the status of DRS(Destructive Reset). For TTK Version Only.
codeDRS | the data format is [DRS SourceBlk Number] [SourceBlk1] … [SourceBlkN] [DRS SourceBlk Number] is 2 bytes, format is NumL NumH. It is Number of [SourceBlkX] [SourceBlkX] is n bytes, Format is [SourceID] [SourceLen] [SourceData] [SourceID] is 1 byte [SourceLen] is 1 byte, it is length of [SourceData] |
[SourceID] [SourceLen] [SourceData] 00 1 01 – Application Error 01 1 01 – Application Error 02 1 0x01 – EMV L2 Configuration Check Value Error 0x02 – Future Key Check Value Error 10 1 01 – Battery Error 11 1 Bit 0 – Tamper Switch 1 (0-No, 1-Error, string ident = "") Bit 1– Tamper Switch 2 (0-No, 1-Error, string ident = "") Bit 2– Tamper Switch 3 (0-No, 1-Error, string ident = "") Bit 3– Tamper Switch 4 (0-No, 1-Error, string ident = "") Bit 4– Tamper Switch 5 (0-No, 1-Error, string ident = "") Bit 5– Tamper Switch 6 (0-No, 1-Error, string ident = "")
12 1 01 –TemperatureHigh or Low 13 1 01 –Voltage High or Low 1F 4 Reg31~24bits, Reg23~16bits, Reg15~8bits, Reg7~0bits
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_getFirmwareVersion | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Firmware Version
response | Response returned of Firmware Version |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
string IDTechSDK.IDT_UniPayI_V.device_getResponseCodeString | ( | RETURN_CODE | eCode | ) |
Get the description of response result.
eCode | the response result. |
the | string for description of response result |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_getRKIStatus | ( | bool | isProd, |
bool | isMultiKey, | ||
ref string | status, | ||
ref Dictionary< string, RKI_KEY_TYPE > | keys, | ||
string | ident = "" |
||
) |
Get RKI Status From Specified Server Polls the RKI server to validate device RKI eligiblity
isProd | TRUE = poll production RKI server, FALSE = poll demo RKI server |
isMultiKey | True = MultiKey, False = SingleKey |
status | RKI status returned as a string |
keys | Returns dictionary of available keys |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_pingDevice | ( | string | ident = "" | ) |
Ping Device
Pings the reader. If connected, returns success. Otherwise, returns timeout.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_readConfigurationToMemory | ( | string | memo, |
Configs.InstallRules | rules, | ||
List< Configs.DeviceCommand > | cmds, | ||
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Read Device Configuration To Memory Executes a ViVOconfig read of device settings and stores the results in memory
Once a ViVOconfig read starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:
RETURN_CODE_SDK_VIVOCONFIG_READ_CONFIG_FAILED = Read process FAILED.
memo | Optional: populates the memo field of the captured .json file |
rules | Optional: populates the .json file with available install rules |
cmds | Optional: populates the .json file with commands to execute |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
isForeground | If TRUE, will block program until update complete. Otherwise, FALSE performs update on background. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_RemoteKeyInjection | ( | RKI_KEY_TYPE | type, |
string | keyName, | ||
string | ident = "" , |
||
bool | performOnForeground = false |
||
) |
Remote Key Injection Performs a remote key injection for the device
type | Remote Key Injection Type |
keyName | Name of key (optional) |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
performOnForeground | TRUE = block during process (default is false) |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_retrieveTerminalData | ( | ref byte[] | tlv, |
string | ident = "" |
||
) |
Retrieve Terminal Data
Retrieves the Terminal Data for CTLS. This is configuration group 0 (Tag FFEE - > FFEE0100). The terminal data can also be retrieved by ctls_getConfiguraitonGroup(0).
tlv | Response returned as a TLV |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_selfCheck | ( | string | ident = "" | ) |
Self check for TTK If Self-Test function Failed, then work into De-activation State. If device work into De-activation State, All Sensitive Data will be erased and it need be fixed in Manufacture.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendConfiguration | ( | string | filename, |
VC_OPERATION_TYPE | type, | ||
bool | matchFW, | ||
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Send Configuration Executes a ViVOconfig update or verify to a device
Once a ViVOconfig write or verify starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:
RETURN_CODE_SDK_VIVOCONFIG_WRITE_FAILED = Write process FAILED
filename | The .json configuration file to update the device with NOTE: You can also use this parameter to pass the path of where the .json file is located at on local storage instead |
filename | The name of the .json configuration file |
type | VC_OPERATION_TYPE |
matchFW | TRUE = Device FW must match file FW, FALSE = Don't validate device FW against file |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
isForeground | If TRUE, will block program until update complete. Otherwise, FALSE performs update on background. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendConfigurationFromZip | ( | byte[] | zip, |
string | filename, | ||
VC_OPERATION_TYPE | type, | ||
bool | matchFW, | ||
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Send Configuration From Zip Executes a ViVOconfig update or verify to a device using files from a .zip archive
Once a ViVOconfig write or update starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:
RETURN_CODE_SDK_VIVOCONFIG_WRITE_FAILED = Write process FAILED
zip | .Zip archive containing the .json configuration file and also any associated image assets NOTE: You can also use this parameter to pass the path of where the .zip file is located at on local storage instead |
filename | The name of the .json configuration file |
type | VC_OPERATION_TYPE |
matchFW | TRUE = Device FW must match file FW, FALSE = Don't validate device FW against file |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
isForeground | If TRUE, will block program until update complete. Otherwise, FALSE performs update on background. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendDataCommand | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response, | ||
string | ident = "" |
||
) |
Send a data command to the device
Sends a command to the device.
cmd | String representation of command to execute |
calcLRC | If TRUE , this will wrap command with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}' |
response | Response data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendDataCommand_ext | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ident = "" |
||
) |
Send a data command to the device - extended
Sends a command to the device.
cmd | String representation of command to execute |
calcLRC | If TRUE , this will wrap command as NGA with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}' |
response | Response data |
timeout | Timeout value waiting for response, in milliseconds (1000 = 1 second, string ident = "") |
noResponse | if TRUE, this will not wait for a response and immediately return SUCCESS |
calcITP | If TRUE , this will wrap command as ITP with start/end/lrc: '{STX} data {ETX}{CheckLRC}' |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendPAE | ( | string | command, |
ref string | response, | ||
int | timeout, | ||
string | ident = "" |
||
) |
Send Payment Application Engine Command
Executes a PAE command
command | ASCII command string, should start with "*PAE" |
response | command response |
timeout | timeout waiting for PAE response |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendVivoCommandP2 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ident = "" |
||
) |
Send Vivo Command Protocol 2
Sends a protocol 2 command to Vivo readers (IDG/NEO, string ident = "")
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendVivoCommandP2_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ident = "" |
||
) |
Send Vivo Command Protocol 2 Extended
Sends a protocol 2 command to Vivo readers (IDG/NEO, string ident = "")
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds, string ident = "") |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_setBurstMode | ( | byte | mode, |
string | ident = "" |
||
) |
Send Burst Mode
Sets the burst mode forthe device.
mode | 0 = OFF, 1 = Always On, 2 = Auto Exit |
NOTE: USB-KB mode is identical to USB-HID mode except for the following:
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_setPollMode | ( | byte | mode, |
string | ident = "" |
||
) |
Send Poll Mode
Sets the poll mode forthe device. Auto Poll keeps reader active, Poll On Demand only polls when requested by terminal
mode | 0 = Auto Poll, 1 = Poll On Demand |
NOTE: USB-KB mode is identical to USB-HID mode except for the following:
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_setTerminalData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Terminal Data
Sets the Terminal Data for CTLS as specified by the TLV. The first TLV must be Configuration Group Number (Tag FFE4). The terminal global data is group 0, so the first TLV would be FFE40100. Other groups can be defined using this method (1 or greater), and those can be retrieved with emv_getConfigurationGroup(int group), and deleted with emv_removeConfigurationGroup(int group). You cannot delete group 0.
tlv | TerminalData configuration data |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:( string ident = "") |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_startRKI | ( | string | ident = "" | ) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_StartRKI | ( | int | type, |
string | ident = "" |
||
) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers. Set/Get RKI url with IDT_Device.RKI_URL.
type | 0 = Symmetric RKI Demo Unit 1 = Symmetric RKI Production Unit 2 = PKI-RKI Demo Unit 3 = PKI-RKI Production Unit |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
amount | Transaction amount value (tag value 9F02, string ident = "") |
amtOther | Other amount value, if any (tag value 9F03, string ident = "") |
exponent | Number of characters after decimile point |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 If tags 9F02 (amount),9F03 (other amount), or 9C (transaction type) are included, they will take priority over these values supplied as individual parameters to this method. |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_updateDeviceFirmware | ( | byte[] | firmwareData, |
string | ident = "" |
||
) |
Update Firmware
Updates the firmware .
firmwareData | Signed binary data of a firmware file provided by IDTech |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
After you pass the firmwareData file, a new thread will start to execute the firmware download. You will receive status of the progress through callbacks to the IDTechSDK.Callback() delegate. The following parameters will be passed back:
Example code starting a firmware update
Example monitoring firmware update status / success
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_updateFirmwareFromZip | ( | byte[] | zipfile, |
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Update Firmware From Zip
Performs one or more device firmware updates from firmware files passed as a compressed archive with a valid configuration file (.json format)
zipfile | Zip file containing on or more firmware update files and a .json configuration file |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
isForeground | If TRUE, will block program until firmware update complete. Otherwise, FALSE performs FW update on background. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
timeout | Timeout value in seconds. |
tags | The tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_addTerminalData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Add Terminal Data
Adds to the exosting Terminal Data
tlv | TerminalData TLV Data |
ident | Optional identifier |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
|
static |
Allow fallback for EMV transactions. Default is TRUE
allow | TRUE = allow fallback, FALSE = don't allow fallback |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_authenticateTransaction | ( | byte[] | updatedTLV, |
string | ident = "" |
||
) |
Authenticate EMV Transaction Request
Authenticates the EMV transaction for an ICC card. Execute this after receiving response with result code 0x10 to emv_startTransaction
The tags will be returned in the callback routine.
@param updatedTLV TLV stream that can be used to update the following values: - 9F02: Amount - 9F03: Other amount - 9C: Transaction type - 5F57: Account type In addition tag DFEE1A can be sent to specify tag list to include in results. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 @param ident Device ID to send command to. If not specified, current SDK default device will be used.
|
static |
Enables authenticate for EMV transactions. If a startEMVTranaction results in code 0x0010 (start transaction success), then emv_authenticateEMVTransaction can automatically execute if parameter is set to TRUE
authenticate | TRUE = auto authenticate, FALSE = manually authenticate |
|
static |
Enables authenticate for EMV transactions. If a startEMVTranaction results in code 0x0010 (start transaction success), then emv_authenticateEMVTransaction can automatically execute if parameter is set to TRUE
authenticate | TRUE = auto authenticate, FALSE = manually authenticate |
tags | Tags to pass during authentication stage; |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_callbackResponseLCD | ( | EMV_LCD_DISPLAY_MODE | type, |
byte | selection, | ||
string | ident = "" |
||
) |
Callback Response LCD Display
Provides menu selection responses to the kernel after a callback was received with DeviceState.EMVCallback, and callbackType = EMV_CALLBACK_TYPE.EMV_CALLBACK_TYPE_LCD, and lcd_displayMode = EMV_LCD_DISPLAY_MODE_MENU, EMV_LCD_DISPLAY_MODE_PROMPT, or EMV_LCD_DISPLAY_MODE_LANGUAGE_SELECT
type | If Cancel key pressed during menu selection, then value is EMV_LCD_DISPLAY_MODE_CANCEL. Otherwise, value can be EMV_LCD_DISPLAY_MODE_MENU, EMV_LCD_DISPLAY_MODE_PROMPT, or EMV_LCD_DISPLAY_MODE_LANGUAGE_SELECT |
selection | If type = EMV_LCD_DISPLAY_MODE_MENU or EMV_LCD_DISPLAY_MODE_LANGUAGE_SELECT, provide the selection ID line number. Otherwise, if type = EMV_LCD_DISPLAY_MODE_PROMPT supply either 0x43 ('C') for Cancel, or 0x45 ('E') for Enter/accept |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_callbackResponseMSR | ( | byte[] | MSR, |
string | ident = "" |
||
) |
Callback Response MSR Entry
Provides MSR information to kernel after a callback was received with DeviceState.EMVCallback, and callbackType = EMV_CALLBACK_MSR
MSR | Swiped track data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_callbackResponsePIN | ( | EMV_PIN_MODE | type, |
byte[] | KSN, | ||
byte[] | PIN, | ||
string | ident = "" |
||
) |
Callback Response PIN Entry
Provides (or cancels) PIN entry information to kernel after a callback was received with DeviceState.EMVCallback, and callbackType = EMV_CALLBACK_TYPE_PINPAD
type | If Cancel key pressed during PIN entry, then value is EMV_PIN_MODE_CANCEL. Otherwise, value can be EMV_PIN_MODE_ONLINE_DUKPT, EMV_PIN_MODE_ONLINE_MKSK, or EMV_PIN_MODE_OFFLINE |
KSN | If enciphered PIN, this is either the PIN DUKPT Key (EMV_PIN_MODE_ONLINE_DUKPT) or PIN Session Key (EMV_PIN_MODE_ONLINE_MKSK), or PIN Pairing DUKPT key (EMV_PIN_MODE_OFFLINE, string ident = "") |
PIN | If encipherd PIN, this is encrypted PIN block. If device does not implement pairing function, this is plaintext PIN |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_cancelTransaction | ( | string | ident = "" | ) |
Cancel Transaction
Cancels the currently executing EMV transaction.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_completeTransaction | ( | bool | commError, |
byte[] | authCode, | ||
byte[] | iad, | ||
byte[] | tlvScripts, | ||
byte[] | tlv, | ||
string | ident = "" |
||
) |
Complete EMV Transaction Request
Completes the EMV transaction for an ICC card when online authorization request is received from emv_authenticateTransaction
The tags will be returned in the callback routine.
commError | Communication error with host. Set to TRUE if host was unreachable, or FALSE if host response received. If Communication error, authCode, iad, tlvScripts can be null. |
authCode | Authorization code from host. Two bytes. Example 0x3030. (Tag value 8A). Required |
iad | Issuer Authentication Data, if any. Example 0x11223344556677883030 (tag value 91). |
tlvScripts | 71/72 scripts, if any |
tlv | Additional TVL data to return with transaction results (if any, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
NOTE: There are three possible outcomes for Authorization Code: Approval, Refer To Bank, Decline. The kernel maps these three outcomes to valid authorization response codes using tag DFEE1B through 8 bytes: {2 bytes Approval Code}{2 bytes Referral Code}{2 bytes Decline Code}{2 bytes RFU} If your gateway uses "00" for Approval, "01" for Referral, and "05" for Decline, then DFEE1B 08 3030 3031 3035 0000 If you use an authorization code value that that is not defined in DFEE1B, the kernel will use the DECLINE value of DFEE1B by default.
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_getEMVConfigurationCheckValue | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for EMV Configuration Check Value
response | Response returned of Check Value of Configuration |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_getEMVKernelCheckValue | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for EMV Kernel Check Value
response | Response returned of Check Value of Kernel |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_getEMVKernelVersion | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for EMV Kernel Version
response | Response returned of Kernel Version |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_getEMVKernelVersionExt | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Extended EMV Kernel Version
response | Response returned of Kernel Version |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeAllApplicationData | ( | string | ident = "" | ) |
Remove All Application Data
Removes all the Application Data for EMV Kernel
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeAllCAPK | ( | string | ident = "" | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK for EMV Kernel
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeAllCRL | ( | string | ident = "" | ) |
Remove All Certificate Revocation List Entries
Removes all CRLEntry entries
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeApplicationData | ( | byte[] | AID, |
string | ident = "" |
||
) |
Remove Application Data by AID
Removes the Application Data for EMV Kernel as specified by the AID name passed as a parameter
AID | Name of ApplicationID Must be between 5 and 16 bytes |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeCAPK | ( | byte[] | capk, |
string | ident = "" |
||
) |
Remove Certificate Authority Public Key
Removes the CAPK for EMV Kernel as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeCRL | ( | byte[] | crlList, |
string | ident = "" |
||
) |
Remove Certificate Revocation List Entries
Removes CRLEntries as specified by the RID and Index and serial number passed as 9 bytes
crlList | containing the list of CRL to remove: [CRL1][CRL2]...[CRLn] where each [CRL] is 9 bytes: [5 bytes RID][1 byte CAPK Index][3 bytes serial number] |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeTerminalData | ( | string | ident = "" | ) |
Remove Terminal Data
Removes the Terminal Data
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveAIDList | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve AID list
Returns all the AID names installed on the terminal for EMV Kernel.
response | array of AID name byte arrays |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Retrieve Application Data by AID
Retrieves the Application Data for EMV Kernel as specified by the AID name passed as a parameter.
AID | Name of ApplicationID. Must be between 5 and 16 bytes |
tlv | The TLV elements of the requested AID |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveCAPK | ( | byte[] | capk, |
ref byte[] | key, | ||
string | ident = "" |
||
) |
Retrieve Certificate Authority Public Key
Retrieves the CAPK for EMV Kernel as specified by the RID/Index passed as a parameter.
capk | 6 bytes CAPK = 5 bytes RID + 1 byte Index |
key | Response returned as a CAKey format: [5 bytes RID][1 byte Index][1 byte Hash Algorithm][1 byte Encryption Algorithm][20 bytes HashValue][4 bytes Public Key Exponent][2 bytes Modulus Length][Variable bytes Modulus] Where:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveCAPKList | ( | ref byte[] | keys, |
string | ident = "" |
||
) |
Retrieve the Certificate Authority Public Key list
Returns all the CAPK RID and Index installed on the terminal for EMV Kernel.
keys | [key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveCRLList | ( | ref byte[] | list, |
string | ident = "" |
||
) |
Retrieve the Certificate Revocation List
Returns the CRL entries on the terminal.
list | [CRL1][CRL2]...[CRLn], each CRL 9 bytes where CRL = 5 bytes RID + 1 byte index + 3 bytes serial number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveTerminalData | ( | ref byte[] | tlv, |
string | ident = "" |
||
) |
Retrieve Terminal Data
Retrieves the Terminal Data for EMV Kernel.
tlv | Response returned as a TLV |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveTransactionResult | ( | byte[] | tags, |
ref IDTTransactionData | tlv, | ||
string | ident = "" |
||
) |
Retrieve Transaction Results
Retrieves specified EMV tags from the currently executing transaction.
tags | Tags to be retrieved. Example 0x9F028A will retrieve tags 9F02 and 8A |
tlv | All requested tags returned as unencrypted, encrypted and masked TLV data in IDDTransactionData object |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setApplicationData | ( | byte[] | name, |
byte[] | tlv, | ||
string | ident = "" |
||
) |
Set Application Data by AID
Sets the Application Data for EMV Kernel as specified by the application name and TLV data
name | Application name, 10-32 ASCII hex characters representing 5-16 bytes Example "a0000000031010" |
tlv | Application data in TLV format |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setCAPK | ( | byte[] | key, |
string | ident = "" |
||
) |
Set Certificate Authority Public Key
Sets the CAPK for EMV Kernel as specified by the CAKey structure
key | CAKey format: [5 bytes RID][1 byte Index][1 byte Hash Algorithm][1 byte Encryption Algorithm][20 bytes HashValue][4 bytes Public Key Exponent][2 bytes Modulus Length][Variable bytes Modulus] Where:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setCRL | ( | byte[] | list, |
string | ident = "" |
||
) |
Set Certificate Revocation List
Sets the CRL
list | CRL Entries containing the RID, Index, and serial numbers to set [CRL1][CRL2]...[CRLn] where each [CRL] is 9 bytes: [5 bytes RID][1 byte CAPK Index][3 bytes serial number] |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setTerminalData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Terminal Data
Sets the Terminal Data
tlv | TerminalData TLV Data |
ident | Optional identifier |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setTerminalMajorConfiguration | ( | int | configuration, |
string | ident = "" |
||
) |
Set Terminal Major Configuration
Sets the Terminal Data Major Configuration setting
configuration | The configuration to set (1-5, string ident = "") |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:( string ident = "") |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
amount | Transaction amount value (tag value 9F02, string ident = "") |
amtOther | Other amount value, if any (tag value 9F03, string ident = "") |
exponent | Number of characters after decimile point |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 If tags 9F02 (amount),9F03 (other amount), or 9C (transaction type) are included, they will take priority over these values supplied as individual parameters to this method. |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_trySetTerminalData | ( | byte[] | tlv, |
ref byte[] | rejectedTLV, | ||
ref byte[] | convertedTLV, | ||
bool | overwrite = false , |
||
string | ident = "" |
||
) |
Try to Set Terminal Data
Atempts to set the Terminal Data. Use this functions to attempt to set the terminal data to the device. This function will allow the cross-device tag compatible writing of IDTech Legacy/New tag definitions
tlv | TerminalData TLV Data |
rejectedTLV | Contains the tags (if any) that were rejected by the firmware |
convertedTLV | Contains the tags (if any) that were converted and accepted by the firmware |
overwrite | TRUE = add TLV to existing tags, FALSE = replace existing tags with TLV |
ident | Optional identifier |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
|
static |
Get Command Timeout
Gets the default timeout (in milliseconds) waiting for a blocking command response
time | Time |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.icc_exchangeAPDU | ( | string | c_APDU, |
ref byte[] | response, | ||
string | ident = "" |
||
) |
Exchange APDU
Sends an APDU packet to the ICC. If successful, response is returned in APDUResult class instance in response parameter.
c_APDU | APDU data packet |
response | Unencrypted/encrypted parsed APDU response |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.icc_getICCReaderStatus | ( | ref byte | status, |
string | ident = "" |
||
) |
Get Reader Status
Returns the reader status
status | Pointer that will return with the ICCReaderStatus results. bit 0: 0 = ICC Power Not Ready, 1 = ICC Powered bit 1: 0 = Card not seated, 1 = card seated |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.icc_powerOffICC | ( | string | ident = "" | ) |
Power Off ICC
Powers down the ICC
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
If Success, empty If Failure, ASCII encoded data of error string
RETURN_CODE IDTechSDK.IDT_UniPayI_V.icc_powerOnICC | ( | ref byte[] | ATR, |
byte | interfaces, | ||
string | ident = "" |
||
) |
Power On ICC
Power up the currently selected microprocessor card in the ICC reader
interfaces | For NEO2 devices allowed interfaces for which to get the ATR. 0x20h = retrieve last ATR received from PICC 0x21h = SAM1 (SRED version only, string ident = "") 0x22h = SAM2 (SRED version only, string ident = "") For other devices interfaces euquals to 0s |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
static |
Retrieve LCD Message
Returns the string value for a message ID returned for LCD messaging
lang | Language. |
id | Message ID |
line1 | Line 1 string value |
line2 | Line 2 string value |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.msr_cancelMSRSwipe | ( | string | ident = "" | ) |
Disable MSR Swipe Cancels MSR swipe request.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.msr_startMSRSwipe | ( | int | timeout, |
string | ident = "" |
||
) |
Enable MSR Swipe
Enables MSR, waiting for swipe to occur.
timeout | Swipe Timeout Value |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPayI_V.msr_switchUSBInterfaceMode | ( | bool | bIsUSBKeyboardMode | ) |
Switch the USB interface mode between USB HID and USB KB mode.
For Non-SRED Augusta Only
bIsUSBKeyboardMode | USB interface mode
|
RETURN_CODE IDTechSDK.IDT_UniPayI_V.msr_switchUSBInterfaceMode | ( | bool | bIsUSBKeyboardMode, |
ref string | ident | ||
) |
Switch the USB interface mode between USB HID and USB KB mode.
For Non-SRED Augusta Only
bIsUSBKeyboardMode | USB interface mode
|
ident | Device ID to send command to. |
|
static |
SDK Version
Returns the current version of SDK
|
static |
Set Callback
Sets the class callback
|
static |
Set Callback
Sets the class callback
my_Callback | The callback function to receive the response message from device. defined as follows. public unsafe delegate void MFCCallBack(Parameters parameters, ident); |
context | The context of the UI thread |
|
static |
Set Command Timeout
Sets the default timeout (in milliseconds) waiting for a blocking command response
milliseconds | Time |
|
staticget |
Singleton Instance
Establishes an singleton instance of IDT_UniPayI_V class.