IDTech Windows SDK Guide  1.2.172.2
API reference for UniPay 1.5
IDTechSDK.IDT_UniPayI_V Class Reference

Public Member Functions

RETURN_CODE config_getSerialNumber (ref string response)
 
RETURN_CODE device_getDRS (ref byte[] codeDRS)
 
RETURN_CODE device_sendPAE (string command, ref string response, int timeout, string ip="")
 
RETURN_CODE device_getFirmwareVersion (ref string response)
 
RETURN_CODE device_selfCheck ()
 
RETURN_CODE device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response)
 
RETURN_CODE device_sendDataCommand_ext (string cmd, bool calcLRC, ref byte[] response, int timeout, bool noResponse)
 
RETURN_CODE msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode)
 
RETURN_CODE msr_startMSRSwipe (int timeout)
 
RETURN_CODE msr_cancelMSRSwipe ()
 
RETURN_CODE emv_cancelTransaction ()
 
RETURN_CODE emv_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false)
 
RETURN_CODE emv_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false)
 
RETURN_CODE device_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false)
 
RETURN_CODE device_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false)
 
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_retrieveTransactionResult (byte[] tags, ref IDTTransactionData tlv)
 
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_retrieveApplicationData (byte[] AID, ref byte[] tlv)
 
RETURN_CODE emv_retrieveAIDList (ref byte[][] response)
 
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_removeTerminalData ()
 
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)
 
RETURN_CODE emv_setTerminalMajorConfiguration (int configuration)
 
RETURN_CODE device_pingDevice ()
 
RETURN_CODE device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response)
 
RETURN_CODE device_sendVivoCommandP2_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse)
 
RETURN_CODE device_startRKI ()
 
RETURN_CODE device_setTerminalData (byte[] tlv)
 
RETURN_CODE device_retrieveTerminalData (ref byte[] tlv)
 
RETURN_CODE device_setBurstMode (byte mode)
 
RETURN_CODE device_setPollMode (byte mode)
 
RETURN_CODE icc_getICCReaderStatus (ref byte status)
 
RETURN_CODE icc_powerOffICC ()
 
RETURN_CODE icc_powerOnICC (ref byte[] ATR)
 
RETURN_CODE icc_exchangeAPDU (string c_APDU, ref byte[] response)
 
RETURN_CODE device_enablePassThrough (bool enablePassThrough)
 
RETURN_CODE emv_getEMVKernelCheckValue (ref string response)
 
RETURN_CODE emv_getEMVConfigurationCheckValue (ref string response)
 
string device_getResponseCodeString (RETURN_CODE eCode)
 
RETURN_CODE device_SymmetricRKI (int type)
 

Static Public Member Functions

static int getCommandTimeout ()
 
static void setCommandTimeout (int milliseconds)
 
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)
 
static RETURN_CODE device_updateDeviceFirmware (byte[] firmwareData)
 
static void lcd_retrieveMessage (DisplayMessages.DISPLAY_MESSAGE_LANGUAGE lang, DisplayMessages.DISPLAY_MESSAGE_IDENTIFIER id, ref string line1, ref string line2)
 

Properties

static IDT_UniPayI_V SharedController [get]
 

Detailed Description

Class for UniPayI_V MSR/ICC reader

Member Function Documentation

RETURN_CODE IDTechSDK.IDT_UniPayI_V.config_getSerialNumber ( ref string  response)

Polls device for Serial Number

Parameters
responseReturns Serial Number
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_activateTransaction ( int  timeout,
byte[]  tags,
bool  forceOnline,
bool  isFastEMV = false 
)

Start EMV Transaction Request

Authorizes the EMV transaction for an ICC card

The tags will be returned in the callback routine.

Parameters
timeoutTimeout value in seconds.
tagsThe tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100
forceOnlineTRUE = 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
isFastEMVIf 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
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_enablePassThrough ( bool  enablePassThrough)

Enable Pass Through

Enables Pass Through Mode for direct communication with L1 interface (power on icc, send apdu, etc).

Parameters
enablePassThroughtrue = pass through ON, false = pass through OFF
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_getDRS ( ref byte[]  codeDRS)

Get DRS Status

Gets the status of DRS(Destructive Reset). For TTK Version Only.

Parameters
codeDRSthe data format is [DRS SourceBlk Number] [SourceBlk1] … [SourceBlkN] [DRS SourceBlk Number] is 2 bytes, format is NumL NumH. It is Number of [SourceBlkX] [SourceBlkX] is n bytes, Format is [SourceID] [SourceLen] [SourceData] [SourceID] is 1 byte [SourceLen] is 1 byte, it is length of [SourceData]

[SourceID] [SourceLen] [SourceData] 00 1 01 – Application Error 01 1 01 – Application Error 02 1 0x01 – EMV L2 Configuration Check Value Error 0x02 – Future Key Check Value Error 10 1 01 – Battery Error 11 1 Bit 0 – Tamper Switch 1 (0-No, 1-Error) Bit 1– Tamper Switch 2 (0-No, 1-Error) Bit 2– Tamper Switch 3 (0-No, 1-Error) Bit 3– Tamper Switch 4 (0-No, 1-Error) Bit 4– Tamper Switch 5 (0-No, 1-Error) Bit 5– Tamper Switch 6 (0-No, 1-Error)

12 1 01 –TemperatureHigh or Low 13 1 01 –Voltage High or Low 1F 4 Reg31~24bits, Reg23~16bits, Reg15~8bits, Reg7~0bits

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_getFirmwareVersion ( ref string  response)

Polls device for Firmware Version

Parameters
responseResponse returned of Firmware Version
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
string IDTechSDK.IDT_UniPayI_V.device_getResponseCodeString ( RETURN_CODE  eCode)

Get the description of response result.

