![]() |
IDTech Windows SDK Guide
3.2.4.393
API reference for Visual Studio .Net
|
Public Member Functions | |
RETURN_CODE | config_setEthernetMACAddress (byte[] address, string ident="") |
RETURN_CODE | config_getEthernetMACAddress (ref byte[] address, string ident="") |
RETURN_CODE | config_getPINKeySlot (ref int slot, string ident="") |
RETURN_CODE | config_setPINKeySlot (int slot, string ident="") |
RETURN_CODE | config_getDataKeySlot (ref int slot, string ident="") |
RETURN_CODE | config_setDataKeySlot (int slot, string ident="") |
RETURN_CODE | config_getStatusKeySlots (ref byte[] keyslots, string ident="") |
RETURN_CODE | config_getKeySlotInfo (int index, int slot, ref byte[] keyslot, string ident="") |
RETURN_CODE | config_getNetworkConfiguration (ref bool isStatic, ref string address, ref string subnet, ref string gateway, ref string dns, string ident="") |
RETURN_CODE | config_setNetworkConfiguration (bool isStatic, string address, string subnet, string gateway, string dns, string ident="") |
RETURN_CODE | config_getSerialNumber (ref string response, string ident="") |
RETURN_CODE | device_getFirmwareVersion (ref string response, string ident="") |
RETURN_CODE | device_getMerchantRecord (int index, ref byte[] record, string ident="") |
RETURN_CODE | device_retrieveAIDList (ref byte[][] response, 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_flushTrackData (string ident="") |
RETURN_CODE | msr_startMSRSwipe (int timeout, string ident="") |
RETURN_CODE | lcd_customDisplayMode (bool enable, string ident="") |
RETURN_CODE | lcd_displayText (int xCord, int yCord, int xWidth, int yWidth, int font, int style, int displayProp, string text, ref byte[] identifier, string ident="") |
RETURN_CODE | lcd_displayButton (int xCord, int yCord, int xWidth, int yWidth, int font, int style, int displayProp, string text, ref byte[] identifier, byte[] foreRGB=null, byte[] backRGB=null, string ident="") |
RETURN_CODE | device_updateDeviceFirmware (byte[] firmwareData, string ident="") |
RETURN_CODE | device_startRKI (bool isTest, string ident="") |
RETURN_CODE | lcd_setForeBackColor (byte[] foreRGB, byte[] backRGB, string ident="") |
RETURN_CODE | lcd_captureSignature (int timeout, int format, string ident="") |
RETURN_CODE | lcd_clearInputEvents (string ident="") |
RETURN_CODE | lcd_getInputEvent (byte timeout, string ident="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ident="") |
RETURN_CODE | lcd_resetInitialState (string ident="") |
RETURN_CODE | msr_cancelMSRSwipe (string ident="") |
RETURN_CODE | emv_cancelTransaction (string ident="") |
RETURN_CODE | ctls_cancelTransaction (string ident="") |
RETURN_CODE | ctls_displayOnlineAuthResult (bool isOK, byte[] TLV, string ident="") |
RETURN_CODE | ctls_displayOnlineAuthResult_ext (byte statusCode, byte[] TLV, string ident="") |
RETURN_CODE | emv_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, string ident="") |
RETURN_CODE | emv_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | emv_continueTransactionForCV (int result, byte[] pinblock, 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 | ctls_activateTransaction (int timeout, byte[] tags, bool forceOnline, 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_clearTransactionLog (string ident="") |
RETURN_CODE | emv_getCRLStatus (ref byte[] status, string ident="") |
RETURN_CODE | emv_getTransactionLogRecord (ref byte[] record, ref int remaining, string ident="") |
RETURN_CODE | emv_getExemptionLogStatus (ref byte[] status, string ident="") |
RETURN_CODE | emv_getTransactionLogStatus (ref byte[] status, string ident="") |
RETURN_CODE | emv_getEMVConfigurationCheckValue (ref string response, string ident="") |
RETURN_CODE | emv_getEMVKernelVersionExt (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_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[] crl, 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_removeTerminalData (string ident="") |
RETURN_CODE | emv_removeTransactionAmountLog (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 | device_controlLED (byte indexLED, byte control, string ident="") |
RETURN_CODE | ctls_retrieveCAPKList (ref byte[] keys, string ident="") |
RETURN_CODE | emv_retrieveCRLList (ref byte[] list, string ident="") |
RETURN_CODE | emv_retrieveExceptionList (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_setApplicationData (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[] crl, string ident="") |
RETURN_CODE | emv_setException (byte[] exception, string ident="") |
RETURN_CODE | emv_removeException (byte[] exception, string ident="") |
RETURN_CODE | emv_removeAllExceptions (string ident="") |
RETURN_CODE | emv_trySetTerminalData (byte[] tlv, ref byte[] rejectedTLV, ref byte[] convertedTLV, bool overwrite=false, string ident="") |
RETURN_CODE | emv_setTerminalDataVP8800 (byte[] tlv, int config, 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_calibrateParameters (byte delta, string ident="") |
RETURN_CODE | device_cancelTransaction (string ident="") |
RETURN_CODE | device_controlIndicator (int indicator, bool enable, 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 | device_sendVivoCommandP3 (byte command, byte subCommand, byte[] data, ref byte[] response, string ident="") |
RETURN_CODE | device_sendVivoCommandP3_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 | emv_getConfigurationGroup (int group, ref byte[] tlv, string ident="") |
RETURN_CODE | device_getConfigurationGroup (int group, ref byte[] tlv, string ident="") |
RETURN_CODE | emv_resetConfigurationGroup (int group, string ident="") |
RETURN_CODE | device_resetConfigurationGroup (int group, string ident="") |
RETURN_CODE | ctls_resetConfigurationGroup (int group, string ident="") |
RETURN_CODE | ctls_removeConfigurationGroup (int group, string ident="") |
RETURN_CODE | emv_removeConfigurationGroup (int group, string ident="") |
RETURN_CODE | device_removeConfigurationGroup (int group, string ident="") |
RETURN_CODE | device_setBurstMode (byte mode, string ident="") |
RETURN_CODE | device_listDirectory (string directoryName, bool recursive, bool onSD, ref string directory, string ident="") |
RETURN_CODE | device_createDirectory (string directoryName, string ident="") |
RETURN_CODE | device_transferFile (string fileName, byte[] file, bool isSD=false, string ident="") |
RETURN_CODE | device_getDriveFreeSpace (ref int free, ref int used, string ident="") |
RETURN_CODE | device_deleteFile (string filename, bool isSD=false, string ident="") |
RETURN_CODE | lcd_setBackgroundImage (string file, bool enable, string ident="") |
RETURN_CODE | lcd_setDisplayImage (string file, int posX, int posY, int posMode, bool touchEnable, bool clearScreen, string ident="") |
RETURN_CODE | lcd_startSlideShow (string files, int posX, int posY, int posMode, bool touchEnable, bool recursion, bool touchTerminate, int delay, int loops, bool clearScreen, string ident="") |
RETURN_CODE | device_deleteDirectory (string filename, string ident="") |
RETURN_CODE | device_setBuzzerLED (byte buzzer, byte led, bool ledON, string ident="") |
RETURN_CODE | device_setPollMode (byte mode, string ident="") |
RETURN_CODE | device_setMerchantRecord (int index, bool enabled, string merchantID, string merchantURL, string ident="") |
RETURN_CODE | device_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, byte[] options, bool isFastEMV=false, int transMode=0, string ident="") |
RETURN_CODE | device_activateTransaction (int timeout, byte[] tags, byte[] options, bool isFastEMV=false, 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 | pin_getEncryptedOnlinePIN (int keyType, int timeout, string ident="") |
RETURN_CODE | pin_promptCreditDebit (object currencySymbol, string displayAmount, int timeout, string ident="") |
RETURN_CODE | pin_getPAN (bool getCSC, int timeout, string ident="") |
RETURN_CODE | device_StartRKI (int type, string ident="") |
RETURN_CODE | felica_authentication (byte[] key, string ident="") |
RETURN_CODE | felica_SendCommand (byte[] command, ref byte[] response, string ident="") |
RETURN_CODE | felica_readWithMac (int numBlocks, byte[] blockList, ref byte[] blocks, string ident="") |
RETURN_CODE | felica_writeWithMac (int blockNumber, byte[] data, string ident="") |
RETURN_CODE | felica_read (byte[] serviceCode, int numBlocks, byte[] blockList, ref byte[] blocks, string ident="") |
RETURN_CODE | felica_write (byte[] serviceCode, int blockCount, byte[] blockList, byte[] data, ref byte[] statusFlag, string ident="") |
RETURN_CODE | ctls_nfcCommand (byte[] nfcCmdPkt, ref byte[] response, string ident="") |
RETURN_CODE | felica_requestService (byte[] nodeCode, ref byte[] response, string ident="") |
bool | createFastEMVData (ref IDTTransactionData cData, 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 bool | useSerialPort (int port) |
static int | getCommandTimeout (string ident="") |
static void | setCommandTimeout (int milliseconds, string ident="") |
static bool | useSerialPort (int port, int baud, string ident="") |
static bool | useSerialPortLinux (string path) |
static bool | useSerialPortLinux (string path, int baud) |
static void | initSC () |
static void | setCallback (CallBack my_Callback) |
static void | setCallback (IntPtr my_Callback, SynchronizationContext context) |
static String | SDK_Version () |
static RETURN_CODE | lcd_clearDisplay (string ident="") |
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_VP8800 | SharedController [get] |
RETURN_CODE IDTechSDK.IDT_VP8800.config_getDataKeySlot | ( | ref int | slot, |
string | ident = "" |
||
) |
Get Data Key Slot
Returns the current key slot (in index #2) being used for Data encryption
slot | Current key slot, valid values 0-9 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.config_getEthernetMACAddress | ( | ref byte[] | address, |
string | ident = "" |
||
) |
Get Device Ethernet MAC Address
address | 6-byte MAC Address |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.config_getKeySlotInfo | ( | int | index, |
int | slot, | ||
ref byte[] | keyslot, | ||
string | ident = "" |
||
) |
Get Key Slot Info
This command checks whether a valid DUKPT key is stored at the specified index and slot and if a valid key is found then some basic information related to the type of key is returned
index | Key index: 0x01 = PIN, 0x02 = Data, 0x05 = MAC, 0x14 = KEK |
slot | Key Slot: PIN/Data = 0-9, MAC = 0, KEK = 0 Key Slot Data. If 0x00, no key at the slot, otherwise:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.config_getNetworkConfiguration | ( | ref bool | isStatic, |
ref string | address, | ||
ref string | subnet, | ||
ref string | gateway, | ||
ref string | dns, | ||
string | ident = "" |
||
) |
Get Device Network Configuration
isStatic | TRUE = Static IP, FALSE = DHCP |
address | Device IP Address as string. Example "192.168.1.15" |
subnet | Device Subnet as string. Example "255.255.255.0" |
gateway | Device Gateway address as a string. Example "8.8.8.8" |
dns | Device DNS address as string. Example "192.168.1.22" |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.config_getPINKeySlot | ( | ref int | slot, |
string | ident = "" |
||
) |
Get PIN Key Slot
Returns the current key slot (in index #1) being used for PIN encryption
slot | Current key slot, valid values 0-9 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.config_getStatusKeySlots | ( | ref byte[] | keyslots, |
string | ident = "" |
||
) |
Get status of the key slots
There are 10 keyslots for PIN Key at Index 1, slot #0-9 There are 10 keyslots for DATA Key at Index 2, slots #0-9 There is a keyslot for MAC Key at Index 5, slot 0 There is a keyslot for Key Encryption Key at Index 14, slot 0
This routine will return all the key slots values as one continuous byte[] of 4-byte key slot info.
keySlots | Key slot data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.config_setDataKeySlot | ( | int | slot, |
string | ident = "" |
||
) |
Set Data Key Slot
Sets the key slot to use for Data encryption (in index #2, string ident = "")
slot | Key slot to use, valid values 0-9 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.config_setEthernetMACAddress | ( | byte[] | address, |
string | ident = "" |
||
) |
Set Device Ethernet MAC Address
address | 6-byte MAC Address |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.config_setNetworkConfiguration | ( | bool | isStatic, |
string | address, | ||
string | subnet, | ||
string | gateway, | ||
string | dns, | ||
string | ident = "" |
||
) |
Set Device Network Configuration
isStatic | TRUE = Static IP, FALSE = DHCP |
address | Device IP Address as string. Example "192.168.1.15" |
subnet | Device Subnet as string. Example "255.255.255.0" |
gateway | Device Gateway address as a string. Example "8.8.8.8" |
dns | Device DNS address as string. Example "192.168.1.22" |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.config_setPINKeySlot | ( | int | slot, |
string | ident = "" |
||
) |
Set PIN Key Slot
Sets the key slot to use for PIN encryption (in index #1, string ident = "")
slot | Key slot to use, valid values 0-9 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
bool IDTechSDK.IDT_VP8800.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_VP8800.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.
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 |
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_VP8800.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_VP8800.ctls_displayOnlineAuthResult | ( | bool | isOK, |
byte[] | TLV, | ||
string | ident = "" |
||
) |
Display Online Authorization Result
Use this command to display the status of an online authorization request on the reader’s display (OK or NOT OK). Use this command after the reader sends an online request to the issuer.
isOK | TRUE = OK, FALSE = NOT OK, string ident = "") |
TLV | Optional TLV for AOSA |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.ctls_displayOnlineAuthResult_ext | ( | byte | statusCode, |
byte[] | TLV, | ||
string | ident = "" |
||
) |
Display Online Authorization Result Extended
Use this command to display the status of an online authorization request on the reader’s display (OK, NOT OK or ARC). Use this command after the reader sends an online request to the issuer.
statusCode | 0 = NOT OK, 1 = OK, 2 = ARC |
TLV | Optional TLV for AOSA |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.ctls_nfcCommand | ( | byte[] | nfcCmdPkt, |
ref byte[] | response, | ||
string | ident = "" |
||
) |
NFC Command
This command uses nfcCmdPkt[0] in command data field to implement different functions. This command should be used in Pass-Through mode and command with “Poll for a NFC Tag” data should be used first. Command with other data can only be used once the “Poll for a NFC Tag” command has indicated that a NFC tag is present.
nfcCmdPkt | System Code
|
response | Response as explained in FeliCA Lite-S User's Manual |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.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_VP8800.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_VP8800::device_getResponseCodeString:(string ident = "") |
RETURN_CODE IDTechSDK.IDT_VP8800.ctls_resetConfigurationGroup | ( | int | group, |
string | ident = "" |
||
) |
Reset Configuration Group
This command allows resetting a dataset to its default configuration. If the file exists, it will be overwritten. If not, it will be created.
group | Configuration Group |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_VP8800::device_getResponseCodeString:(string ident = "") |
RETURN_CODE IDTechSDK.IDT_VP8800.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: DFEE2D (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_VP8800.ctls_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Retrieve Application Data by AID
Retrieves the CTLS Application Data for System Default Group 0 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_VP8800.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: [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_VP8800.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_VP8800.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_VP8800.ctls_setApplicationData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Application Data by AID
Sets the Application Data as specified by TLV data
tlv | Application data in TLV format The first tag of the TLV data must be the group number (DFEE2D). Group 0 = System, all other Groups = User The second tag of the TLV data must be the AID (9F06) If tag DFEE4F is included, it must have a value of 0x01 to be a CTLS AID |
Example valid TLV, for Group #2, AID a0000000045010: "dfee2d01029f0607a0000000045010dfee4b0101dfee2e0110dfee4c0101dfee4f0101
Tags:
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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 (DFEE2D). 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_VP8800.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_VP8800.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 DFEE2D). The terminal global data is group 0, so the first TLV would be DFEE2D0100. 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_VP8800::device_getResponseCodeString:(string ident = "") |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.device_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
byte[] | options, | ||
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 |
options | Selects interface and other device options. Must be 4 bytes
|
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_VP8800.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_VP8800.device_calibrateParameters | ( | byte | delta, |
string | ident = "" |
||
) |
Calibrate reference parameters
delta | Delta value (0x02 standard default value, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.device_controlIndicator | ( | int | indicator, |
bool | enable, | ||
string | ident = "" |
||
) |
Control Indicators
Control the reader. If connected, returns success. Otherwise, returns timeout.
indicator | description as follows: 00h: ICC LED 01h: Blue MSR 02h: Red MSR 03h: Green MSR |
enable | TRUE = ON, FALSE = OFF |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.device_createDirectory | ( | string | directoryName, |
string | ident = "" |
||
) |
Create Directory
This command adds a subdirectory to the indicated path.
directoryName | Directory Name. The data for this command is a ASCII string with the complete path and directory name you want to create. You do not need to specify the root directory. Indicate subdirectories with a forward slash (/). |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.device_deleteDirectory | ( | string | filename, |
string | ident = "" |
||
) |
Delete Directory
This command deletes an empty directory.
filename | Complete path and file name of the directory you want to delete. You do not need to specify the root directory. Indicate subdirectories with a forward slash (/). |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.device_deleteFile | ( | string | filename, |
bool | isSD = false , |
||
string | ident = "" |
||
) |
Delete File
This command deletes a file or group of files.
filename | Complete path and file name of the file you want to delete. You do not need to specify the root directory. Indicate subdirectories with a forward slash (/). |
isSD | TRUE = Delete from SDCard, FALSE = Delete from Flash |
ip | Optional: IP address to execute command on (for IP connected devices, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.device_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_VP8800.device_getDriveFreeSpace | ( | ref int | free, |
ref int | used, | ||
string | ident = "" |
||
) |
Drive Free Space
This command returns the free and used disk space on the flash drive.
free | Free bytes available on device |
used | Used bytes on on device |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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. |
string IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.device_listDirectory | ( | string | directoryName, |
bool | recursive, | ||
bool | onSD, | ||
ref string | directory, | ||
string | ident = "" |
||
) |
List Directory
This command retrieves a directory listing of user accessible files from the reader.
directoryName | Directory Name. If null, root directory is listed |
recursive | Included sub-directories |
onSD | TRUE = use flash storage The returned directory information |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.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_VP8800.device_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_VP8800::device_getResponseCodeString:(string ident = "") |
RETURN_CODE IDTechSDK.IDT_VP8800.device_resetConfigurationGroup | ( | int | group, |
string | ident = "" |
||
) |
Reset Configuration Group
This command allows resetting a dataset to its default configuration. If the file exists, it will be overwritten. If not, it will be created.
group | Configuration Group |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_VP8800::device_getResponseCodeString:(string ident = "") |
RETURN_CODE IDTechSDK.IDT_VP8800.device_retrieveAIDList | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve AID list
Returns all the AID names and their assigned groups installed on the terminal for CTLS/CONTACT.
response | array of 2-tag TLV data objects: DFEE2D (group name) followed by 9F06 (AID, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.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_VP8800.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_VP8800.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 |
ip | Optional IP address when connected via TCP/IP |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.device_sendVivoCommandP3 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ident = "" |
||
) |
Send Vivo Command Protocol 3
Sends a protocol 3 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_VP8800.device_sendVivoCommandP3_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ident = "" |
||
) |
Send Vivo Command Protocol 3 Extended
Sends a protocol 3 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_VP8800.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_VP8800.device_setBuzzerLED | ( | byte | buzzer, |
byte | led, | ||
bool | ledON, | ||
string | ident = "" |
||
) |
Set Buzzer/LED
Sets the readers buzzer and LED's.
buzzer |
|
led |
|
ledON | TRUE = ON, FALSE = OFF |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.device_startRKI | ( | bool | isTest, |
string | ident = "" |
||
) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers.
isTest | TRUE = Demo Device, FALSE = Production Device |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.device_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
byte[] | options, | ||
bool | isFastEMV = false , |
||
int | transMode = 0 , |
||
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. |
options | Selects interface and other device options. Must be 4 bytes
|
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 |
transMode | 0 = normal, 1 = fallback from ICC, 2 = fallback from contactless |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.device_transferFile | ( | string | fileName, |
byte[] | file, | ||
bool | isSD = false , |
||
string | ident = "" |
||
) |
Transfer File
This command transfers a data file to the reader.
fileName | Filename. The data for this command is a ASCII string with the complete path and file name you want to create. You do not need to specify the root directory. Indicate subdirectories with a forward slash (/). |
file | The data file. |
isSD | TRUE = tranfer to SD Card, FALSE = transfer to Flash. |
ip | Optional: IP address to execute command on (for IP connected devices, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.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 Use tag DFEF1F to determine if the Authentication step must be executed. DFEF1F 02 XX YY, where XX = 00 forces Authentication step, and YY = RFU. DFEF1F020000 will force authentication. |
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_VP8800.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 |
|
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_VP8800.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_VP8800.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_VP8800.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_VP8800.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_VP8800.emv_clearTransactionLog | ( | string | ident = "" | ) |
Clear Transaction Log
Clears the transaction log.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.emv_continueTransactionForCV | ( | int | result, |
byte[] | pinblock, | ||
string | ident = "" |
||
) |
Continue Transaction for Cardholder Verification
Use this command to send the results of Online PIN Request or Signature Request and to continue a Contact EMV transaction. If the prior response Status Code is 0x31h (Request Online PIN) or 0x32h (Request Signature), this is the next command to send.
The tags will be returned in the callback routine.
@param result Cardholder Verification result: - 0: Success (PIN or Signature, string ident = "") - 1: Cancelled PIN request - 2: PIN pad not working - 3: Timeout - 4: Error @param pinblock Encrypted PIN block if Success PIN result @param ident Device ID to send command to. If not specified, current SDK default device will be used.
RETURN_CODE IDTechSDK.IDT_VP8800.emv_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_VP8800.emv_getCRLStatus | ( | ref byte[] | status, |
string | ident = "" |
||
) |
Get CRL Status
This command returns information about the EMV Certificate Revocation List. The version number, record size, and number of records contained in the file are returned.
status | 12 bytes returned
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.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_VP8800.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_VP8800.emv_getExemptionLogStatus | ( | ref byte[] | status, |
string | ident = "" |
||
) |
Get EMV Exception Log Status
This command returns information about the EMV Exception log. The version number, record size, and number of records contained in the file are returned.
status | 12 bytes returned
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.emv_getTransactionLogRecord | ( | ref byte[] | record, |
ref int | remaining, | ||
string | ident = "" |
||
) |
Get Transaction Log Record
Retrieves oldest transaction record on the Transaction Log. At successful completion, the oldest transaction record is deleted from the transaction log
record | Transaction Record |
remaining | Number of records remaining on the transaction log |
Length | Description | Type |
---|---|---|
4 | Transaction Log State (TLS) | Enum (4-byte number, LSB first), SENT ONLINE = 0, NOT SENT = 1 |
4 | Transaction Log Content (TLC) | Enum (4-byte number, LSB first), BATCH = 0, OFFLINE ADVICE = 1, ONLINEADVICE = 2, REVERSAL = 3 |
4 | AppExpDate | unsigned char [4] |
3 | AuthRespCode | unsigned char [3] |
3 | MerchantCategoryCode | unsigned char [3] |
16 | MerchantID | unsigned char [16] |
2 | PosEntryMode | unsigned char [2] |
9 | TermID | unsigned char [9] |
3 | AIP | unsigned char [3] |
3 | ATC | unsigned char [3] |
33 | IssuerAppData | unsigned char [33] |
6 | TVR | unsigned char [6] |
3 | TSI | unsigned char [3] |
11 | Pan | unsigned char [11] |
2 | PanSQNCNum | unsigned char [2] |
3 | TermCountryCode | unsigned char [3] |
7 | TranAmount | unsigned char [7] |
3 | TranCurCode | unsigned char [3] |
4 | TranDate | unsigned char [4] |
2 | TranType | unsigned char [2] |
9 | IFDSerialNum | unsigned char [9] |
12 | AcquirerID | unsigned char [12] |
2 | CID | unsigned char [2] |
9 | AppCryptogram | unsigned char [9] |
5 | UnpNum | unsigned char [5] |
7 | AmountAuth | unsigned char [7] |
4 | AppEffDate | unsigned char [4] |
4 | CVMResults | unsigned char [4] |
129 | IssScriptResults | unsigned char [129] |
4 | TermCap | unsigned char [4] |
2 | TermType | unsigned char [2] |
20 | Track2 | unsigned char [20] |
4 | TranTime | unsigned char [4] |
7 | AmountOther | unsigned char [7] |
1 | Unused | Unsigned char [1] |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.emv_getTransactionLogStatus | ( | ref byte[] | status, |
string | ident = "" |
||
) |
Get Transaction Log Status
This command returns information about the EMV transaction log. The version number, record size, and number of records contained in the file are returned.
status | 12 bytes returned
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.emv_removeAllExceptions | ( | string | ident = "" | ) |
Remove All EMV Exceptions
Removes all entries from the EMV Exception List
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.emv_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_VP8800::device_getResponseCodeString:(string ident = "") |
RETURN_CODE IDTechSDK.IDT_VP8800.emv_removeCRL | ( | byte[] | crl, |
string | ident = "" |
||
) |
Remove Certificate Revocation List Entry
Removes CRLEntry as specified by the RID and Index passed as 6 bytes, or RID, Index, and serial number passed as 9 bytes
crl | containing the CRL to remove: where [CRL] is 9 bytes: [5 bytes RID][1 byte CAPK Index][3 bytes serial number] OR [CRL] is 6 bytes: [5 bytes RID][1 byte CAPK Index] |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.emv_removeException | ( | byte[] | exception, |
string | ident = "" |
||
) |
Remove EMV Exception
Removes an entry to the EMV Exception List
exception | EMV Exception entry containing the PAN and Sequence Number where [Exception] is 12 bytes: [1 byte Len][10 bytes PAN][1 byte Sequence Number] PAN, in compressed numeric, padded with F if required (example 0x5413339000001596FFFF, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.emv_removeTransactionAmountLog | ( | string | ident = "" | ) |
Remove Transaction Amount Log
This command can delete transaction amount log in reader. (When EMV transaction is offline approved, or online, transaction amount log saves to reader., string ident = "")
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.emv_resetConfigurationGroup | ( | int | group, |
string | ident = "" |
||
) |
Reset Configuration Group
This command allows resetting a dataset to its default configuration. If the file exists, it will be overwritten. If not, it will be created.
group | Configuration Group |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_VP8800::device_getResponseCodeString:(string ident = "") |
RETURN_CODE IDTechSDK.IDT_VP8800.emv_retrieveAIDList | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve AID list
Returns all the AID names and their assigned groups installed on the terminal for CONTACT.
response | array of 2-tag TLV data objects: DFEE2D (group name) followed by 9F06 (AID, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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: [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_VP8800.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_VP8800.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_VP8800.emv_retrieveExceptionList | ( | ref byte[] | list, |
string | ident = "" |
||
) |
Retrieve the EMV Exception List
Returns the EMV Exception entries on the terminal.
list | [Exception1][Exception2]...[Exceptionn], where [Exception] is 12 bytes: [1 byte Len][10 bytes PAN][1 byte Sequence Number] |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.emv_setApplicationData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Application Data by AID
Sets the Application Data as specified by TLV data
tlv | Application data in TLV format The first tag of the TLV data must be the group number (DFEE2D). The second tag of the TLV data must be the AID (9F06) Tag DFEE4F must be included, and it must have a value of 0x02 to be and EMV AID |
Example valid TLV, for Group #8, AID a0000000045010: "dfee2d01089f0607a0000000045010dfee4b0101dfee2e0110dfee4c0101dfee4f0103
Tags:
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.emv_setCRL | ( | byte[] | crl, |
string | ident = "" |
||
) |
Set Certificate Revocation List
Sets the CRL
crl | CRL Entries containing the RID, Index, and serial numbers to set where [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_VP8800.emv_setException | ( | byte[] | exception, |
string | ident = "" |
||
) |
Set EMV Exception
Adds an entry to the EMV Exception List
exception | EMV Exception entry containing the PAN and Sequence Number where [Exception] is 12 bytes: [1 byte Len][10 bytes PAN][1 byte Sequence Number] PAN, in compressed numeric, padded with F if required (example 0x5413339000001596FFFF, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.emv_setTerminalDataVP8800 | ( | byte[] | tlv, |
int | config, | ||
string | ident = "" |
||
) |
Set Terminal Data
Sets the Terminal Data
tlv | TerminalData TLV Data |
config | Config verification, valid values 1-4 |
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_VP8800.emv_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline, | ||
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 Use tag DFEF1F to determine if the Authentication step must be executed. DFEF1F 02 XX YY, where XX = 00 forces Authentication step, and YY = RFU. DFEF1F020000 will force authentication. |
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_VP8800.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:() |
RETURN_CODE IDTechSDK.IDT_VP8800.felica_authentication | ( | byte[] | key, |
string | ident = "" |
||
) |
FeliCa Authentication
Provides a key to be used in a follow up FeliCa Read with MAC (3 blocks max) or Write with MAC (1 block max). This command must be executed before each Read w/MAC or Write w/MAC command
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
key | 16 byte key used for MAC generation of Read or Write with MAC |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.felica_read | ( | byte[] | serviceCode, |
int | numBlocks, | ||
byte[] | blockList, | ||
ref byte[] | blocks, | ||
string | ident = "" |
||
) |
FeliCa Read
Reads up to 4 blocks.
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
serviceCode | Service Code List. Each service code in Service Code List = 2 bytes of data |
numBlocks | Number of blocks |
blockList | Blocks to read. Maximum 4 block requests |
blocks | Blocks read. Each block 16 bytes. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.felica_readWithMac | ( | int | numBlocks, |
byte[] | blockList, | ||
ref byte[] | blocks, | ||
string | ident = "" |
||
) |
FeliCa Read with MAC Generation
Reads up to 3 blocks with MAC Generation. FeliCa Authentication must be performed first
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
numBlocks | Number of blocks |
blockList | Block to read. Each block in blockList Maximum 3 block requests |
blocks | Blocks read. Each block 16 bytes. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.felica_requestService | ( | byte[] | nodeCode, |
ref byte[] | response, | ||
string | ident = "" |
||
) |
FeliCa Request Service
Perform functions a Felica Request Service
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
nodeCode | Node Code |
response | Response as explained in FeliCA Lite-S User's Manual |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.felica_SendCommand | ( | byte[] | command, |
ref byte[] | response, | ||
string | ident = "" |
||
) |
FeliCa Send Command
Send a Felica Command
command | Command data from settlement center to be sent to felica card |
response | Response data from felica card. |
RETURN_CODE IDTechSDK.IDT_VP8800.felica_write | ( | byte[] | serviceCode, |
int | blockCount, | ||
byte[] | blockList, | ||
byte[] | data, | ||
ref byte[] | statusFlag, | ||
string | ident = "" |
||
) |
FeliCa Write
Writes a block
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
serviceCode | Service Code list. Each service code must be be 2 bytes |
blockCount | Block Count |
blockList | Block list. |
data | Block to write. Must be 16 bytes. |
statusFlag | Status flag response as explained in FeliCA Lite-S User's Manual, Section 4.5 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.felica_writeWithMac | ( | int | blockNumber, |
byte[] | data, | ||
string | ident = "" |
||
) |
FeliCa Write with MAC Generation
Writes a block with MAC Generation. FeliCa Authentication must be performed first
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
blockNumber | Number of block |
data | Block to write. Must be 16 bytes. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
static |
Get Command Timeout
Gets the default timeout (in milliseconds) waiting for a blocking command response
time | Time |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.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_VP8800.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. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_captureSignature | ( | int | timeout, |
int | format, | ||
string | ident = "" |
||
) |
Enables Signature Capture
This command executes the signature capture screen. Once a signature is captured, it is sent to the callback with DeviceState.Signature, and the data will contain a .png of the signature
timeout | Timeout waiting for the signature capture in 60 seconds |
format | 1 = Windows BMP, 2 = png, 3 = raw |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
static |
Clear Display
Command to clear the display screen on the reader.It returns the display to the currently defined background color and terminates all events
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_clearInputEvents | ( | string | ident = "" | ) |
Clear Input Events
Clears the input event buffer.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_customDisplayMode | ( | bool | enable, |
string | ident = "" |
||
) |
Custom Display Mode
Controls the LCD display mode to custom display. Keyboard entry is limited to the Cancel, Clear, Enter and the function keys, if present. PIN entry is not permitted while the reader is in Custom Display Mode
enable | TRUE = enabled, FALSE = disabled |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_displayButton | ( | int | xCord, |
int | yCord, | ||
int | xWidth, | ||
int | yWidth, | ||
int | font, | ||
int | style, | ||
int | displayProp, | ||
string | text, | ||
ref byte[] | identifier, | ||
byte[] | foreRGB = null , |
||
byte[] | backRGB = null , |
||
string | ident = "" |
||
) |
Display Button
Displays a button on the screen. To remove buttons, use lcd_clearDisplay(). The button becomes sensitive after activating lcd_getInputEvent(string ident = "") and remains active until the display is cleared.
While in Secure Mode (Pin Pad active), the text must match one of the following messages: DONE, CREDIT, DEBIT, CANCEL, CLEAR, OK, YES, NO, LOYALTY, EBT, GIFT CARD, CASH, TOUCH, ACCEPT, ENTER, DOES NOT APPLY, AGREE, BACK, NEXT, PREVIOUS, HOME, DISAGREE, REJECT, CONTINUE, USE, DON’T USE, SELECT, NO THANK YOU, PAGE UP, PAGE DOWN, DECLINE?
xCord | The x Coordinate for the text |
yCord | The y Coordinate for the text |
xWidth | Width of text field |
yWidth | Height of text field |
font | Font. Default font = 1 |
style | Font style:
|
displayProp |
|
text | Text to display. When in Secure Mode, must match secure messages exactly. When in custom mode, it can be any message. |
identifier | The 4 byte Graphic ID assigned to the element once created |
foreRGB | Text Color RGB. 000000 = black, FF0000 = red, 00FF00 = green, 0000FF = blue, FFFFFF = white. Pass NULL for default color |
backRGB | Button Color RGB. 000000 = black, FF0000 = red, 00FF00 = green, 0000FF = blue, FFFFFF = white. Pass NULL for default color |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_displayText | ( | int | xCord, |
int | yCord, | ||
int | xWidth, | ||
int | yWidth, | ||
int | font, | ||
int | style, | ||
int | displayProp, | ||
string | text, | ||
ref byte[] | identifier, | ||
string | ident = "" |
||
) |
Display Text
Displays text on the screen. While in Secure Mode (Pin Pad active), the text must match one of the following messages: Approved, approved avail, approved available, authorized, authorizing please wait, available, balance, call your bank, cancel, cancelled, cancel to reject, card read ok, card read ok remove card, cash, cash back?, Choose transaction type, clear, confirm amount, connecting online, convert to credit?, Copyright, credit, debit, declined, done, end of key life, enter configuration id, enter date and time, enter force transaction online, fail, fare, fatal error, fee, initializing, input date of birth and press enter, input joint applicant date of birth and press enter, input joint applicant social security number and press enter, input social security number and press enter, insert or swipe card, international card, international card please insert, international card please swipe, invalid entry, is amount ok?, Keys not found, no card, not accepted, not authorized, not connected, offline, offline available fund, other, other amount, out of order, payment, pin try limit exceeded, please enter amount, please enter cash back amount, please enter phone, please enter tip, please enter tip amount using keypad, please enter tip option using keypad, please enter zip code, please insert card, please insert or swipe card, please present card, please present one card only, please press enter on keypad to continue, please press enter to continue, please push enter, please re-enter phone number, please re-enter zip code, please remove card, please select 1 card, please select option, please sign on the screen, please sign the receipt, please swipe card, please tap card, please tap or swipe card, please use chip reader, please use keypad to confirm, please use keypad to confirm or cancel, please use keypad to select account, please use keypad to select option, please use other visa card, please wait, please wait..., present card, present one card only, press cancel to reject, press enter to accept, processing, processing..., push enter, receipt?, Remove card please wait, signature required, signature required transaction not completed, subtotal, swipe again, swipe card, tap again, tap card, tap or swipe card, thank you, timeout, tip, tip amount, total, total charged to card, transaction complete, transaction completed, transaction not completed, unit disabled, vivotech, inc., voucher, welcome, would you like a receipt?
xCord | The x Coordinate for the text |
yCord | The y Coordinate for the text |
xWidth | The display width - Enter 0 for default display dimensions |
yWidth | The display height - Enter 0 for default display dimensions |
font | Font. Default font = 1 |
style | Font style:
|
displayProp |
|
text | Text to display. When in Secure Mode, must match secure messages exactly. When in custom mode, it can be any message. |
identifier | The 4 byte Graphic ID assigned to the element once created |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_getInputEvent | ( | byte | timeout, |
string | ident = "" |
||
) |
Get Input Event
Returns the event in the input buffer. If no events in the input buffer, with will wait the specified timeout for an event to occur. It will continue to listen until an event is received, timeout, or lcd_ClearScreen is executed. Events returned to MessageCallback: DeviceState.InputEvent Data Format: {Event Type 1 byte}{Event Graphic ID 4 bytes}{Event Specific data variable bytes}
Event Type 7 Data = {00h = RFU}{31 bytes null terminated group name}{31 bytes radio button caption null terminated}
timeout | Timeout to wait for event. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_resetInitialState | ( | string | ident = "" | ) |
Reset to Initial State
This command places the reader UI into the idle state and displays the appropriate idle display.
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_VP8800.lcd_setBackgroundImage | ( | string | file, |
bool | enable, | ||
string | ident = "" |
||
) |
Set Background Image
You must send images to the reader’s memory and send a Start Custom Mode command to the reader before it will respond to Image commands. Image files must be in .bmp or .png format.
file | Complete path and file name of the file you want to use. Example "file.png" will put in root directory, while "ss/file.png" will put in ss directory (which must exist, string ident = "") |
enable | TRUE = Use Background Image, FALSE = Use Background Color |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_setDisplayImage | ( | string | file, |
int | posX, | ||
int | posY, | ||
int | posMode, | ||
bool | touchEnable, | ||
bool | clearScreen, | ||
string | ident = "" |
||
) |
Set Display Image
You must send images to the reader’s memory and send a Start Custom Mode command to the reader before it will respond to Image commands. Image files must be in .bmp or .png format.
files | Complete path and file name of the file you want to use. Example "file.png" will put in root directory, while "ss/file.png" will put in ss directory (which must exist, string ident = "") |
posX | X coordinate in pixels, Range 0-271 |
posY | Y coordinate in pixels, Range 0-479 |
posMode | Position Mode
|
touchEnable | TRUE = Image is touch sensitive |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_setForeBackColor | ( | byte[] | foreRGB, |
byte[] | backRGB, | ||
string | ident = "" |
||
) |
Set Foreground and Background Color
This command sets the foreground and background colors of the LCD.
foreRGB | Foreground RGB. 000000 = black, FF0000 = red, 00FF00 = green, 0000FF = blue, FFFFFF = white |
backRGB | Background RGB. 000000 = black, FF0000 = red, 00FF00 = green, 0000FF = blue, FFFFFF = white |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.lcd_startSlideShow | ( | string | files, |
int | posX, | ||
int | posY, | ||
int | posMode, | ||
bool | touchEnable, | ||
bool | recursion, | ||
bool | touchTerminate, | ||
int | delay, | ||
int | loops, | ||
bool | clearScreen, | ||
string | ident = "" |
||
) |
Start slide show
You must send images to the reader’s memory and send a Start Custom Mode command to the reader before it will respond to this commands. Image files must be in .bmp or .png format.
files | Complete paths and file names of the files you want to use, separated by commas. If a directory is specified, all files in the dirctory are displayed |
posX | X coordinate in pixels, Range 0-271 |
posY | Y coordinate in pixels, Range 0-479 |
posMode | Position Mode
|
touchEnable | TRUE = Image is touch sensitive |
recursion | TRUE = Recursively follow directorys in list |
touchTerminate | TRUE = Terminate slideshow on touch (if touch enabled, string ident = "") |
delay | Number of seconds between image displays |
loops | Number of display loops. A zero indicates continuous display. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.msr_flushTrackData | ( | string | ident = "" | ) |
Flush Track Data
Clears any track data being retained in memory by future PIN Block request.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.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_VP8800.pin_getEncryptedOnlinePIN | ( | int | keyType, |
int | timeout, | ||
string | ident = "" |
||
) |
Get Encrypted DUKPT PIN
Requests PIN Entry for online authorization. PIN block and KSN returned in callback function DeviceState.TransactionData with cardData.pin_pinblock. A swipe must be captured first before this function can execute
keyType | PIN block key type. Valid values 0,3 for TDES, 4 for AES |
timeout | PIN entry timout |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.pin_getPAN | ( | bool | getCSC, |
int | timeout, | ||
string | ident = "" |
||
) |
Get PAN
Requests PAN Entry on pinpad
getCSC | Include Customer Service Code (also known as CVV, CVC, string ident = "") |
timeout | PAN entry timout |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_VP8800.pin_promptCreditDebit | ( | object | currencySymbol, |
string | displayAmount, | ||
int | timeout, | ||
string | ident = "" |
||
) |
Prompt for Credit or Debit
Requests prompt for Credit or Debit. Response returned in callback function as DeviceState.MenuItem with data MENU_SELECTION_CREDIT = 0, MENU_SELECTION_DEBIT = 1
currencySymbol | Allowed values are $ (0x24), ¥ (0xA5), £ (0xA3), € (0xA4), or NULL |
displayAmount | Amount to display (can be NULL, string ident = "") |
timeout | Menu entry timout. Valid values 2-20 seconds |
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 VP8800 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 VP8800
port | Serial Port to use. Example COM1 = 1. |
baud | Baud rate to override default. Example 115200; |
|
static |
Use Serial Port Interface on Linux
Instructs SDK to attempt to use the Serial Port for communication with BTMag using default baud rate on Linux implementations
path | Path to use. Example /dev/ttyUSB* |
|
static |
Use Serial Port Interface on Linux with baud rate
Instructs SDK to attempt to use the Serial Port for communication with BTPay on Linux implementations
path | Path to use. Example /dev/ttyUSB* |
baud | Baud rate to override default. Example 115200; |
|
staticget |
Singleton Instance
Establishes an singleton instance of IDT_VP8800 class.