![]() |
IDTech Windows SDK Guide
3.2.4.393
API reference for Visual Studio .Net
|
Public Member Functions | |
RETURN_CODE | pin_getPIN (int mode, int PANSource, string iccPAN, int startTimeout, int entryTimeout, string language, string ident="") |
RETURN_CODE | pin_cancelPINEntry (string ident="") |
RETURN_CODE | pin_passThoughMode (bool enable, 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 | device_sendMacDataCommand (byte taskID, byte[] functionID, byte[] data, bool macData, ref byte[] response, string ident="") |
RETURN_CODE | device_getFirmwareVersion (ref string response, string ident="") |
RETURN_CODE | device_getVersions (ref SpectrumInfoExt info, string ident="") |
RETURN_CODE | device_getNonce (byte[] hostnonce, ref byte[] devicenonce, string ident="") |
RETURN_CODE | device_setUID (string UID, int keyType, ref SpectrumInfo info, int sessionTimeout=0x0064, string ident="") |
RETURN_CODE | device_startRKI (bool isTest, string ident="") |
RETURN_CODE | device_updateFirmware (byte[] firmwareData, string firmwareName, int encryptionType, byte[] keyBlob, string ident="") |
RETURN_CODE | device_setSpectrumProBDK (string BDK, string ident="") |
RETURN_CODE | device_pollCardReader (ref byte[] status, string ident="") |
RETURN_CODE | device_controlUserInterface (byte[] values, string ident="") |
RETURN_CODE | device_cardNotification (bool enable, byte option, bool captureMSR, string ident="") |
RETURN_CODE | msr_clearMSRData (string ident="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ident="") |
RETURN_CODE | msr_getMSRData (ref IDTTransactionData card, string ident="") |
RETURN_CODE | config_getSerialNumber (ref string response, string ident="") |
RETURN_CODE | config_getModelNumber (ref string response, string ident="") |
RETURN_CODE | msr_startMSRSwipe (int timeout, string ident="") |
RETURN_CODE | msr_cancelMSRSwipe (string ident="") |
RETURN_CODE | emv_getTerminalID (ref string response, string ident="") |
RETURN_CODE | emv_setTerminalID (string terminalID, string ident="") |
RETURN_CODE | emv_setTerminalMajorConfiguration (int configuration, string ident="") |
RETURN_CODE | emv_getTerminalMajorConfiguration (ref int configuration, string ident="") |
RETURN_CODE | emv_cancelTransaction (string ident="") |
RETURN_CODE | emv_clearTransactionLog (string ident="") |
RETURN_CODE | emv_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | emv_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | device_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | device_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false, string ident="") |
RETURN_CODE | emv_authenticateTransaction (byte[] updatedTLV, string ident="") |
RETURN_CODE | emv_completeTransaction (bool commError, byte[] authCode, byte[] iad, byte[] tlvScripts, byte[] tlv, string ident="") |
RETURN_CODE | emv_callbackResponseLCD (EMV_LCD_DISPLAY_MODE type, byte selection, string ident="") |
RETURN_CODE | emv_callbackResponsePIN (EMV_PIN_MODE type, byte[] KSN, byte[] PIN, string ident="") |
RETURN_CODE | emv_callbackResponseMSR (byte[] MSR, string ident="") |
RETURN_CODE | emv_getEMVKernelVersion (ref string response, string ident="") |
RETURN_CODE | emv_getEMVKernelCheckValue (ref string response, string ident="") |
RETURN_CODE | emv_getEMVConfigurationCheckValue (ref string response, string ident="") |
RETURN_CODE | emv_retrieveTransactionResult (byte[] tags, ref IDTTransactionData tlv, string ident="") |
RETURN_CODE | device_rebootDevice (string ident="") |
RETURN_CODE | emv_removeApplicationData (byte[] AID, string ident="") |
RETURN_CODE | emv_removeAllApplicationData (string ident="") |
RETURN_CODE | emv_removeCAPK (byte[] capk, string ident="") |
RETURN_CODE | emv_removeAllCAPK (string ident="") |
RETURN_CODE | emv_removeCRL (byte[] crlList, string ident="") |
RETURN_CODE | emv_removeAllCRL (string ident="") |
RETURN_CODE | emv_removeTerminalData (string ident="") |
RETURN_CODE | emv_retrieveAIDList (ref byte[][] response, string ident="") |
RETURN_CODE | emv_retrieveApplicationData (byte[] AID, ref byte[] tlv, string ident="") |
RETURN_CODE | emv_retrieveCAPK (byte[] capk, ref byte[] key, string ident="") |
RETURN_CODE | emv_retrieveCAPKList (ref byte[] keys, string ident="") |
RETURN_CODE | emv_retrieveCRLList (ref byte[] list, string ident="") |
RETURN_CODE | emv_retrieveTerminalData (ref byte[] tlv, string ident="") |
RETURN_CODE | emv_setApplicationData (byte[] name, byte[] tlv, string ident="") |
RETURN_CODE | emv_setCAPK (byte[] key, string ident="") |
RETURN_CODE | emv_setCRL (byte[] list, string ident="") |
RETURN_CODE | emv_trySetTerminalData (byte[] tlv, ref byte[] rejectedTLV, ref byte[] convertedTLV, bool overwrite=false, string ident="") |
RETURN_CODE | emv_setTerminalData (byte[] tlv, string ident="") |
RETURN_CODE | emv_addTerminalData (byte[] tlv, string ident="") |
string | device_getResponseCodeString (RETURN_CODE eCode) |
RETURN_CODE | device_getSpectrumProKSN (int type, ref byte[] KSN, string ident="") |
RETURN_CODE | icc_powerOffICC (string ident="") |
RETURN_CODE | icc_powerOnICC (ref byte[] ATR, string ident="") |
RETURN_CODE | icc_getICCReaderStatus (ref byte status, string ident="") |
RETURN_CODE | icc_getICCStatus (ref byte[] status, ref byte[] atr, string ident="") |
RETURN_CODE | device_StartRKI (int type, string ident="") |
bool | createFastEMVData (ref IDTTransactionData cData, string ident="") |
RETURN_CODE | device_getRKIStatus (bool isProd, bool isMultiKey, ref string status, ref Dictionary< string, RKI_KEY_TYPE > keys, string ident="") |
RETURN_CODE | device_getAnyRKIStatus (bool isMultiKey, ref string status, ref Dictionary< string, RKI_KEY_TYPE > keys, string ident="") |
RETURN_CODE | 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 bool | useSerialPort (int port, int baud) |
static bool | useSerialPortLinux (string path) |
static bool | useSerialPortLinux (string path, int baud) |
static int | getCommandTimeout (string ident="") |
static void | setCommandTimeout (int milliseconds, string ident="") |
static void | initSC () |
static void | setCallback (CallBack my_Callback) |
static void | setCardNotificationCallback (CardNotificationCallback my_Callback) |
static void | setCallback (IntPtr my_Callback, SynchronizationContext context) |
static String | SDK_Version () |
static void | emv_autoAuthenticate (bool authenticate, string ident="") |
static void | emv_autoAuthenticateTags (bool authenticate, byte[] tags, string ident="") |
static void | emv_allowFallback (bool allow, string ident="") |
static void | lcd_retrieveMessage (DisplayMessages.DISPLAY_MESSAGE_LANGUAGE lang, DisplayMessages.DISPLAY_MESSAGE_IDENTIFIER id, ref string line1, ref string line2) |
Properties | |
static IDT_SpectrumPro | SharedController [get] |
Class for IDT_SpectrumPro MSR/ICC reader
RETURN_CODE IDTechSDK.IDT_SpectrumPro.config_getModelNumber | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Model Number
response | Returns Model Number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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. |
bool IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.device_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
timeout | Timeout value in seconds. |
tags | The tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_cardNotification | ( | bool | enable, |
byte | option, | ||
bool | captureMSR, | ||
string | ident = "" |
||
) |
Card Notifications
Enable Insert/Removal notifications
Notification returned to CardNotificationCallback, use setCardNotificationCallback(CardNotificationCallback callback). CardNotificationCallback (byte status, string ident = "") 0x01 = bad msr 0x02 = good msr 0x03 = required track not captured 0x04 = front switch 0x08 = seat switch
enable | TRUE = enabled |
option | bit 1= T1 required, b2 = T2 required, b3 = T2 required |
captureMSR | TRUE = automatically capture MSR data and return as DeviceState.TransactionData to MessageCallback |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_controlUserInterface | ( | byte[] | values, |
string | ident = "" |
||
) |
Control User Interface
Controls the User Interface: Display, Beep, LED
@param values Four bytes to control the user interface Byte[0] = LCD Message Messages 00-07 are normally controlled by the reader. - 00h: Idle Message (Welcome, string ident = "") - 01h: Present card (Please Present Card, string ident = "") - 02h: Time Out or Transaction cancel (No Card, string ident = "") - 03h: Transaction between reader and card is in the middle (Processing...) - 04h: Transaction Pass (Thank You, string ident = "") - 05h: Transaction Fail (Fail, string ident = "") - 06h: Amount (Amount $ 0.00 Tap Card, string ident = "") - 07h: Balance or Offline Available funds (Balance $ 0.00) Messages 08-0B are controlled by the terminal - 08h: Insert or Swipe card (Use Chip & PIN, string ident = "") - 09h: Try Again(Tap Again, string ident = "") - 0Ah: Tells the customer to present only one card (Present 1 card only) - 0Bh: Tells the customer to wait for authentication/authorization (Wait) - FFh: indicates the command is setting the LED/Buzzer only. Byte[1] = Beep Indicator - 00h: No beep - 01h: Single beep - 02h: Double beep - 03h: Three short beeps - 04h: Four short beeps - 05h: One long beep of 200 ms - 06h: One long beep of 400 ms - 07h: One long beep of 600 ms - 08h: One long beep of 800 ms Byte[2] = LED Number - 00h: LED 0 (Power LED) 01h: LED 1 - 02h: LED 2 - 03h: LED 3 - FFh: All LEDs Byte[3] = LED Status - 00h: LED Off - 01h: LED On
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_getAnyRKIStatus | ( | bool | isMultiKey, |
ref string | status, | ||
ref Dictionary< string, RKI_KEY_TYPE > | keys, | ||
string | ident = "" |
||
) |
Get RKI Status Polls the RKI servers to validate device RKI eligiblity. Note: if device type is known in advance (production or demo device), it is more efficient to use device_getRKIStatus instead
isMultiKey | True = MultiKey, False = SingleKey |
status | RKI status returned as a string |
keys | Returns all available keys |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.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_SpectrumPro.device_getNonce | ( | byte[] | hostnonce, |
ref byte[] | devicenonce, | ||
string | ident = "" |
||
) |
Get Device Nonce
hostnonce | Nonce of host |
devicenonce | Nonce of device |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
string IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.device_getRKIStatus | ( | bool | isProd, |
bool | isMultiKey, | ||
ref string | status, | ||
ref Dictionary< string, RKI_KEY_TYPE > | keys, | ||
string | ident = "" |
||
) |
Get RKI Status From Specified Server Polls the RKI server to validate device RKI eligiblity
isProd | TRUE = poll production RKI server, FALSE = poll demo RKI server |
isMultiKey | True = MultiKey, False = SingleKey |
status | RKI status returned as a string |
keys | Returns dictionary of available keys |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_getSpectrumProKSN | ( | int | type, |
ref byte[] | KSN, | ||
string | ident = "" |
||
) |
Get DUKPT KSN
Returns the KSN for the provided key index
type | Key type:
|
KSN | Key Serial Number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_getVersions | ( | ref SpectrumInfoExt | info, |
string | ident = "" |
||
) |
Poll device for Version Info
info | Version info |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_pollCardReader | ( | ref byte[] | status, |
string | ident = "" |
||
) |
Poll Card Reader
Provides information about the state of the Card Reader
@param status Six bytes indicating card reader information Byte 0: - Bit 0: Device Manufacturing CA data valid - Bit 1: Device Manufacturing Secure data valid - Bit 2: HOST_CR_MASTER_DUKPT Key valid - Bit 3: HOST_CR_MAC Keys valid (Authenticated, string ident = "") - Bit 4: RFU - Bit 5: RFU - Bit 6: DATA_DUKPT Key Valid - Bit 7: Key is initialized (MFK and RSA Key pairs, string ident = "") Byte 1: - Bit 0: Firmware Key Valid - Bit 1: RFU - Bit 2: CR_PINPAD_MASTER_DUKPT Key valid - Bit 3: CR_PINPAD_MAC Keys valid (Authenticated, string ident = "") - Bit 4: DATA Pairing DUKPT Key valid - Bit 5: PIN Pairing DUKPT Key Valid - Bit 6: RFU - Bit 7: RFU Byte 2: - Bit 0: RFU - Bit 1: Tamper Switch #1 Error - Bit 2: Battery Backup Error - Bit 3: Temperature Error - Bit 4: Voltage Sensor Error - Bit 5: Firmware Authentication Error - Bit 6: Tamper Switch #2 Error - Bit 7: Removal Tamper Error Byte 3: - Battery Voltage (example 0x32 = 3.2V, 0x24 = 2.4V, string ident = "") Byte 4: - Bit 0: Log is Full - Bit 1: Mag Data Present - Bit 2: Card Insert - Bit 3: Removal Sensor connected - Bit 4: Card Seated - Bit 5: Latch Mechanism Active - Bit 6: Removal Sensor Active - Bit 7: Tamper Detector Active Byte 5: - Bit 0: SAM Available - Bit 1: Chip Card Reader Available - Bit 2: Host Connected - Bit 3: Contactless Available - Bit 4: PINPAD connected - Bit 5: MSR Header connected - Bit 6: RFU - Bit 7: Production Unit
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.device_rebootDevice | ( | string | ident = "" | ) |
Reboot Device
Executes a command to restart the device.
Resetting firmware.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.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_SpectrumPro.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_SpectrumPro.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_SpectrumPro.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_SpectrumPro.device_sendMacDataCommand | ( | byte | taskID, |
byte[] | functionID, | ||
byte[] | data, | ||
bool | macData, | ||
ref byte[] | response, | ||
string | ident = "" |
||
) |
Send a Command to device with MAC
Sends a command to the device with Mac calculation (if specified.
taskID | Task ID to execute |
functionID | Function ID to execute (one or more bytes, string ident = "") |
data | Data to send (if any, string ident = "") |
macData | If TRUE , this will include the MAC with the command |
response | Response data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_sendPAE | ( | string | command, |
ref string | response, | ||
int | timeout, | ||
string | ident = "" |
||
) |
Send Payment Application Engine Command
Executes a PAE command
command | ASCII command string, should start with "*PAE" |
response | command response |
timeout | timeout waiting for PAE response |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_setSpectrumProBDK | ( | string | BDK, |
string | ident = "" |
||
) |
Set Spectrum Pro BDK
Tells the SDK which BDK to use when generating MAC values for Specturm Pro commands. SDK default value is "0123456789ABCDEFFEDCBA9876543210"
BDK | Value of BDK, 32 ASCII characters representing 16 HEX values |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_setUID | ( | string | UID, |
int | keyType, | ||
ref SpectrumInfo | info, | ||
int | sessionTimeout = 0x0064 , |
||
string | ident = "" |
||
) |
Set Spectrum Pro UID
Sets the UID for the Spectrum Pro. SDK default value is "0001020304050607"
UID | Value of UID, 16 ASCII characters representing 8 HEX values |
keyType | Key type
|
info | Spectrum Pro return info |
sessionTimeout | Time, in seconds, that session data will be retained after data capture. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.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_SpectrumPro.device_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
amount | Transaction amount value (tag value 9F02, string ident = "") |
amtOther | Other amount value, if any (tag value 9F03, string ident = "") |
exponent | Number of characters after decimile point |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 If tags 9F02 (amount),9F03 (other amount), or 9C (transaction type) are included, they will take priority over these values supplied as individual parameters to this method. |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_updateFirmware | ( | byte[] | firmwareData, |
string | firmwareName, | ||
int | encryptionType, | ||
byte[] | keyBlob, | ||
string | ident = "" |
||
) |
Update Firmware
Updates the firmware of the Spectrum Pro K21 HUB or Maxq1050.
firmwareData | Signed binary data of a firmware file provided by IDTech |
firmwareName | Firmware name. Must be one of the following two strings (with appropriate version information, string ident = "")
|
encryptionType | Encryption type
|
keyBlob | Encrypted firmware session key blob, TR-31 Rev B, wrapped by FW Key (Optional, none if firmware is plaintext, string ident = "") |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
Firmware update status is returned in the callback with the following values: sender = SPECTRUM_PRO state = DeviceState.FirmwareUpdate data = File Progress. Two bytes, with byte[0] = current block, and byte[1] = total blocks. 0x0310 = block 3 of 16 transactionResultCode:
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
timeout | Timeout value in seconds. |
tags | The tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_addTerminalData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Add Terminal Data
Adds to the exosting Terminal Data
tlv | TerminalData TLV Data |
ident | Optional identifier |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
|
static |
Allow fallback for EMV transactions. Default is TRUE
allow | TRUE = allow fallback, FALSE = don't allow fallback |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_authenticateTransaction | ( | byte[] | updatedTLV, |
string | ident = "" |
||
) |
Authenticate EMV Transaction Request
Authenticates the EMV transaction for an ICC card. Execute this after receiving response with result code 0x10 to emv_startTransaction
The tags will be returned in the callback routine.
updatedTLV | TLV stream that can be used to update the following values:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
static |
Enables authenticate for EMV transactions. If a startEMVTranaction results in code 0x0010 (start transaction success), then emv_authenticateEMVTransaction can automatically execute if parameter is set to TRUE
authenticate | TRUE = auto authenticate, FALSE = manually authenticate |
|
static |
Enables authenticate for EMV transactions. If a startEMVTranaction results in code 0x0010 (start transaction success), then emv_authenticateEMVTransaction can automatically execute if parameter is set to TRUE
authenticate | TRUE = auto authenticate, FALSE = manually authenticate |
tags | Tags to pass during authentication stage; |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.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_SpectrumPro.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_SpectrumPro.emv_cancelTransaction | ( | string | ident = "" | ) |
Cancel EMV Transaction
Cancels the currently executing EMV transaction.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.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_SpectrumPro.emv_getEMVConfigurationCheckValue | ( | ref string | response, |
string | ident = "" |
||
) |
Get EMV Kernel configuration check value info
response | Response returned of Kernel configuration check value info |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_getEMVKernelCheckValue | ( | ref string | response, |
string | ident = "" |
||
) |
Get EMV Kernel check value info
response | Response returned of Kernel check value info |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.emv_getTerminalID | ( | ref string | response, |
string | ident = "" |
||
) |
Gets the terminal ID as printable characters .
response | Terminal ID |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_getTerminalMajorConfiguration | ( | ref int | configuration, |
string | ident = "" |
||
) |
Gets the terminal major configuration in ICS .
configuration | A configuration value, range 1-4
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeAllApplicationData | ( | string | ident = "" | ) |
Remove All Application Data
Removes all the Application Data
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeAllCAPK | ( | string | ident = "" | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.emv_removeApplicationData | ( | byte[] | AID, |
string | ident = "" |
||
) |
Remove Application Data by AID
Removes the Application Data 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_SpectrumPro.emv_removeCAPK | ( | byte[] | capk, |
string | ident = "" |
||
) |
Remove Certificate Authority Public Key
Removes the CAPK 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_SpectrumPro.emv_removeCRL | ( | byte[] | crlList, |
string | ident = "" |
||
) |
Remove Certificate Revocation List Entries
Removes CRLEntries as specified by the RID and Index and serial number passed as 9 bytes
crlList | containing the list of CRL to remove: [CRL1][CRL2]...[CRLn] where each [CRL] is 9 bytes: [5 bytes RID][1 byte CAPK Index][3 bytes serial number] |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.emv_retrieveAIDList | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve AID list
Returns all the AID names installed on the terminal.
response | array of AID name byte arrays |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Retrieve Application Data by AID
Retrieves the Application Data as specified by the AID name passed as a parameter.
AID | Name of ApplicationID. Must be between 5 and 16 bytes |
tlv | The TLV elements of the requested AID |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveCAPK | ( | byte[] | capk, |
ref byte[] | key, | ||
string | ident = "" |
||
) |
Retrieve Certificate Authority Public Key
Retrieves the CAPK as specified by the RID/Index passed as a parameter.
capk | 6 bytes CAPK = 5 bytes RID + 1 byte Index |
key | Response returned as a CAKey format: [5 bytes RID][1 byte Index][1 byte Hash Algorithm][1 byte Encryption Algorithm] [20 bytes HashValue][4 bytes Public Key Exponent][2 bytes Modulus Length][Variable bytes Modulus] Where:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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.
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_SpectrumPro.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_SpectrumPro.emv_retrieveTerminalData | ( | ref byte[] | tlv, |
string | ident = "" |
||
) |
Retrieve Terminal Data
Retrieves the Terminal Data.
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_SpectrumPro.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_SpectrumPro.emv_setApplicationData | ( | byte[] | name, |
byte[] | tlv, | ||
string | ident = "" |
||
) |
Set Application Data by AID
Sets the Application Data as specified by the application name and TLV data
name | Application name, 10-32 ASCII hex characters representing 5-16 bytes Example "a0000000031010" |
tlv | Application data in TLV format |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setCAPK | ( | byte[] | key, |
string | ident = "" |
||
) |
Set Certificate Authority Public Key
Sets the CAPK 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_SpectrumPro.emv_setCRL | ( | byte[] | list, |
string | ident = "" |
||
) |
Set Certificate Revocation List
Sets the CRL
list | CRL Entries containing the RID, Index, and serial numbers to set [CRL1][CRL2]...[CRLn] where each [CRL] is 9 bytes: [5 bytes RID][1 byte CAPK Index][3 bytes serial number] |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setTerminalData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Terminal Data
Sets the Terminal Data
tlv | TerminalData TLV Data |
ident | Optional identifier |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setTerminalID | ( | string | terminalID, |
string | ident = "" |
||
) |
Sets the terminal ID as printable characters .
terminalID | Terminal ID to set |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setTerminalMajorConfiguration | ( | int | configuration, |
string | ident = "" |
||
) |
Sets the terminal major configuration in ICS .
configuration | A configuration value, range 1-4
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
amount | Transaction amount value (tag value 9F02, string ident = "") |
amtOther | Other amount value, if any (tag value 9F03, string ident = "") |
exponent | Number of characters after decimile point |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 If tags 9F02 (amount),9F03 (other amount), or 9C (transaction type) are included, they will take priority over these values supplied as individual parameters to this method. |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_trySetTerminalData | ( | byte[] | tlv, |
ref byte[] | rejectedTLV, | ||
ref byte[] | convertedTLV, | ||
bool | overwrite = false , |
||
string | ident = "" |
||
) |
Try to Set Terminal Data
Atempts to set the Terminal Data. Use this functions to attempt to set the terminal data to the device. This function will allow the cross-device tag compatible writing of IDTech Legacy/New tag definitions
tlv | TerminalData TLV Data |
rejectedTLV | Contains the tags (if any) that were rejected by the firmware |
convertedTLV | Contains the tags (if any) that were converted and accepted by the firmware |
overwrite | TRUE = add TLV to existing tags, FALSE = replace existing tags with TLV |
ident | Optional identifier |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
|
static |
Get Command Timeout
Gets the default timeout (in milliseconds) waiting for a blocking command response
time | Time |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.icc_getICCReaderStatus | ( | ref byte | status, |
string | ident = "" |
||
) |
Get Reader Status
Returns the reader status
status | Pointer that will return with the ICCReaderStatus results. bit 0: 0 = ICC Power Not Ready, 1 = ICC Powered bit 1: 0 = Card not seated, 1 = card seated |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.icc_getICCStatus | ( | ref byte[] | status, |
ref byte[] | atr, | ||
string | ident = "" |
||
) |
Get Reader Status
Returns the ICC ATR Data and the status of the Smart Card interface: Smart Card voltage, protocols and parameters
status | Pointer that will return with the ICC info. byte 0: Card Presence
|
atr | ATR Data is included when card is inserted and no other errors returned. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.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_SpectrumPro.icc_powerOnICC | ( | ref byte[] | ATR, |
string | ident = "" |
||
) |
Power On ICC
Power up the currently selected microprocessor card in the ICC reader
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_SpectrumPro.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_SpectrumPro.msr_clearMSRData | ( | string | ident = "" | ) |
Clear MSR Data
Clears the MSR Data buffer
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.msr_getMSRData | ( | ref IDTTransactionData | card, |
string | ident = "" |
||
) |
Get MSR Data
Reads the MSR Data buffer
@param card Card data
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.msr_startMSRSwipe | ( | int | timeout, |
string | ident = "" |
||
) |
Enable MSR Swipe
Enables MSR, waiting for swipe to occur. Allows track selection. Returns IDTMSRData instance to deviceDelegate::swipeMSRData:( string ident = "")
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_SpectrumPro.pin_cancelPINEntry | ( | string | ident = "" | ) |
Cancel PIN Entry
Cancels PIN entry request
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.pin_getPIN | ( | int | mode, |
int | PANSource, | ||
string | iccPAN, | ||
int | startTimeout, | ||
int | entryTimeout, | ||
string | language, | ||
string | ident = "" |
||
) |
Get Encrypted PIN
Requests PIN Entry
mode |
|
PANSource |
|
iccPAN | PAN captured from ICC. When PAN captured from MSR, this parameter will be ignored |
startTimeout | The amount of time allowed to start PIN entry before timeout |
entryTimeout | The amount of time to enter the PIN after first digit selected before timeout |
language | Valid values "EN" for English, "ES" for Spanish, "ZH" for Chinese, "FR" for French |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.pin_passThoughMode | ( | bool | enable, |
string | ident = "" |
||
) |
Pin Pass Through
Enables all commands to be passed through the PINpad
enable | TRUE = all commands passed through, FALSE = commands not passed through |
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 Card Notification Callback
Sets the callback for card notification insert/remove/data
Notification returned to CardNotificationCallback, use setCardNotificationCallback(CardNotificationCallback callback). CardNotificationCallback (byte status, string ident = "") 0x01 = bad msr 0x02 = good msr 0x04 = front switch 0x08 = seat switch
enable with device_setCardNotification
|
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 Spectrum Pro 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 Spectrum Pro
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 Spectrum Pro class.