Parameters
eCodethe response result.
Return values
thestring for description of response result
  • case 0: "no error, beginning task";
  • case 1: "no response from reader";
  • case 2: "invalid response data";
  • case 3: "time out for task or CMD";
  • case 4: "wrong parameter";
  • case 5: "SDK is doing MSR or ICC task";
  • case 6: "SDK is doing PINPad task";
  • case 7: "SDK is doing CTLS task";
  • case 8: "SDK is doing EMV task";
  • case 9: "SDK is doing Other task";
  • case 10: "err response or data";
  • case 11: "no reader attached";
  • case 12: "mono audio is enabled";
  • case 13: "did connection";
  • case 14: "audio volume is too low";
  • case 15: "task or CMD be canceled";
  • case 16: "UF wrong string format";
  • case 17: "UF file not found";
  • case 18: "UF wrong file format";
  • case 19: "Attempt to contact online host failed";
  • case 20: "Attempt to perform RKI failed";
  • case 0x300: "Key Type(TDES) of Session Key is not same as the related Master Key.";
  • case 0x400: "Related Key was not loaded.";
  • case 0x500: "Key Same.";
  • case 0x501: "Key is all zero";
  • case 0x502: "TR-31 format error";
  • case 0x702: "PAN is Error Key.";
  • case 0x705: "No Internal MSR PAN (or Internal MSR PAN is erased timeout)";
  • case 0X0C01: "Incorrect Frame Tag";
  • case 0X0C02: "Incorrect Frame Type";
  • case 0X0C03: "Unknown Frame Type";
  • case 0X0C04: "Unknown Command";
  • case 0X0C05: "Unknown Sub-Command";
  • case 0X0C06: "CRC Error";
  • case 0X0C07: "Failed";
  • case 0X0C08: "Timeout";
  • case 0X0C0A: "Incorrect Parameter";
  • case 0X0C0B: "Command Not Supported";
  • case 0X0C0C: "Sub-Command Not Supported";
  • case 0X0C0D: "Parameter Not Supported / Status Abort Command";
  • case 0X0C0F: "Sub-Command Not Allowed";
  • case 0X0D01: "Incorrect Header Tag";
  • case 0X0D02: "Unknown Command";
  • case 0X0D03: "Unknown Sub-Command";
  • case 0X0D04: "CRC Error in Frame";
  • case 0X0D05: "Incorrect Parameter";
  • case 0X0D06: "Parameter Not Supported";
  • case 0X0D07: "Mal-formatted Data";
  • case 0X0D08: "Timeout";
  • case 0X0D0A: "Failed / NACK";
  • case 0X0D0B: "Command not Allowed";
  • case 0X0D0C: "Sub-Command not Allowed";
  • case 0X0D0D: "Buffer Overflow (Data Length too large for reader buffer)";
  • case 0X0D0E: "User Interface Event";
  • case 0X0D11: "Communication type not supported, VT-1, burst, etc.";
  • case 0X0D12: "Secure interface is not functional or is in an intermediate state.";
  • case 0X0D13: "Data field is not mod 8";
  • case 0X0D14: "Pad 0x80 not found where expected";
  • case 0X0D15: "Specified key type is invalid";
  • case 0X0D1: "Could not retrieve key from the SAM(InitSecureComm)";
  • case 0X0D17: "Hash code problem";
  • case 0X0D18: "Could not store the key into the SAM(InstallKey)";
  • case 0X0D19: "Frame is too large";
  • case 0X0D1A: "Unit powered up in authentication state but POS must resend the InitSecureComm command";
  • case 0X0D1B: "The EEPROM may not be initialized because SecCommInterface does not make sense";
  • case 0X0D1C: "Problem encoding APDU";
  • case 0X0D20: "Unsupported Index(ILM) SAM Transceiver error – problem communicating with the SAM(Key Mgr)";
  • case 0X0D2: "Unexpected Sequence Counter in multiple frames for single bitmap(ILM) Length error in data returned from the SAM(Key Mgr)";
  • case 0X0D22: "Improper bit map(ILM)";
  • case 0X0D23: "Request Online Authorization";
  • case 0X0D24: "ViVOCard3 raw data read successful";
  • case 0X0D25: "Message index not available(ILM) ViVOcomm activate transaction card type(ViVOcomm)";
  • case 0X0D26: "Version Information Mismatch(ILM)";
  • case 0X0D27: "Not sending commands in correct index message index(ILM)";
  • case 0X0D28: "Time out or next expected message not received(ILM)";
  • case 0X0D29: "ILM languages not available for viewing(ILM)";
  • case 0X0D2A: "Other language not supported(ILM)";
  • case 0X0D41: "Unknown Error from SAM";
  • case 0X0D42: "Invalid data detected by SAM";
  • case 0X0D43: "Incomplete data detected by SAM";
  • case 0X0D44: "Reserved";
  • case 0X0D45: "Invalid key hash algorithm";
  • case 0X0D46: "Invalid key encryption algorithm";
  • case 0X0D47: "Invalid modulus length";
  • case 0X0D48: "Invalid exponent";
  • case 0X0D49: "Key already exists";
  • case 0X0D4A: "No space for new RID";
  • case 0X0D4B: "Key not found";
  • case 0X0D4C: "Crypto not responding";
  • case 0X0D4D: "Crypto communication error";
  • case 0X0D4E: "Module-specific error for Key Manager";
  • case 0X0D4F: "All key slots are full (maximum number of keys has been installed)";
  • case 0X0D50: "Auto-Switch OK";
  • case 0X0D51: "Auto-Switch failed";
  • case 0X0D90: "Account DUKPT Key not exist";
  • case 0X0D91: "Account DUKPT Key KSN exausted";
  • case 0x0D00: "This Key had been loaded.";
  • case 0x0E00: "Base Time was loaded.";
  • case 0x0F00: "Encryption Or Decryption Failed.";
  • case 0x1000: "Battery Low Warning (It is High Priority Response while Battery is Low.)";
  • case 0x1800: "Send “Cancel Command” after send “Get Encrypted PIN” &”Get Numeric “& “Get Amount”";
  • case 0x1900: "Press “Cancel” key after send “Get Encrypted PIN” &”Get Numeric “& “Get Amount”";
  • case 0x30FF: "Security Chip is not connect";
  • case 0x3000: "Security Chip is deactivation & Device is In Removal Legally State.";
  • case 0x3101: "Security Chip is activation & Device is In Removal Legally State.";
  • case 0x5500: "No Admin DUKPT Key.";
  • case 0x5501: "Admin DUKPT Key STOP.";
  • case 0x5502: "Admin DUKPT Key KSN is Error.";
  • case 0x5503: "Get Authentication Code1 Failed.";
  • case 0x5504: "Validate Authentication Code Error.";
  • case 0x5505: "Encrypt or Decrypt data failed.";
  • case 0x5506: "Not Support the New Key Type.";
  • case 0x5507: "New Key Index is Error.";
  • case 0x5508: "Step Error.";
  • case 0x5509: "KSN Error";
  • case 0x550A: "MAC Error.";
  • case 0x550B: "Key Usage Error.";
  • case 0x550C: "Mode Of Use Error.";
  • case 0x550F: "Other Error.";
  • case 0x6000: "Save or Config Failed / Or Read Config Error.";
  • case 0x6200: "No Serial Number.";
  • case 0x6900: "Invalid Command - Protocol is right, but task ID is invalid.";
  • case 0x6A01: "Unsupported Command – Protocol and task ID are right, but command is invalid – In this State";
  • case 0x6A00: "Unsupported Command - Protocol and task ID are right, but command is invalid.";
  • case 0x6B00: "Unknown parameter in command - Protocol task ID and command are right, but parameter is invalid.";
  • case 0x6C00: "Unknown parameter in command – Protocol task ID and command are right, but length is out of the requirement.";
  • case 0x7200: "Device is suspend (MKSK suspend or press password suspend).";
  • case 0x7300: "PIN DUKPT is STOP (21 bit 1).";
  • case 0x7400: "Device is Busy.";
  • case 0xE100: "Can not enter sleep mode";
  • case 0xE200: "File has existed";
  • case 0xE300: "File has not existed";
  • case 0xE313: "IO line low -- Card error after session start";
  • case 0xE400: "Open File Error";
  • case 0xE500: "SmartCard Error";
  • case 0xE600: "Get MSR Card data is error";
  • case 0xE700: "Command time out";
  • case 0xE800: "File read or write is error";
  • case 0xE900: "Active 1850 error!";
  • case 0xEA00: "Load bootloader error";
  • case 0xEF00: "Protocol Error- STX or ETX or check error.";
  • case 0xEB00: "Picture is not exist";
  • case 0x2C02: "No Microprocessor ICC seated";
  • case 0x2C06: "no card seated to request ATR";
  • case 0x2D01: "Card Not Supported,";
  • case 0x2D03: "Card Not Supported, wants CRC";
  • case 0x690D: "Command not supported on reader without ICC support";
  • case 0x8100: "ICC error time out on power-up";
  • case 0x8200: "invalid TS character received - Wrong operation step";
  • case 0x8300: "Decode MSR Error";
  • case 0x8400: "TriMagII no Response";
  • case 0x8500: "No Swipe MSR Card";
  • case 0x8510: "No Financial Card";
  • case 0x8600: "Unsupported F, D, or combination of F and D";
  • case 0x8700: "protocol not supported EMV TD1 out of range";
  • case 0x8800: "power not at proper level";
  • case 0x8900: "ATR length too long";
  • case 0x8B01: "EMV invalid TA1 byte value";
  • case 0x8B02: "EMV TB1 required";
  • case 0x8B03: "EMV Unsupported TB1 only 00 allowed";
  • case 0x8B04: "EMV Card Error, invalid BWI or CWI";
  • case 0x8B06: "EMV TB2 not allowed in ATR";
  • case 0x8B07: "EMV TC2 out of range";
  • case 0x8B08: "EMV TC2 out of range";
  • case 0x8B09: "per EMV96 TA3 must be > 0xF";
  • case 0x8B10: "ICC error on power-up";
  • case 0x8B11: "EMV T=1 then TB3 required";
  • case 0x8B12: "Card Error, invalid BWI or CWI";
  • case 0x8B13: "Card Error, invalid BWI or CWI";
  • case 0x8B17: "EMV TC1/TB3 conflict-";
  • case 0x8B20: "EMV TD2 out of range must be T=1";
  • case 0x8C00: "TCK error";
  • case 0xA304: "connector has no voltage setting";
  • case 0xA305: "ICC error on power-up invalid (SBLK(IFSD) exchange";
  • case 0xE301: "ICC error after session start";
  • case 0xFF00: "Request to go online";
  • case 0xFF01: "EMV: Accept the offline transaction";
  • case 0xFF02: "EMV: Decline the offline transaction";
  • case 0xFF03: "EMV: Accept the online transaction";
  • case 0xFF04: "EMV: Decline the online transaction";
  • case 0xFF05: "EMV: Application may fallback to magstripe technology";
  • case 0xFF06: "EMV: ICC detected tah the conditions of use are not satisfied";
  • case 0xFF07: "EMV: ICC didn't accept transaction";
  • case 0xFF08: "EMV: Transaction was cancelled";
  • case 0xFF09: "EMV: Application was not selected by kernel or ICC format error or ICC missing data error";
  • case 0xFF0A: "EMV: Transaction is terminated";
  • case 0xFF0B: "EMV: Other EMV Error";
  • case 0xFFFF: "NO RESPONSE";
  • case 0xF002: "ICC communication timeout";
  • case 0xF003: "ICC communication Error";
  • case 0xF00F: "ICC Card Seated and Highest Priority, disable MSR work request";
  • case 0xF200: "AID List / Application Data is not exist";
  • case 0xF201: "Terminal Data is not exist";
  • case 0xF202: "TLV format is error";
  • case 0xF203: "AID List is full";
  • case 0xF204: "Any CA Key is not exist";
  • case 0xF205: "CA Key RID is not exist";
  • case 0xF206: "CA Key Index it not exist";
  • case 0xF207: "CA Key is full";
  • case 0xF208: "CA Key Hash Value is Error";
  • case 0xF209: "Transaction format error";
  • case 0xF20A: "The command will not be processing";
  • case 0xF20B: "CRL is not exist";
  • case 0xF20C: "CRL number exceed max number";
  • case 0xF20D: "Amount,Other Amount,Trasaction Type are missing";
  • case 0xF20E: "The Identification of algorithm is mistake";
  • case 0xF20F: "No Financial Card";
  • case 0xF210: "In Encrypt Result state, TLV total Length is greater than Max Length";
  • case 0x1001: "INVALID ARG";
  • case 0x1002: "FILE_OPEN_FAILED";
  • case 0x1003: "FILE OPERATION_FAILED";
  • case 0x2001: "MEMORY_NOT_ENOUGH";
  • case 0x3002: "SMARTCARD_FAIL";
  • case 0x3003: "SMARTCARD_INIT_FAILED";
  • case 0x3004: "FALLBACK_SITUATION";
  • case 0x3005: "SMARTCARD_ABSENT";
  • case 0x3006: "SMARTCARD_TIMEOUT";
  • case 0x5001: "EMV_PARSING_TAGS_FAILED";
  • case 0x5002: "EMV_DUPLICATE_CARD_DATA_ELEMENT";
  • case 0x5003: "EMV_DATA_FORMAT_INCORRECT";
  • case 0x5004: "EMV_NO_TERM_APP";
  • case 0x5005: "EMV_NO_MATCHING_APP";
  • case 0x5006: "EMV_MISSING_MANDATORY_OBJECT";
  • case 0x5007: "EMV_APP_SELECTION_RETRY";
  • case 0x5008: "EMV_GET_AMOUNT_ERROR";
  • case 0x5009: "EMV_CARD_REJECTED";
  • case 0x5010: "EMV_AIP_NOT_RECEIVED";
  • case 0x5011: "EMV_AFL_NOT_RECEIVED";
  • case 0x5012: "EMV_AFL_LEN_OUT_OF_RANGE";
  • case 0x5013: "EMV_SFI_OUT_OF_RANGE";
  • case 0x5014: "EMV_AFL_INCORRECT";
  • case 0x5015: "EMV_EXP_DATE_INCORRECT";
  • case 0x5016: "EMV_EFF_DATE_INCORRECT";
  • case 0x5017: "EMV_ISS_COD_TBL_OUT_OF_RANGE";
  • case 0x5018: "EMV_CRYPTOGRAM_TYPE_INCORRECT";
  • case 0x5019: "EMV_PSE_NOT_SUPPORTED_BY_CARD";
  • case 0x5020: "EMV_USER_SELECTED_LANGUAGE";
  • case 0x5021: "EMV_SERVICE_NOT_ALLOWED";
  • case 0x5022: "EMV_NO_TAG_FOUND";
  • case 0x5023: "EMV_CARD_BLOCKED";
  • case 0x5024: "EMV_LEN_INCORRECT";
  • case 0x5025: "CARD_COM_ERROR";
  • case 0x5026: "EMV_TSC_NOT_INCREASED";
  • case 0x5027: "EMV_HASH_INCORRECT";
  • case 0x5028: "EMV_NO_ARC";
  • case 0x5029: "EMV_INVALID_ARC";
  • case 0x5030: "EMV_NO_ONLINE_COMM";
  • case 0x5031: "TRAN_TYPE_INCORRECT";
  • case 0x5032: "EMV_APP_NO_SUPPORT";
  • case 0x5033: "EMV_APP_NOT_SELECT";
  • case 0x5034: "EMV_LANG_NOT_SELECT";
  • case 0x5035: "EMV_NO_TERM_DATA";
  • case 0x6001: "CVM_TYPE_UNKNOWN";
  • case 0x6002: "CVM_AIP_NOT_SUPPORTED";
  • case 0x6003: "CVM_TAG_8E_MISSING";
  • case 0x6004: "CVM_TAG_8E_FORMAT_ERROR";
  • case 0x6005: "CVM_CODE_IS_NOT_SUPPORTED";
  • case 0x6006: "CVM_COND_CODE_IS_NOT_SUPPORTED";
  • case 0x6007: "NO_MORE_CVM";
  • case 0x6008: "PIN_BYPASSED_BEFORE";
  • case 0x7001: "PK_BUFFER_SIZE_TOO_BIG";
  • case 0x7002: "PK_FILE_WRITE_ERROR";
  • case 0x7003: "PK_HASH_ERROR";
  • case 0x8001: "NO_CARD_HOLDER_CONFIRMATION";
  • case 0x8002: "GET_ONLINE_PIN";
  • case 0xD000: "Data not exist";
  • case 0xD001: "Data access error";
  • case 0xD100: "RID not exist";
  • case 0xD101: "RID existed";
  • case 0xD102: "Index not exist";
  • case 0xD200: "Maximum exceeded";
  • case 0xD201: "Hash error";
  • case 0xD205: "System Busy";
  • case 0x0E01: "Unable to go online";
  • case 0x0E02: "Technical Issue";
  • case 0x0E03: "Declined";
  • case 0x0E04: "Issuer Referral transaction";
  • case 0x0F01: "Decline the online transaction";
  • case 0x0F02: "Request to go online";
  • case 0x0F03: "Transaction is terminated";
  • case 0x0F05: "Application was not selected by kernel or ICC format error or ICC missing data error";
  • case 0x0F07: "ICC didn't accept transaction";
  • case 0x0F0A: "Application may fallback to magstripe technology";
  • case 0x0F0C: "Transaction was cancelled";
  • case 0x0F0D: "Timeout";
  • case 0x0F0F: "Other EMV Error";
  • case 0x0F10: "Accept the offline transaction";
  • case 0x0F11: "Decline the offline transaction";
  • case 0x0F21: "ICC detected tah the conditions of use are not satisfied";
  • case 0x0F22: "No app were found on card matching terminal configuration";
  • case 0x0F23: "Terminal file does not exist";
  • case 0x0F24: "CAPK file does not exist";
  • case 0x0F25: "CRL Entry does not exist";
  • case 0x0FFE: "code when blocking is disabled";
  • case 0x0FFF: "code when command is not applicable on the selected device";
  • case 0xF005: "ICC Encrypted C-APDU Data Structure Length Error Or Format Error.";
  • case 0xBBE0: "CM100 Success";
  • case 0xBBE1: "CM100 Parameter Error";
  • case 0xBBE2: "CM100 Low Output Buffer";
  • case 0xBBE3: "CM100 Card Not Found";
  • case 0xBBE4: "CM100 Collision Card Exists";
  • case 0xBBE5: "CM100 Too Many Cards Exist";
  • case 0xBBE6: "CM100 Saved Data Does Not Exist";
  • case 0xBBE8: "CM100 No Data Available";
  • case 0xBBE9: "CM100 Invalid CID Returned";
  • case 0xBBEA: "CM100 Invalid Card Exists";
  • case 0xBBEC: "CM100 Command Unsupported";
  • case 0xBBED: "CM100 Error In Command Process";
  • case 0xBBEE: "CM100 Invalid Command";
  • case 0X9031: "Unknown command";
  • case 0X9032: "Wrong parameter (such as the length of the command is incorrect)";
  • case 0X9038: "Wait (the command couldn’t be finished in BWT)";
  • case 0X9039: "Busy (a previously command has not been finished)";
  • case 0X903A: "Number of retries over limit";
  • case 0X9040: "Invalid Manufacturing system data";
  • case 0X9041: "Not authenticated";
  • case 0X9042: "Invalid Master DUKPT Key";
  • case 0X9043: "Invalid MAC Key";
  • case 0X9044: "Reserved for future use";
  • case 0X9045: "Reserved for future use";
  • case 0X9046: "Invalid DATA DUKPT Key";
  • case 0X9047: "Invalid PIN Pairing DUKPT Key";
  • case 0X9048: "Invalid DATA Pairing DUKPT Key";
  • case 0X9049: "No nonce generated";
  • case 0X9949: "No GUID available. Perform getVersion first.";
  • case 0X9950: "MAC Calculation unsuccessful. Check BDK value.";
  • case 0X904A: "Not ready";
  • case 0X904B: "Not MAC data";
  • case 0X9050: "Invalid Certificate";
  • case 0X9051: "Duplicate key detected";
  • case 0X9052: "AT checks failed";
  • case 0X9053: "TR34 checks failed";
  • case 0X9054: "TR31 checks failed";
  • case 0X9055: "MAC checks failed";
  • case 0X9056: "Firmware download failed";
  • case 0X9060: "Log is full";
  • case 0X9061: "Removal sensor unengaged";
  • case 0X9062: "Any hardware problems";
  • case 0X9070: "ICC communication timeout";
  • case 0X9071: "ICC data error (such check sum error)";
  • case 0X9072: "Smart Card not powered up";
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_pingDevice ( )

