![]() |
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_getFirmwareVersion (ref string response, string ident="") |
RETURN_CODE | device_setQuickChipHIDMode (byte mode, 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_startMSRSwipe (int timeout, string ident="") |
RETURN_CODE | msr_cancelMSRSwipe (string ident="") |
RETURN_CODE | emv_cancelTransaction (string ident="") |
RETURN_CODE | ctls_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 | emv_authenticateTransaction (byte[] updatedTLV, string ident="") |
RETURN_CODE | ctls_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ident="") |
RETURN_CODE | ctls_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 isFastEMV=false, string ident="") |
RETURN_CODE | device_activateTransaction (int timeout, byte[] tags, bool isFastEMV=false, 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_getEMVKernelCheckValue (ref string response, string ident="") |
RETURN_CODE | emv_getEMVConfigurationCheckValue (ref string response, 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 | ctls_removeApplicationData (byte[] AID, string ident="") |
RETURN_CODE | emv_removeAllApplicationData (string ident="") |
RETURN_CODE | emv_removeCAPK (byte[] capk, string ident="") |
RETURN_CODE | ctls_removeCAPK (byte[] capk, string ident="") |
RETURN_CODE | emv_removeAllCAPK (string ident="") |
RETURN_CODE | ctls_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 | ctls_retrieveApplicationData (byte[] AID, ref byte[] tlv, string ident="") |
RETURN_CODE | emv_retrieveAIDList (ref byte[][] response, string ident="") |
RETURN_CODE | ctls_retrieveAIDList (ref byte[][] response, string ident="") |
RETURN_CODE | emv_retrieveCAPK (byte[] capk, ref byte[] key, string ident="") |
RETURN_CODE | ctls_retrieveCAPK (byte[] capk, ref byte[] key, string ident="") |
RETURN_CODE | emv_retrieveCAPKList (ref byte[] keys, string ident="") |
RETURN_CODE | ctls_retrieveCAPKList (ref byte[] keys, string ident="") |
RETURN_CODE | emv_retrieveCRLList (ref byte[] list, string ident="") |
RETURN_CODE | ctls_retrieveTerminalData (ref byte[] tlv, 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 | ctls_setApplicationData (byte[] tlv, string ident="") |
RETURN_CODE | ctls_setDefaultConfiguration (string ident="") |
RETURN_CODE | ctls_setConfigurationGroup (byte[] tlv, string ident="") |
RETURN_CODE | emv_setCAPK (byte[] key, string ident="") |
RETURN_CODE | ctls_setCAPK (byte[] key, string ident="") |
RETURN_CODE | emv_setCRL (byte[] list, string ident="") |
RETURN_CODE | emv_getTerminalMajorConfiguration (ref int configuration, string ident="") |
RETURN_CODE | emv_setTerminalMajorConfiguration (int configuration, 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 | ctls_setTerminalData (byte[] tlv, string ident="") |
RETURN_CODE | ctls_trySetTerminalData (byte[] tlv, ref byte[] rejectedTLV, ref byte[] convertedTLV, string ident="") |
RETURN_CODE | device_pingDevice (string ident="") |
RETURN_CODE | device_buzzer (string ident="") |
RETURN_CODE | device_cancelTransaction (string ident="") |
RETURN_CODE | device_setLED (byte indexLED, byte control, string ident="") |
RETURN_CODE | device_controlUserInterface (byte[] values, 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 | ctls_getConfigurationGroup (int group, ref byte[] tlv, string ident="") |
RETURN_CODE | ctls_removeConfigurationGroup (int group, string ident="") |
RETURN_CODE | ctls_getAllConfigurationGroups (ref byte[][] response, string ident="") |
RETURN_CODE | device_setBurstMode (byte mode, string ident="") |
RETURN_CODE | device_setPollMode (byte mode, string ident="") |
RETURN_CODE | device_getPollMode (ref byte mode, string ident="") |
RETURN_CODE | device_setMerchantRecord (int index, bool enabled, string merchantID, string merchantURL, string ident="") |
RETURN_CODE | device_startRKI (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="") |
string | device_getResponseCodeString (RETURN_CODE eCode) |
RETURN_CODE | device_getTransactionResults (ref IDTTransactionData results, string ident="") |
RETURN_CODE | config_getDate (ref int year, ref int month, ref int day, string ident="") |
RETURN_CODE | config_setDate (int year, int month, int day, string ident="") |
RETURN_CODE | config_getTime (ref int hour, ref int minute, string ident="") |
RETURN_CODE | config_setTime (int hour, int minute, string ident="") |
RETURN_CODE | device_setDateTime (string ident="") |
RETURN_CODE | device_getDateTime (ref byte[] dateTime, string ident="") |
RETURN_CODE | device_StartRKI (int type, string ident="") |
RETURN_CODE | device_getDrlReaderRiskPara (byte index, ref byte[] tlv, string ident="") |
RETURN_CODE | config_setEncryptionControl (bool msr, bool icc, string ident="") |
RETURN_CODE | config_getEncryptionControl (ref bool msr, ref bool icc, string ident="") |
bool | createFastEMVData (ref IDTTransactionData cData, string ident="") |
RETURN_CODE | device_controlLED (byte indexLED, byte control, string ident="") |
RETURN_CODE | device_getMerchantRecord (int index, ref byte[] record, string ident="") |
RETURN_CODE | device_rebootDevice (string ident="") |
RETURN_CODE | device_getProductType (ref byte[] type, string ident="") |
RETURN_CODE | device_getCashTranRiskPara (ref byte[] tlv, string ident="") |
RETURN_CODE | device_getHardwareInfor (ref string ascii, string ident="") |
RETURN_CODE | device_getModuleVer (ref string moduleVer, string ident="") |
RETURN_CODE | device_getUIDofMCU (ref string uid, string ident="") |
RETURN_CODE | device_getUsbBootLoader (ref string bootLoader, 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 bool | useSerialPort (int port) |
static bool | useSerialPort (int port, int baud) |
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 RETURN_CODE | device_updateDeviceFirmware (byte[] firmwareData, 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_VP3300 | SharedController [get] |
Class for VP4800 reader
RETURN_CODE IDTechSDK.IDT_VP3300.config_getDate | ( | ref int | year, |
ref int | month, | ||
ref int | day, | ||
string | ident = "" |
||
) |
Get Date Gets the date of the Real Time Clock
year | Valid values 0 - 9999 (example 2019, string ident = "") |
month | Valid values 1-12 |
day | Valid values 1-31 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.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_VP3300.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_VP3300.config_getTime | ( | ref int | hour, |
ref int | minute, | ||
string | ident = "" |
||
) |
Get Time Gets the time of the Real Time Clock
hour | Valid values 0-23 |
minute | Valid values 0-59 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
Set Time Sets the time of the Real Time Clock
hour | Valid values 0-23 |
minute | Valid values 0-59 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.config_setDate | ( | int | year, |
int | month, | ||
int | day, | ||
string | ident = "" |
||
) |
Set Date Sets the date of the Real Time Clock
year | Valid values 0 - 9999 (example 2019, string ident = "") |
month | Valid values 1-12 |
day | Valid values 1-31 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.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. |
bool IDTechSDK.IDT_VP3300.createFastEMVData | ( | ref IDTTransactionData | cData, |
string | ident = "" |
||
) |
Create Fast EMV Data
At the completion of a Fast EMV Transaction, after the final card decision is returned and the IDTTransactionData object is provided, sending that cData object to this method will populate the .fastEMV element with string data that represents the Fast EMV data that would be returned from and IDTech FastEMV over KB protocol
cData | The IDTTransactionData object populated with card data. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start a CTLS Transaction Request
Authorizes the CTLS transaction for an CTLS 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 | The other 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 |
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. |
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required, string ident = "") 9F26 = four bytes = ApplePay Terminal Capabilities Information (required, string ident = "")
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_cancelTransaction | ( | string | ident = "" | ) |
Cancel Transaction
Cancels the currently executing EMV or CTLS transaction.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_getAllConfigurationGroups | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve All Configuration Groups
Returns all the Configuration Groups installed on the terminal for CTLS
response | array of CTLS groups as TLV bytes |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_getConfigurationGroup | ( | int | group, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Get Configuration Group
Retrieves the Configuration for the specified Group. Group 0 = terminal settings.
group | Configuration Group |
tlv | return data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_removeAllCAPK | ( | string | ident = "" | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK for CTLS
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_removeApplicationData | ( | byte[] | AID, |
string | ident = "" |
||
) |
Remove Application Data by AID
Removes the Application Data for CTLS 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_VP3300.ctls_removeCAPK | ( | byte[] | capk, |
string | ident = "" |
||
) |
Remove Certificate Authority Public Key
Removes the CAPK for CTLS 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_VP3300.ctls_removeConfigurationGroup | ( | int | group, |
string | ident = "" |
||
) |
Remove Configuration Group
Removes the Configuration as specified by the Group. Must not by group 0
group | Configuration Group |
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_VP3300.ctls_retrieveAIDList | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve AID list
Returns all the AID names and their assigned groups installed on the terminal for CTLS.
response | array of TLV data objects: FFE4 (group name) followed by 9F06 (AID), and DFEE4F (Interface 01 = CTLS, 02 = CONTACT, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Retrieve Application Data by AID
Retrieves the CTLS Application Data 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_VP3300.ctls_retrieveCAPK | ( | byte[] | capk, |
ref byte[] | key, | ||
string | ident = "" |
||
) |
Retrieve Certificate Authority Public Key
Retrieves the CAPKfor CTLS 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_VP3300.ctls_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 CTLS.
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_VP3300.ctls_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_VP3300.ctls_setApplicationData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Application Data by AID
Sets the Application Data for CTLS as specified by TLV data
tlv | Application data in TLV format The first tag of the TLV data must be the group number (FFE4). The second tag of the TLV data must be the AID (9F06) |
Example valid TLV, for Group #2, AID a0000000035010: "ffe401029f0607a0000000051010ffe10101ffe50110ffe30114ffe20106"
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_setCAPK | ( | byte[] | key, |
string | ident = "" |
||
) |
Set Certificate Authority Public Key
Sets the CAPK for CTLS 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_VP3300.ctls_setConfigurationGroup | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Configuration Group
Sets the Configuration Group for CTLS as specified by the TLV data
tlv | Configuration Group Data in TLV format The first tag of the TLV data must be the group number (FFE4). A second tag must exist |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_setDefaultConfiguration | ( | string | ident = "" | ) |
Set Default Configuration Group
Resets the device to default CTLS configuration group settings
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_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_VP3300.ctls_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start a CTLS Transaction Request
Authorizes the CTLS transaction for an CTLS 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 |
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. |
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required, string ident = "") 9F26 = four bytes = ApplePay Terminal Capabilities Information (required, string ident = "")
RETURN_CODE IDTechSDK.IDT_VP3300.ctls_trySetTerminalData | ( | byte[] | tlv, |
ref byte[] | rejectedTLV, | ||
ref byte[] | convertedTLV, | ||
string | ident = "" |
||
) |
Try to Set CTLS Terminal Data
Atempts to set the CTLS 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 |
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_VP3300.device_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start a Transaction Request
Authorizes the transaction CTLS, MSR or Contact EMV
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 |
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. |
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required, string ident = "") 9F26 = four bytes = ApplePay Terminal Capabilities Information (required, string ident = "")
RETURN_CODE IDTechSDK.IDT_VP3300.device_buzzer | ( | string | ident = "" | ) |
Buzzer Device
Buzzer the reader. If success can hear one beep. Otherwise, returns timeout.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_cancelTransaction | ( | string | ident = "" | ) |
Cancel Transaction
Cancels the currently executing device transaction.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_controlLED | ( | byte | indexLED, |
byte | control, | ||
string | ident = "" |
||
) |
Control LED
Controls the LED for the reader. This command will only operate in pass-through mode
indexLED | For LED
|
control | LED Status:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_controlUserInterface | ( | byte[] | values, |
string | ident = "" |
||
) |
Control User Interface
Controls the User Interface: Display, Beep, LED
values | Four bytes to control the user interface Byte[0] = LCD Message Messages 00-07 are normally controlled by the reader.
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.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_VP3300.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_VP3300.device_getCashTranRiskPara | ( | ref byte[] | tlv, |
string | ident = "" |
||
) |
Get Cash Transaction Reader Risk Parameters Returns the TTQ and reader risk parameters that will be used for cash transactions, if enabled.
tlv | TLV Data Objects |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.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_VP3300.device_getDateTime | ( | ref byte[] | dateTime, |
string | ident = "" |
||
) |
Get Date Time
Gets current system date and time of the device.
dateTime | The date time returned as follows:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_getDrlReaderRiskPara | ( | byte | index, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Get DRL Reader Risk Parameters Get the Index, Application Program ID, and reader risk parameters for the DRL settings.
index | DRL index (01-04, string ident = "") |
tlv | TLV Data Objects |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.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. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_getHardwareInfor | ( | ref string | ascii, |
string | ident = "" |
||
) |
Get Hardware Information
ascii | the ascii charactor |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
HW,VPVendi<CR><LF>K21F Rev9 | Vendi HW,VP3300 Audio Jack<CR><LF>K21F Rev9 | Unipay III HW,VPUnipay1.5<CR><LF>K21F Rev9 | Unipay 1.5 HW,VPUniPay1.5TTK<CR><LF>K21F Rev9 | UniPay 1.5 TTK HW,VP3300 USB<CR><LF>K21F Rev9 | VP3300 USB, VP3300 USB OEM (iBase/Cake same code, string ident = "") HW,VP3300 USB-E<CR><LF>K21F Rev9 | VP3300 USB-E HW,VP3300 USB-C<CR><LF>K21F Rev9 | VP3300 USB-C HW,VPVP3300 Bluetooth<CR><LF>K21F Rev9 | VP3300 Bluetooth HW,.VP6300<CR><LF>K81F.Rev4 | VP6300
RETURN_CODE IDTechSDK.IDT_VP3300.device_getMerchantRecord | ( | int | index, |
ref byte[] | record, | ||
string | ident = "" |
||
) |
Get Merchant Record Gets the merchant record for ApplePay VAS
index | Merchant Record index, valid values 1-6 |
record | Data returned containing 99 bytes: Byte 0 = Merchand Index Byte 1 = Merchant Enabled (1 = enabled, string ident = "") Byte 2 - 33 = Merchant Protocol Hash-256 value Byte 34 = Length of Merchant URL Bytes 35 - 99 = URL |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_getModuleVer | ( | ref string | moduleVer, |
string | ident = "" |
||
) |
Get Module Version Information Get the 16 byte UID of MCU
uid | string UID |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_getPollMode | ( | ref byte | mode, |
string | ident = "" |
||
) |
Get Poll Mode
Gets the poll mode for the device.
mode | : 00h = Auto Poll (USB I/F auto set to USB/HID, string ident = "") 01h = Poll on Demand (USB I/F auto set to USB/HID, string ident = "") 02h = QuickChip (USB I/F auto set to USB KB, string ident = "") 03h = QuickChip (enable QuickChip for CT + MSR, string ident = "") 04h = QuickChip (enable QuickChip for CL + MSR, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_getProductType | ( | ref byte[] | type, |
string | ident = "" |
||
) |
Get Product Type Returns a "product type" value in a proprietary TLV
type | product type |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
42 37 00 | ViVOpay 5000 43 33 00 | ViVOpay 4500 43 35 00 | ViVOpay Vend 43 36 00 | Vendi (NEO, string ident = "") 43 37 00 | ViVOpay Kiosk1 (ATM1, string ident = "") 43 38 00 | Kiosk2 43 39 00 | Kiosk3 (NEO, string ident = "") 55 31 00 | UniPay 1.5 (NEO, string ident = "") 55 33 00 | UniPay III (NEO) 55 33 31 | VP3300, VP3300 OEM (NEO) (iBase/Cake same code, string ident = "") 55 33 32 | VP3300E(NEO, string ident = "") 55 33 33 | VP3300C(NEO, string ident = "") 55 33 34 | BTPay Mini (NEO) (UniPayIII + BLE, string ident = "") 56 31 00 | VP3600 56 32 00 | VP5200 56 33 00 | VP5300 56 34 00 | VP6300 56 35 00 | VP6800 56 36 00 | VP8300 56 37 00 | VP8310 56 38 00 | VP8800 56 39 00 | VP8810 56 40 00 | VP9000 44 30 00 | QX120 44 31 00 | Mx8Series 44 32 00 | NETs 44 33 00 | Magtek 44 35 00 | ICP
string IDTechSDK.IDT_VP3300.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_VP3300.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_VP3300.device_getTransactionResults | ( | ref IDTTransactionData | results, |
string | ident = "" |
||
) |
Get Transaction Results Gets the transaction results when the reader is functioning in "Auto Poll" mode
results | The transaction results |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_getUIDofMCU | ( | ref string | uid, |
string | ident = "" |
||
) |
Get UID of MCU
moduleVer | module version information |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_getUsbBootLoader | ( | ref string | bootLoader, |
string | ident = "" |
||
) |
Get USB Boot Loader Version Get the version of the USB Boot Loader
bootLoader | USB boot loader information |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.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_VP3300.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_VP3300.device_rebootDevice | ( | string | ident = "" | ) |
Reboot Device
Performs a reboot of the device
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.device_setBurstMode | ( | byte | mode, |
string | ident = "" |
||
) |
Send Burst Mode
Sets the burst mode forthe device.
mode | 0 = OFF, 1 = Always On, 2 = Auto Exit |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_setDateTime | ( | string | ident = "" | ) |
Set Date Time
Set current system date and time to the device.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_setLED | ( | byte | indexLED, |
byte | control, | ||
string | ident = "" |
||
) |
Set LED
Control the reader. If connected, returns success. Otherwise, returns timeout. indexLED description as follows: 00h: LED 0 (Power LED, string ident = "") 01h: LED 1 02h: LED 2 03h: LED 3 10h: Single Tri-Color LED (Unipay III used, string ident = "") FFh: All 4 LEDs + Single Tri-Color LED Where the LEDs are numbered 0, 1, 2, 3 counting from the left. Note: If you are using pass-through mode to control the Power LED (LED 0), it is your responsibility to make sure that it behaves correctly. control description as follows: 00h: LED Off (LED 0~4 + Tri-Color LED, string ident = "") 01h: LED On (LED 0~4, string ident = "") 02h: Green Color (Tri-Color LED, string ident = "") 03h: Red Color (Tri-Color LED, string ident = "") 04h: Amber Color(Tri-Color LED, string ident = "")
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_setMerchantRecord | ( | int | index, |
bool | enabled, | ||
string | merchantID, | ||
string | merchantURL, | ||
string | ident = "" |
||
) |
Set Merchant Record Sets the merchant record for ApplePay VAS
index | Merchant Record index, valid values 1-6 |
enabled | Merchant Enabled/Valid flag |
merchantID | Merchant unique identifer registered with Apple. Example com.idtechproducts.applePay |
merchantURL | Merchant URL, when applicable |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_setPollMode | ( | byte | mode, |
string | ident = "" |
||
) |
Set Poll Mode
Sets the poll mode for the device. Auto Poll keeps reader active, Poll On Demand only polls when requested by terminal
mode | : 00h = Auto Poll (USB I/F auto set to USB/HID, string ident = "") 01h = Poll on Demand (USB I/F auto set to USB/HID, string ident = "") 02h = QuickChip (USB I/F auto set to USB KB, string ident = "") 03h = QuickChip (enable QuickChip for CT + MSR, string ident = "") 04h = QuickChip (enable QuickChip for CL + MSR, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.device_setQuickChipHIDMode | ( | byte | mode, |
string | ident = "" |
||
) |
Set QuickChip HID Mode
Puts the device into QuickChip KB Output Mode while in HID
mode |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.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_VP3300.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_VP3300.device_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start a Transaction Request
Authorizes the transaction CTLS, MSR or Contact EMV
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. |
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. |
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required, string ident = "") 9F26 = four bytes = ApplePay Terminal Capabilities Information (required, string ident = "")
|
static |
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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.emv_cancelTransaction | ( | string | ident = "" | ) |
Cancel Transaction
Cancels the currently executing EMV or CTLS transaction.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.emv_getTerminalMajorConfiguration | ( | ref int | configuration, |
string | ident = "" |
||
) |
Get Terminal Major Configuration
Gets the Terminal Data Major Configuration setting
configuration | The configuration that is set (1-5, string ident = "") |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_NEO2::device_getResponseCodeString:( string ident = "") |
RETURN_CODE IDTechSDK.IDT_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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_VP3300.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. |
|
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 |
|
static |
Use Serial Port Interface
Instructs SDK to attempt to use the Serial Port for communication with IDT_Vendi using default baud rate
port | Serial Port to use. Example COM1 = 1. |
|
static |
Use Serial Port Interface with baud rate
Instructs SDK to attempt to use the Serial Port for communication with IDT_Vendi
port | Serial Port to use. Example COM1 = 1. |
baud | Baud rate to override default. Example 115200; |
|
staticget |
Singleton Instance
Establishes an singleton instance of IDT_VP3300 class.