![]() |
IDTech Windows SDK Guide
1.2.35.0
API reference for SpectrumPro
|
Public Member Functions | |
RETURN_CODE | pin_getPIN (int mode, int PANSource, string iccPAN, int startTimeout, int entryTimeout, string language) |
RETURN_CODE | pin_cancelPINEntry () |
RETURN_CODE | pin_passThoughMode (bool enable) |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response) |
RETURN_CODE | device_sendMacDataCommand (byte taskID, byte[] functionID, byte[] data, bool macData, ref byte[] response) |
RETURN_CODE | device_getFirmwareVersion (ref string response) |
RETURN_CODE | device_setUID (string UID, int keyType, ref SpectrumInfo info) |
RETURN_CODE | device_startRKI () |
RETURN_CODE | device_updateFirmware (byte[] firmwareData, string firmwareName, int encryptionType, byte[] keyBlob) |
RETURN_CODE | device_setSpectrumProBDK (string BDK) |
RETURN_CODE | device_pollCardReader (ref byte[] status) |
RETURN_CODE | device_controlUserInterface (byte[] values) |
RETURN_CODE | msr_clearMSRData () |
RETURN_CODE | msr_getMSRData (ref IDTTransactionData card) |
RETURN_CODE | config_getSerialNumber (ref string response) |
RETURN_CODE | config_getModelNumber (ref string response) |
RETURN_CODE | msr_startMSRSwipe (int timeout) |
RETURN_CODE | msr_cancelMSRSwipe () |
RETURN_CODE | emv_getTerminalID (ref string response) |
RETURN_CODE | emv_setTerminalID (string terminalID) |
RETURN_CODE | emv_setTerminalMajorConfiguration (int configuration) |
RETURN_CODE | emv_getTerminalMajorConfiguration (ref int configuration) |
RETURN_CODE | emv_cancelTransaction () |
RETURN_CODE | emv_clearTransactionLog () |
RETURN_CODE | emv_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline) |
RETURN_CODE | emv_authenticateTransaction (byte[] updatedTLV) |
RETURN_CODE | emv_completeTransaction (bool commError, byte[] authCode, byte[] iad, byte[] tlvScripts, byte[] tlv) |
RETURN_CODE | emv_callbackResponseLCD (EMV_LCD_DISPLAY_MODE type, byte selection) |
RETURN_CODE | emv_callbackResponsePIN (EMV_PIN_MODE type, byte[] KSN, byte[] PIN) |
RETURN_CODE | emv_callbackResponseMSR (byte[] MSR) |
RETURN_CODE | emv_getEMVKernelVersion (ref string response) |
RETURN_CODE | emv_getEMVKernelCheckValue (ref string response) |
RETURN_CODE | emv_getEMVConfigurationCheckValue (ref string response) |
RETURN_CODE | emv_retrieveTransactionResult (byte[] tags, ref IDTTransactionData tlv) |
RETURN_CODE | device_rebootDevice () |
RETURN_CODE | emv_removeApplicationData (byte[] AID) |
RETURN_CODE | emv_removeAllApplicationData () |
RETURN_CODE | emv_removeCAPK (byte[] capk) |
RETURN_CODE | emv_removeAllCAPK () |
RETURN_CODE | emv_removeCRL (byte[] crlList) |
RETURN_CODE | emv_removeAllCRL () |
RETURN_CODE | emv_removeTerminalData () |
RETURN_CODE | emv_retrieveAIDList (ref byte[][] response) |
RETURN_CODE | emv_retrieveApplicationData (byte[] AID, ref byte[] tlv) |
RETURN_CODE | emv_retrieveCAPK (byte[] capk, ref byte[] key) |
RETURN_CODE | emv_retrieveCAPKList (ref byte[] keys) |
RETURN_CODE | emv_retrieveCRLList (ref byte[] list) |
RETURN_CODE | emv_retrieveTerminalData (ref byte[] tlv) |
RETURN_CODE | emv_setApplicationData (byte[] name, byte[] tlv) |
RETURN_CODE | emv_setCAPK (byte[] key) |
RETURN_CODE | emv_setCRL (byte[] list) |
RETURN_CODE | emv_setTerminalData (byte[] tlv) |
string | device_getResponseCodeString (RETURN_CODE eCode) |
RETURN_CODE | device_getSpectrumProKSN (int type, ref byte[] KSN) |
RETURN_CODE | icc_powerOffICC () |
RETURN_CODE | icc_powerOnICC (ref byte[] ATR) |
RETURN_CODE | icc_getICCReaderStatus (ref byte status) |
RETURN_CODE | icc_getICCStatus (ref byte[] status, ref byte[] atr) |
Static Public Member Functions | |
static bool | useSerialPort (int port, bool isSRED) |
static bool | useSerialPort (int port, int baud, bool isSRED) |
static bool | useUSB () |
static void | setCallback (CallBack my_Callback) |
static void | setCallback (IntPtr my_Callback, SynchronizationContext context) |
static String | SDK_Version () |
static void | emv_autoAuthenticate (bool authenticate) |
static void | emv_autoAuthenticate (bool authenticate, byte[] tags) |
static void | emv_allowFallback (bool allow) |
Properties | |
static IDT_SpectrumPro | SharedController [get] |
Class for IDT_SpectrumPro MSR/ICC reader
RETURN_CODE IDTechSDK.IDT_SpectrumPro.config_getModelNumber | ( | ref string | response | ) |
Polls device for Model Number
response | Returns Model Number |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.config_getSerialNumber | ( | ref string | response | ) |
Polls device for Serial Number
response | Returns Serial Number |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_controlUserInterface | ( | byte[] | values | ) |
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) - 01h: Present card (Please Present Card) - 02h: Time Out or Transaction cancel (No Card) - 03h: Transaction between reader and card is in the middle (Processing...) - 04h: Transaction Pass (Thank You) - 05h: Transaction Fail (Fail) - 06h: Amount (Amount $ 0.00 Tap Card) - 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) - 09h: Try Again(Tap Again) - 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
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_getFirmwareVersion | ( | ref string | response | ) |
Polls device for Firmware Version
response | Response returned of Firmware Version |
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_getSpectrumProKSN | ( | int | type, |
ref byte[] | KSN | ||
) |
Get DUKPT KSN
Returns the KSN for the provided key index
type | Key type:
|
KSN | Key Serial Number |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_pollCardReader | ( | ref byte[] | status | ) |
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) - Bit 4: RFU - Bit 5: RFU - Bit 6: DATA_DUKPT Key Valid - Bit 7: Key is initialized (MFK and RSA Key pairs) 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) - 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) 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
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_rebootDevice | ( | ) |
Reboot Device
Executes a command to restart the device.
Resetting firmware.
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_sendDataCommand | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response | ||
) |
Send a Command to device
Sends a command to the device .
cmd | Hex 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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_sendMacDataCommand | ( | byte | taskID, |
byte[] | functionID, | ||
byte[] | data, | ||
bool | macData, | ||
ref byte[] | response | ||
) |
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) |
data | Data to send (if any) |
macData | If TRUE , this will include the MAC with the command |
response | Response data |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_setSpectrumProBDK | ( | string | BDK | ) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_setUID | ( | string | UID, |
int | keyType, | ||
ref SpectrumInfo | info | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_startRKI | ( | ) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers.
RETURN_CODE IDTechSDK.IDT_SpectrumPro.device_updateFirmware | ( | byte[] | firmwareData, |
string | firmwareName, | ||
int | encryptionType, | ||
byte[] | keyBlob | ||
) |
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)
|
encryptionType | Encryption type
|
keyBlob | Encrypted firmware session key blob, TR-31 Rev B, wrapped by FW Key (Optional, none if firmware is plaintext) |
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:
|
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 | ) |
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:
|
|
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 | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_callbackResponseMSR | ( | byte[] | MSR | ) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_callbackResponsePIN | ( | EMV_PIN_MODE | type, |
byte[] | KSN, | ||
byte[] | PIN | ||
) |
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) |
PIN | If encipherd PIN, this is encrypted PIN block. If device does not implement pairing function, this is plaintext PIN |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_cancelTransaction | ( | ) |
Cancel EMV Transaction
Cancels the currently executing EMV transaction.
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_clearTransactionLog | ( | ) |
Clear Transaction Log
Clears the transaction log.
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_completeTransaction | ( | bool | commError, |
byte[] | authCode, | ||
byte[] | iad, | ||
byte[] | tlvScripts, | ||
byte[] | tlv | ||
) |
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) |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_getEMVConfigurationCheckValue | ( | ref string | response | ) |
Get EMV Kernel configuration check value info
response | Response returned of Kernel configuration check value info |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_getEMVKernelCheckValue | ( | ref string | response | ) |
Get EMV Kernel check value info
response | Response returned of Kernel check value info |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_getEMVKernelVersion | ( | ref string | response | ) |
Polls device for EMV Kernel Version
response | Response returned of Kernel Version |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_getTerminalID | ( | ref string | response | ) |
Gets the terminal ID as printable characters .
response | Terminal ID |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_getTerminalMajorConfiguration | ( | ref int | configuration | ) |
Gets the terminal major configuration in ICS .
configuration | A configuration value, range 1-4
|
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeAllApplicationData | ( | ) |
Remove All Application Data
Removes all the Application Data
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeAllCAPK | ( | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeAllCRL | ( | ) |
Remove All Certificate Revocation List Entries
Removes all CRLEntry entries
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeApplicationData | ( | byte[] | AID | ) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeCAPK | ( | byte[] | capk | ) |
Remove Certificate Authority Public Key
Removes the CAPK as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeCRL | ( | byte[] | crlList | ) |
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] |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_removeTerminalData | ( | ) |
Remove Terminal Data
Removes the Terminal Data
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveAIDList | ( | ref byte | response[][] | ) |
Retrieve AID list
Returns all the AID names installed on the terminal.
response | array of AID name byte arrays |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveCAPK | ( | byte[] | capk, |
ref byte[] | key | ||
) |
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:
|
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveCAPKList | ( | ref byte[] | keys | ) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveCRLList | ( | ref byte[] | list | ) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveTerminalData | ( | ref byte[] | tlv | ) |
Retrieve Terminal Data
Retrieves the Terminal Data.
tlv | Response returned as a TLV |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_retrieveTransactionResult | ( | byte[] | tags, |
ref IDTTransactionData | tlv | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setApplicationData | ( | byte[] | name, |
byte[] | tlv | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setCAPK | ( | byte[] | key | ) |
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:
|
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setCRL | ( | byte[] | list | ) |
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] |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setTerminalData | ( | byte[] | tlv | ) |
Set Terminal Data
Sets the Terminal Data as specified by the TerminalData structure passed as a parameter
data | TerminalData configuration file |
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 | ) |
Sets the terminal ID as printable characters .
terminalID | Terminal ID to set |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_setTerminalMajorConfiguration | ( | int | configuration | ) |
Sets the terminal major configuration in ICS .
configuration | A configuration value, range 1-4
|
RETURN_CODE IDTechSDK.IDT_SpectrumPro.emv_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline | ||
) |
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) |
amtOther | Other amount value, if any (tag value 9F03) |
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 a string. Example, tag 9F0C with amount 0x000000000100 would be "9F0C06000000000100" 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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.icc_getICCReaderStatus | ( | ref byte | status | ) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.icc_getICCStatus | ( | ref byte[] | status, |
ref byte[] | atr | ||
) |
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. |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.icc_powerOffICC | ( | ) |
Power Off ICC
Powers down the ICC
If Success, empty If Failure, ASCII encoded data of error string
RETURN_CODE IDTechSDK.IDT_SpectrumPro.icc_powerOnICC | ( | ref byte[] | ATR | ) |
Power On ICC
Power up the currently selected microprocessor card in the ICC reader
RETURN_CODE IDTechSDK.IDT_SpectrumPro.msr_cancelMSRSwipe | ( | ) |
Disable MSR Swipe Cancels MSR swipe request.
RETURN_CODE IDTechSDK.IDT_SpectrumPro.msr_clearMSRData | ( | ) |
Clear MSR Data
Clears the MSR Data buffer
RETURN_CODE IDTechSDK.IDT_SpectrumPro.msr_getMSRData | ( | ref IDTTransactionData | card | ) |
Get MSR Data
Reads the MSR Data buffer
@param card Card data
RETURN_CODE IDTechSDK.IDT_SpectrumPro.msr_startMSRSwipe | ( | int | timeout | ) |
Enable MSR Swipe
Enables MSR, waiting for swipe to occur. Allows track selection. Returns IDTMSRData instance to deviceDelegate::swipeMSRData:()
timeout | Swipe Timeout Value |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.pin_cancelPINEntry | ( | ) |
Cancel PIN Entry
Cancels PIN entry request
RETURN_CODE IDTechSDK.IDT_SpectrumPro.pin_getPIN | ( | int | mode, |
int | PANSource, | ||
string | iccPAN, | ||
int | startTimeout, | ||
int | entryTimeout, | ||
string | language | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_SpectrumPro.pin_passThoughMode | ( | bool | enable | ) |
Pin Pass Through
Enables all commands to be passed through the PINpad
enable | TRUE = all commands passed through, FALSE = commands not passed through |
|
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); |
context | The context of the UI thread |
|
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. |
isSRED | IF Secure/SRED, pass TRUE. Otherwise, pass FALSE |
|
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; |
isSRED | IF Secure/SRED, pass TRUE. Otherwise, pass FALSE |
|
static |
Use USB Interface
Instructs SDK to attempt to use USB for communication with Spectrum Pro
|
staticget |
Singleton Instance
Establishes an singleton instance of Spectrum Pro class.