Ping Device

Pings the reader. If connected, returns success. Otherwise, returns timeout.

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_retrieveTerminalData ( ref byte[]  tlv)

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).

Parameters
tlvResponse returned as a TLV
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_selfCheck ( )

Self check for TTK If Self-Test function Failed, then work into De-activation State. If device work into De-activation State, All Sensitive Data will be erased and it need be fixed in Manufacture.

Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendDataCommand ( string  cmd,
bool  calcLRC,
ref byte[]  response 
)

Send a data command to the device

Sends a command to the device.

Parameters
cmdString representation of command to execute
calcLRCIf TRUE, this will wrap command with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}'
responseResponse data
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendDataCommand_ext ( string  cmd,
bool  calcLRC,
ref byte[]  response,
int  timeout,
bool  noResponse 
)

Send a data command to the device - extended

Sends a command to the device.

Parameters
cmdString representation of command to execute
calcLRCIf TRUE, this will wrap command as NGA with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}'
responseResponse data
timeoutTimeout value waiting for response, in milliseconds (1000 = 1 second)
noResponseif TRUE, this will not wait for a response and immediately return SUCCESS
calcITPIf TRUE, this will wrap command as ITP with start/end/lrc: '{STX} data {ETX}{CheckLRC}'
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendPAE ( string  command,
ref string  response,
int  timeout,
string  ip = "" 
)

