![]() |
IDTech Windows SDK Guide
1.00.029
API reference for UniPay
|
Public Member Functions | |
RETURN_CODE | device_getFirmwareVersion (ref string response) |
RETURN_CODE | device_getBootloaderVersion (ref string response) |
RETURN_CODE | config_getModelNumber (ref string response) |
RETURN_CODE | config_getSerialNumber (ref string response) |
bool | config_setCmdTimeOutDuration (int newTimeOut) |
RETURN_CODE | device_getBatteryVoltage (ref string voltage) |
RETURN_CODE | device_rebootDevice () |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response) |
RETURN_CODE | icc_exchangeAPDU (string c_APDU, ref byte[] response) |
RETURN_CODE | icc_getAPDU_KSN (ref byte[] ksn) |
RETURN_CODE | icc_getICCReaderStatus (ref byte status) |
RETURN_CODE | icc_getKeyFormatForICCDUKPT (ref byte format) |
RETURN_CODE | icc_getKeyTypeForICCDUKPT (ref byte type) |
RETURN_CODE | icc_powerOffICC () |
RETURN_CODE | icc_powerOnICC (ref byte[] ATR) |
RETURN_CODE | icc_setKeyFormatForICCDUKPT (byte encryption) |
RETURN_CODE | icc_setKeyTypeForICCDUKPT (byte encryption) |
RETURN_CODE | msr_cancelMSRSwipe () |
RETURN_CODE | msr_getClearPANID (ref byte value) |
RETURN_CODE | msr_getExpirationMask (ref byte value) |
RETURN_CODE | msr_getSwipeEncryption (ref byte encryption) |
RETURN_CODE | msr_getSwipeForcedEncryptionOption (ref byte option) |
RETURN_CODE | msr_getSwipeMaskOption (ref byte option) |
RETURN_CODE | msr_setClearPANID (byte val) |
RETURN_CODE | msr_setExpirationMask (bool mask) |
RETURN_CODE | msr_setSwipeEncryption (byte encryption) |
RETURN_CODE | msr_setSwipeForcedEncryptionOption (bool track1, bool track2, bool track3, bool track3card0) |
RETURN_CODE | msr_setSetting (byte setting, byte[] value) |
RETURN_CODE | msr_getSetting (byte setting, ref byte[] value) |
RETURN_CODE | msr_setSwipeMaskOption (bool track1, bool track2, bool track3) |
RETURN_CODE | msr_startMSRSwipe (int timeout) |
Static Public Member Functions | |
static void | loadDLLs () |
static void | setCallback (CallBack my_Callback) |
static void | setCallback (IntPtr my_Callback, SynchronizationContext context) |
static String | SDK_Version () |
Properties | |
static IDT_UniPay | SharedController [get] |
Class for UniPay MSR/ICC reader
RETURN_CODE IDTechSDK.IDT_UniPay.config_getModelNumber | ( | ref string | response | ) |
Polls device for Model Number
response | Returns Model Number |
RETURN_CODE IDTechSDK.IDT_UniPay.config_getSerialNumber | ( | ref string | response | ) |
Polls device for Serial Number
response | Returns Serial Number |
bool IDTechSDK.IDT_UniPay.config_setCmdTimeOutDuration | ( | int | newTimeOut | ) |
Command Acknowledgement Timout
Sets the amount of seconds to wait for an {ACK} to a command before a timeout. Responses should normally be received under one second. Default is 3 seconds
newTimeOut | Timout value. Valid range 1 - 60 seconds |
RETURN_CODE IDTechSDK.IDT_UniPay.device_getBatteryVoltage | ( | ref string | voltage | ) |
Polls device for Battery Voltage
voltage | Returns Battery Voltage as 4-chararacter string * 100. Example: "0186" = 1.86v. "1172" = 11.72v. |
RETURN_CODE |
|
RETURN_CODE IDTechSDK.IDT_UniPay.device_getBootloaderVersion | ( | ref string | response | ) |
Polls device for Bootloader Version
Puts device in bootloader mode so it can return bootloader version. Remains in bootloader mode until timeout of 30 seconds is reached. During this time, only command that may be executed is device_getFirmwareVersion, which will return bootloader version
response | Response returned of Bootloader Version |
RETURN_CODE IDTechSDK.IDT_UniPay.device_getFirmwareVersion | ( | ref string | response | ) |
Polls device for Firmware Version
response | Response returned of Firmware Version |
RETURN_CODE IDTechSDK.IDT_UniPay.device_rebootDevice | ( | ) |
Reboot Device
Executes a command to restart the device.
RETURN_CODE IDTechSDK.IDT_UniPay.device_sendDataCommand | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response | ||
) |
Send a NSData object to device
Sends a command represented by the provide NSData object to the device through the accessory protocol.
cmd | NSData 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_UniPay.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.
c_APDU | APDU data packet |
response | Unencrypted/encrypted parsed APDU response |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_getAPDU_KSN | ( | ref byte[] | ksn | ) |
Get APDU KSN
Retrieves the KSN used in ICC Encypted APDU usage
ksn | Returns the encrypted APDU packet KSN |
RETURN_CODE IDTechSDK.IDT_UniPay.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_UniPay.icc_getKeyFormatForICCDUKPT | ( | ref byte | format | ) |
Get Key Format For ICC DUKPT
Specifies how data will be encrypted with Data Key or PIN key (if DUKPT key loaded)
format | Response returned from method:
|
RETURN_CODE IDTechSDK.IDT_UniPay.icc_getKeyTypeForICCDUKPT | ( | ref byte | type | ) |
Get Key Type for ICC DUKPT
Specifies the key type used for ICC DUKPT encryption
type | Response returned from method:
|
RETURN_CODE IDTechSDK.IDT_UniPay.icc_powerOffICC | ( | ) |
Power Off ICC
Powers down the ICC
If Success, empty If Failure, ASCII encoded data of error string
RETURN_CODE IDTechSDK.IDT_UniPay.icc_powerOnICC | ( | ref byte[] | ATR | ) |
Power On ICC
Power up the currently selected microprocessor card in the ICC reader
RETURN_CODE IDTechSDK.IDT_UniPay.icc_setKeyFormatForICCDUKPT | ( | byte | encryption | ) |
Set Key Format for ICC DUKPT
Sets how data will be encrypted, with either TDES or AES (if DUKPT key loaded)
encryption | Encryption Type
|
RETURN_CODE IDTechSDK.IDT_UniPay.icc_setKeyTypeForICCDUKPT | ( | byte | encryption | ) |
Set Key Type for ICC DUKPT Key
Sets which key the data will be encrypted with, with either Data Key or PIN key (if DUKPT key loaded)
encryption | Encryption Type
|
|
static |
Load DLL's
Instructs SDK to load device DLLs. Should be executed on SDK initialization.
RETURN_CODE IDTechSDK.IDT_UniPay.msr_cancelMSRSwipe | ( | ) |
Disable MSR Swipe Cancels MSR swipe request.
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getClearPANID | ( | ref byte | value | ) |
Get Clear PAN Digits
Returns the number of digits that begin the PAN that will be in the clear
value | Number of digits in clear. Values are char '0' - '6': |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getExpirationMask | ( | ref byte | value | ) |
Get Expiration Masking
Get the flag that determines if to mask the expiration date
value | '0' = masked, '1' = not-masked |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getSetting | ( | byte | setting, |
ref byte[] | value | ||
) |
Get MSR Setting value
Returns the encryption used for sweip data
setting | MSR Setting to retrieve |
value | MSR Setting value |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getSwipeEncryption | ( | ref byte | encryption | ) |
Get Swipe Data Encryption
Returns the encryption used for sweip data
encryption | 1 = TDES, 2 = AES, 0 = NONE |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getSwipeForcedEncryptionOption | ( | ref byte | option | ) |
Get Swipe Data Encryption
Gets the swipe force encryption options
option | Byte using lower four bits as flags. 0 = Force Encryption Off, 1 = Force Encryption On bit0 = Track 1 bit1 = Track 2 bit2 = Track 3 bit4 = Track 3 Card Option 0 |
Example: Response 0x03 = Track1/Track2 Forced Encryption, Track3/Track3-0 no Forced Encryption
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getSwipeMaskOption | ( | ref byte | option | ) |
Get Swipe Mask Option
Gets the swipe mask/clear data sending option
option | Byte using lower three bits as flags. 0 = Mask Option Off, 1 = Mask Option On bit0 = Track 1 bit1 = Track 2 bit2 = Track 3 |
Example: Response 0x03 = Track1/Track2 Masked Option ON, Track3 Masked Option Off
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setClearPANID | ( | byte | val | ) |
Set Clear PAN Digits
Sets the amount of digits shown in the clear (not masked) at the beginning of the returned PAN value
val | Number of digits to show in clear. Range 0-6. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setExpirationMask | ( | bool | mask | ) |
Set Expiration Masking
Sets the flag to mask the expiration date
mask | TRUE = mask expiration |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setSetting | ( | byte | setting, |
byte[] | value | ||
) |
Set MSR Setting value
setting | MSR Setting to set |
value | MSR Setting value |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setSwipeEncryption | ( | byte | encryption | ) |
Set Swipe Data Encryption
Sets the swipe encryption method
encryption | 1 = TDES, 2 = AES |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setSwipeForcedEncryptionOption | ( | bool | track1, |
bool | track2, | ||
bool | track3, | ||
bool | track3card0 | ||
) |
Set Swipe Force Encryption
Sets the swipe force encryption options
track1 | Force encrypt track 1 |
track2 | Force encrypt track 2 |
track3 | Force encrypt track 3 |
track3card0 | Force encrypt track 3 when card type is 0 |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setSwipeMaskOption | ( | bool | track1, |
bool | track2, | ||
bool | track3 | ||
) |
Set Swipe Mask Option
Sets the swipe mask/clear data sending option
track1 | Mask track 1 allowed |
track2 | Mask track 2 allowed |
track3 | Mask track 3 allowed |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_startMSRSwipe | ( | int | timeout | ) |
Enable MSR Swipe
Enables MSR, waiting for swipe to occur.
timeout | Swipe Timeout Value |
|
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 |
|
staticget |
Singleton Instance
Establishes an singleton instance of IDT_UniPay class.