Send Payment Application Engine Command

Executes a PAE command

Parameters
commandASCII command string, should start with "*PAE"
responsecommand response
timeouttimeout waiting for PAE response
ipOptional IP address when connected via TCP/IP
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendVivoCommandP2 ( byte  command,
byte  subCommand,
byte[]  data,
ref byte[]  response 
)

Send Vivo Command Protocol 2

Sends a protocol 2 command to Vivo readers (IDG/NEO)

Parameters
commandCommand
subCommandSub-Command
dataData. May be null
responseResponse
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_sendVivoCommandP2_ext ( byte  command,
byte  subCommand,
byte[]  data,
ref byte[]  response,
int  timeout,
bool  noResponse 
)

Send Vivo Command Protocol 2 Extended

Sends a protocol 2 command to Vivo readers (IDG/NEO)

Parameters
commandCommand
subCommandSub-Command
dataData. May be null
responseResponse
timeoutTimeout, in milliseconds (3000 = 3 seconds)
noResponseTRUE = don't wait for response, FALSE = wait for response defined by timeout
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_setBurstMode ( byte  mode)

Send Burst Mode

Sets the burst mode forthe device.

Parameters
mode0 = OFF, 1 = Always On, 2 = Auto Exit

NOTE: USB-KB mode is identical to USB-HID mode except for the following:

  • The device will appear to Windows as a Keyboard device instead of a USB-HID Device
  • If the device is in Burst Mode, and the device is also in Auto Poll mode, swiped data will be output to the keyboard buffer instead of the SDK.
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_setPollMode ( byte  mode)

Send Poll Mode

Sets the poll mode forthe device. Auto Poll keeps reader active, Poll On Demand only polls when requested by terminal

Parameters
mode0 = Auto Poll, 1 = Poll On Demand

NOTE: USB-KB mode is identical to USB-HID mode except for the following:

  • The device will appear to Windows as a Keyboard device instead of a USB-HID Device
  • If the device is in Burst Mode, and the device is also in Auto Poll mode, swiped data will be output to the keyboard buffer instead of the SDK.
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_setTerminalData ( byte[]  tlv)

Set Terminal Data

Sets the Terminal Data for CTLS as specified by the TLV. The first TLV must be Configuration Group Number (Tag FFE4). The terminal global data is group 0, so the first TLV would be FFE40100. Other groups can be defined using this method (1 or greater), and those can be retrieved with emv_getConfigurationGroup(int group), and deleted with emv_removeConfigurationGroup(int group). You cannot delete group 0.

Parameters
tlvTerminalData configuration data
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_startRKI ( )

Start Remote Key Injection

Starts a remote key injection request with IDTech RKI servers.

Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_startTransaction ( double  amount,
double  amtOther,
int  exponent,
int  type,
int  timeout,
byte[]  tags,
bool  forceOnline,
bool  isFastEMV = false 
)

Start EMV Transaction Request

Authorizes the EMV transaction for an ICC card

The tags will be returned in the callback routine.

Parameters
amountTransaction amount value (tag value 9F02)
amtOtherOther amount value, if any (tag value 9F03)
exponentNumber of characters after decimile point
typeTransaction type (tag value 9C).
timeoutTimeout value in seconds.
tagsAny 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.
forceOnlineTRUE = 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
isFastEMVIf 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
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_SymmetricRKI ( int  type)

Start Remote Key Injection

Starts a remote key injection request with IDTech Symmetric RKI servers. Set/Get RKI url with IDT_Device.RKI_URL.

Parameters
type0 = Type A Demo 1 = Type A Production 2 = Type B Demo 3 = Type B Production
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
static RETURN_CODE IDTechSDK.IDT_UniPayI_V.device_updateDeviceFirmware ( byte[]  firmwareData)
static

Update Firmware

Updates the firmware .

Parameters
firmwareDataSigned binary data of a firmware file provided by IDTech
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()

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:

  • sender = IDT_DEVICE_Types.IDT_DEVICE_AUGUSTA
  • state = DeviceState.FirmwareUpdate
  • transactionResultCode = status of the firmware update (starting, entering bootloader, applying update, block success, firmware success)
  • data = File Progress. Four bytes, with bytes [0][1] = current block, and bytes [2][3] = total blocks. 0x00030010 = block 3 of 16

Example code starting a firmware update

OpenFileDialog diag = new OpenFileDialog();
diag.Filter = "NGA FW Files|*.fm";
if (diag.ShowDialog() == DialogResult.OK)
{
byte[] file = File.ReadAllBytes(diag.FileName);
RETURN_CODE rt = IDT_Device.SharedController.device_updateDeviceFirmware(file);
if (rt == RETURN_CODE.RETURN_CODE_DO_SUCCESS)
{
//Was a success
}
else
{
//Error starting firmware download
}
}

Example monitoring firmware update status / success

private void MessageCallBack(IDTechSDK.IDT_DEVICE_Types type, DeviceState state, byte[] data, IDTTransactionData cardData, EMV_Callback emvCallback, RETURN_CODE transactionResultCode)
{
switch (state)
{
case DeviceState.FirmwareUpdate:
switch (transactionResultCode)
{
case RETURN_CODE.RETURN_CODE_FW_STARTING_UPDATE:
SetOutputText("Starting Firmware Update\n");
break;
case RETURN_CODE.RETURN_CODE_DO_SUCCESS:
SetOutputText("Firmware Update Successful\n");
break;
case RETURN_CODE.RETURN_CODE_APPLYING_FIRMWARE_UPDATE:
SetOutputText("Applying Firmware Update....\n");
break;
case RETURN_CODE.RETURN_CODE_ENTERING_BOOTLOADER_MODE:
SetOutputText("Entering Bootloader Mode....\n");
break;
case RETURN_CODE.RETURN_CODE_BLOCK_TRANSFER_SUCCESS:
int start = data[0] * 0x100 + data[1];
int end = data[2] * 0x100 + data[3];
SetOutputText("Sent block " + start.ToString() + " of " + end.ToString() + "\n");
break;
default:
SetOutputText("Firmware Update Error Code: " + "0x" + String.Format("{0:X}", (ushort)transactionResultCode) + ": " + IDTechSDK.errorCode.getErrorString(transactionResultCode) + "\r\n");
break;
}
break;
}
}
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_activateTransaction ( int  timeout,
byte[]  tags,
bool  forceOnline,
bool  isFastEMV = false 
)

Start EMV Transaction Request

Authorizes the EMV transaction for an ICC card

The tags will be returned in the callback routine.

Parameters
timeoutTimeout value in seconds.
tagsThe tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100
forceOnlineTRUE = 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
isFastEMVIf 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
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
static void IDTechSDK.IDT_UniPayI_V.emv_allowFallback ( bool  allow)
static

Allow fallback for EMV transactions. Default is TRUE

Parameters
allowTRUE = allow fallback, FALSE = don't allow fallback
RETURN_CODE IDTechSDK.IDT_UniPayI_V.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.

@param updatedTLV  TLV stream that can be used to update the following values:
 - 9F02: Amount
 - 9F03: Other amount
 - 9C: Transaction type
 - 5F57: Account type
In addition tag DFEE1A can be sent to specify tag list to include in results. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37

  @return RETURN_CODE:  Values can be parsed with device_getResponseCodeString 
static void IDTechSDK.IDT_UniPayI_V.emv_autoAuthenticate ( bool  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

Parameters
authenticateTRUE = auto authenticate, FALSE = manually authenticate
static void IDTechSDK.IDT_UniPayI_V.emv_autoAuthenticate ( bool  authenticate,
byte[]  tags 
)
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

Parameters
authenticateTRUE = auto authenticate, FALSE = manually authenticate
tagsTags to pass during authentication stage;
RETURN_CODE IDTechSDK.IDT_UniPayI_V.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

Parameters
typeIf 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
selectionIf 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
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.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

Parameters
MSRSwiped track data
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.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

Parameters
typeIf 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
KSNIf 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)
PINIf encipherd PIN, this is encrypted PIN block. If device does not implement pairing function, this is plaintext PIN
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_cancelTransaction ( )

Cancel Transaction

Cancels the currently executing EMV transaction.

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.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.

Parameters
commErrorCommunication 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.
authCodeAuthorization code from host. Two bytes. Example 0x3030. (Tag value 8A). Required
iadIssuer Authentication Data, if any. Example 0x11223344556677883030 (tag value 91).
tlvScripts71/72 scripts, if any
tlvAdditional TVL data to return with transaction results (if any)
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString

NOTE: There are three possible outcomes for Authorization Code: Approval, Refer To Bank, Decline. The kernel maps these three outcomes to valid authorization response codes using tag DFEE1B through 8 bytes: {2 bytes Approval Code}{2 bytes Referral Code}{2 bytes Decline Code}{2 bytes RFU} If your gateway uses "00" for Approval, "01" for Referral, and "05" for Decline, then DFEE1B 08 3030 3031 3035 0000 If you use an authorization code value that that is not defined in DFEE1B, the kernel will use the DECLINE value of DFEE1B by default.

RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_getEMVConfigurationCheckValue ( ref string  response)

Polls device for EMV Configuration Check Value

Parameters
responseResponse returned of Check Value of Configuration
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_getEMVKernelCheckValue ( ref string  response)

Polls device for EMV Kernel Check Value

Parameters
responseResponse returned of Check Value of Kernel
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_getEMVKernelVersion ( ref string  response)

Polls device for EMV Kernel Version

Parameters
responseResponse returned of Kernel Version
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeAllApplicationData ( )

Remove All Application Data

Removes all the Application Data for EMV Kernel

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeAllCAPK ( )

Remove All Certificate Authority Public Key

Removes all the CAPK for EMV Kernel

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeAllCRL ( )

Remove All Certificate Revocation List Entries

Removes all CRLEntry entries

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeApplicationData ( byte[]  AID)

Remove Application Data by AID

Removes the Application Data for EMV Kernel as specified by the AID name passed as a parameter

Parameters
AIDName of ApplicationID Must be between 5 and 16 bytes
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeCAPK ( byte[]  capk)

Remove Certificate Authority Public Key

Removes the CAPK for EMV Kernel as specified by the RID/Index

Parameters
capk6 byte CAPK = 5 bytes RID + 1 byte INDEX
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.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

Parameters
crlListcontaining 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]
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_removeTerminalData ( )

Remove Terminal Data

Removes the Terminal Data

Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveAIDList ( ref byte  response[][])

Retrieve AID list

Returns all the AID names installed on the terminal for EMV Kernel.

Parameters
responsearray of AID name byte arrays
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveApplicationData ( byte[]  AID,
ref byte[]  tlv 
)

Retrieve Application Data by AID

Retrieves the Application Data for EMV Kernel as specified by the AID name passed as a parameter.

Parameters
AIDName of ApplicationID. Must be between 5 and 16 bytes
tlvThe TLV elements of the requested AID
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveCAPK ( byte[]  capk,
ref byte[]  key 
)

Retrieve Certificate Authority Public Key

Retrieves the CAPK for EMV Kernel as specified by the RID/Index passed as a parameter.

Parameters
capk6 bytes CAPK = 5 bytes RID + 1 byte Index
keyResponse 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:
  • Hash Algorithm: The only algorithm supported is SHA-1.The value is set to 0x01
  • Encryption Algorithm: The encryption algorithm in which this key is used. Currently support only one type: RSA. The value is set to 0x01.
  • HashValue: Which is calculated using SHA-1 over the following fields: RID & Index & Modulus & Exponent
  • Public Key Exponent: Actually, the real length of the exponent is either one byte or 3 bytes. It can have two values: 3 (Format is 0x00 00 00 03), or 65537 (Format is 0x00 01 00 01)
  • Modulus Length: LenL LenH Indicated the length of the next field.
  • Modulus: This is the modulus field of the public key. Its length is specified in the field above.
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveCAPKList ( ref byte[]  keys)

Retrieve the Certificate Authority Public Key list

Returns all the CAPK RID and Index installed on the terminal for EMV Kernel.

Parameters
keys[key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveCRLList ( ref byte[]  list)

Retrieve the Certificate Revocation List

Returns the CRL entries on the terminal.

Parameters
list[CRL1][CRL2]...[CRLn], each CRL 9 bytes where CRL = 5 bytes RID + 1 byte index + 3 bytes serial number
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveTerminalData ( ref byte[]  tlv)

Retrieve Terminal Data

Retrieves the Terminal Data for EMV Kernel.

Parameters
tlvResponse returned as a TLV
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_retrieveTransactionResult ( byte[]  tags,
ref IDTTransactionData  tlv 
)

Retrieve Transaction Results

Retrieves specified EMV tags from the currently executing transaction.

Parameters
tagsTags to be retrieved. Example 0x9F028A will retrieve tags 9F02 and 8A
tlvAll requested tags returned as unencrypted, encrypted and masked TLV data in IDDTransactionData object
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setApplicationData ( byte[]  name,
byte[]  tlv 
)

Set Application Data by AID

Sets the Application Data for EMV Kernel as specified by the application name and TLV data

Parameters
nameApplication name, 10-32 ASCII hex characters representing 5-16 bytes Example "a0000000031010"
tlvApplication data in TLV format
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setCAPK ( byte[]  key)

Set Certificate Authority Public Key

Sets the CAPK for EMV Kernel as specified by the CAKey structure

Parameters
keyCAKey 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:
  • Hash Algorithm: The only algorithm supported is SHA-1.The value is set to 0x01
  • Encryption Algorithm: The encryption algorithm in which this key is used. Currently support only one type: RSA. The value is set to 0x01.
  • HashValue: Which is calculated using SHA-1 over the following fields: RID & Index & Modulus & Exponent
  • Public Key Exponent: Actually, the real length of the exponent is either one byte or 3 bytes. It can have two values: 3 (Format is 0x00 00 00 03), or 65537 (Format is 0x00 01 00 01)
  • Modulus Length: LenL LenH Indicated the length of the next field.
  • Modulus: This is the modulus field of the public key. Its length is specified in the field above.
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setCRL ( byte[]  list)

Set Certificate Revocation List

Sets the CRL

Parameters
listCRL 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]
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setTerminalData ( byte[]  tlv)

Set Terminal Data

Sets the Terminal Data for EMV Kernel

Parameters
tlvTerminalData configuration data
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_setTerminalMajorConfiguration ( int  configuration)

Set Terminal Major Configuration

Sets the Terminal Data Major Configuration setting

Parameters
configurationThe configuration to set (1-5)
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.emv_startTransaction ( double  amount,
double  amtOther,
int  exponent,
int  type,
int  timeout,
byte[]  tags,
bool  forceOnline,
bool  isFastEMV = false 
)

Start EMV Transaction Request

Authorizes the EMV transaction for an ICC card

The tags will be returned in the callback routine.

Parameters
amountTransaction amount value (tag value 9F02)
amtOtherOther amount value, if any (tag value 9F03)
exponentNumber of characters after decimile point
typeTransaction type (tag value 9C).
timeoutTimeout value in seconds.
tagsAny 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.
forceOnlineTRUE = 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
isFastEMVIf 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
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
static int IDTechSDK.IDT_UniPayI_V.getCommandTimeout ( )
static

Get Command Timeout

Gets the default timeout (in milliseconds) waiting for a blocking command response

Return values
timeTime
RETURN_CODE IDTechSDK.IDT_UniPayI_V.icc_exchangeAPDU ( string  c_APDU,
ref byte[]  response 
)

Exchange APDU

Sends an APDU packet to the ICC. If successful, response is returned in APDUResult class instance in response parameter.

Parameters
c_APDUAPDU data packet
responseUnencrypted/encrypted parsed APDU response
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.icc_getICCReaderStatus ( ref byte  status)

Get Reader Status

Returns the reader status

Parameters
statusPointer 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
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.icc_powerOffICC ( )

Power Off ICC

Powers down the ICC

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()

If Success, empty If Failure, ASCII encoded data of error string

RETURN_CODE IDTechSDK.IDT_UniPayI_V.icc_powerOnICC ( ref byte[]  ATR)

Power On ICC

Power up the currently selected microprocessor card in the ICC reader

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
static void IDTechSDK.IDT_UniPayI_V.lcd_retrieveMessage ( DisplayMessages.DISPLAY_MESSAGE_LANGUAGE  lang,
DisplayMessages.DISPLAY_MESSAGE_IDENTIFIER  id,
ref string  line1,
ref string  line2 
)
static

Retrieve LCD Message

Returns the string value for a message ID returned for LCD messaging

Parameters
langLanguage.
idMessage ID
line1Line 1 string value
line2Line 2 string value
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_UniPayI_V.msr_cancelMSRSwipe ( )

Disable MSR Swipe Cancels MSR swipe request.

Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.msr_startMSRSwipe ( int  timeout)

Enable MSR Swipe

Enables MSR, waiting for swipe to occur.

Parameters
timeoutSwipe Timeout Value
Returns
RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_UniPayI_V.msr_switchUSBInterfaceMode ( bool  bIsUSBKeyboardMode)

Switch the USB interface mode between USB HID and USB KB mode.

Parameters
bIsUSBKeyboardModeUSB interface mode
  • true: Enter into USB Keyboard mode
  • false: Enter into USB HID mode

    NOTE: USB-KB mode is identical to USB-HID mode except for the following:

    • The device will appear to Windows as a Keyboard device instead of a USB-HID Device
    • If the device is in Burst Mode, and the device is also in Auto Poll mode, swiped data will be output to the keyboard buffer instead of the SDK.
Returns
RETURN_CODE: Values can be parsed with device_getResponseCodeString
static String IDTechSDK.IDT_UniPayI_V.SDK_Version ( )
static

SDK Version

  • All Devices

Returns the current version of SDK

Returns
Framework version
static void IDTechSDK.IDT_UniPayI_V.setCallback ( CallBack  my_Callback)
static

Set Callback

Sets the class callback
static void IDTechSDK.IDT_UniPayI_V.setCallback ( IntPtr  my_Callback,
SynchronizationContext  context 
)
static

Set Callback

Sets the class callback

Parameters
my_CallbackThe callback function to receive the response message from device. defined as follows. public unsafe delegate void MFCCallBack(Parameters parameters);
contextThe context of the UI thread
static void IDTechSDK.IDT_UniPayI_V.setCommandTimeout ( int  milliseconds)
static

Set Command Timeout

Sets the default timeout (in milliseconds) waiting for a blocking command response

Parameters
millisecondsTime

Property Documentation

IDT_UniPayI_V IDTechSDK.IDT_UniPayI_V.SharedController
staticget

Singleton Instance

Establishes an singleton instance of IDT_UniPayI_V class.

Returns
Instance of IDT_UniPayI_V

The documentation for this class was generated from the following file: