![]() |
IDTech Windows SDK Guide
1.00.056
API reference for Vendi
|
Public Member Functions | |
RETURN_CODE | config_getSerialNumber (ref string response) |
RETURN_CODE | device_getFirmwareVersion (ref string response) |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response) |
RETURN_CODE | msr_startMSRSwipe (int timeout) |
RETURN_CODE | msr_cancelMSRSwipe () |
RETURN_CODE | emv_cancelTransaction () |
RETURN_CODE | ctls_cancelTransaction () |
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 | ctls_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline) |
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_getEMVKernelCheckValue (ref string response) |
RETURN_CODE | emv_getEMVConfigurationCheckValue (ref string response) |
RETURN_CODE | emv_getEMVKernelVersion (ref string response) |
RETURN_CODE | emv_retrieveTransactionResult (byte[] tags, ref IDTTransactionData tlv) |
RETURN_CODE | emv_removeApplicationData (byte[] AID) |
RETURN_CODE | ctls_removeApplicationData (byte[] AID) |
RETURN_CODE | emv_removeAllApplicationData () |
RETURN_CODE | ctls_removeAllApplicationData () |
RETURN_CODE | emv_removeCAPK (byte[] capk) |
RETURN_CODE | ctls_removeCAPK (byte[] capk) |
RETURN_CODE | emv_removeAllCAPK () |
RETURN_CODE | ctls_removeAllCAPK () |
RETURN_CODE | emv_removeCRL (byte[] crlList) |
RETURN_CODE | emv_removeAllCRL () |
RETURN_CODE | emv_retrieveApplicationData (byte[] AID, ref byte[] tlv) |
RETURN_CODE | ctls_retrieveApplicationData (byte[] AID, ref byte[] tlv) |
RETURN_CODE | emv_retrieveAIDList (ref byte[][] response) |
RETURN_CODE | ctls_retrieveAIDList (ref byte[][] response) |
RETURN_CODE | emv_retrieveCAPK (byte[] capk, ref byte[] key) |
RETURN_CODE | ctls_retrieveCAPK (byte[] capk, ref byte[] key) |
RETURN_CODE | emv_retrieveCAPKList (ref byte[] keys) |
RETURN_CODE | ctls_retrieveCAPKList (ref byte[] keys) |
RETURN_CODE | emv_retrieveCRLList (ref byte[] list) |
RETURN_CODE | ctls_retrieveTerminalData (ref byte[] tlv) |
RETURN_CODE | emv_retrieveTerminalData (ref byte[] tlv) |
RETURN_CODE | emv_setApplicationData (byte[] name, byte[] tlv) |
RETURN_CODE | ctls_setApplicationData (byte[] name, byte[] tlv) |
RETURN_CODE | emv_setCAPK (byte[] key) |
RETURN_CODE | ctls_setCAPK (byte[] key) |
RETURN_CODE | emv_setCRL (byte[] list) |
RETURN_CODE | emv_setTerminalData (byte[] tlv) |
RETURN_CODE | ctls_setTerminalData (byte[] tlv) |
RETURN_CODE | device_pingDevice () |
RETURN_CODE | device_buzzer () |
RETURN_CODE | device_controlLED (byte indexLED, byte control) |
RETURN_CODE | device_controlUserInterface (byte[] values) |
RETURN_CODE | device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response) |
RETURN_CODE | ctls_getConfigurationGroup (int group, ref byte[] tlv) |
RETURN_CODE | ctls_removeConfigurationGroup (int group) |
RETURN_CODE | ctls_getAllConfigurationGroups (ref byte[][] response) |
RETURN_CODE | device_setBurstMode (byte mode) |
RETURN_CODE | device_setPollMode (byte mode) |
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) |
string | device_getResponseCodeString (RETURN_CODE eCode) |
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 () |
static void | emv_autoAuthenticate (bool authenticate) |
static void | emv_allowFallback (bool allow) |
Properties | |
static IDT_UniPayIII | SharedController [get] |
Class for UniPayIII MSR/ICC reader
RETURN_CODE IDTechSDK.IDT_UniPayIII.config_getSerialNumber | ( | ref string | response | ) |
Polls device for Serial Number
response | Returns Serial Number |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_cancelTransaction | ( | ) |
Cancel Transaction
Cancels the currently executing EMV or CTLS transaction.
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_getAllConfigurationGroups | ( | ref byte | response[][] | ) |
Retrieve All Configuration Groups
Returns all the Configuration Groups installed on the terminal for CTLS.
response | array of configuratin group TLV byte arrays |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_getConfigurationGroup | ( | int | group, |
ref byte[] | tlv | ||
) |
Get Configuration Group
Retrieves the Configuration for the specified Group. Group 0 = terminal settings.
group | Configuration Group |
tlv | return data |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_removeAllApplicationData | ( | ) |
Remove All Application Data
Removes all the Application Data for CTLS
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_removeAllCAPK | ( | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK for CTLS
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_removeApplicationData | ( | byte[] | AID | ) |
Remove Application Data by AID
Removes the Application Data for CTLS as specified by the AID name passed as a parameter
AID | Name of ApplicationID Must be between 5 and 16 bytes |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_removeCAPK | ( | byte[] | capk | ) |
Remove Certificate Authority Public Key
Removes the CAPK for CTLS as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_removeConfigurationGroup | ( | int | group | ) |
Remove Configuration Group
Removes the Configuration as specified by the Group. Must not by group 0
group | Configuration Group |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_retrieveAIDList | ( | ref byte | response[][] | ) |
Retrieve AID list
Returns all the AID names installed on the terminal for CTLS.
response | array of AID name byte arrays |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv | ||
) |
Retrieve Application Data by AID
Retrieves the CTLS 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_UniPayIII.ctls_retrieveCAPK | ( | byte[] | capk, |
ref byte[] | key | ||
) |
Retrieve Certificate Authority Public Key
Retrieves the CAPKfor CTLS as specified by the RID/Index passed as a parameter.
capk | 6 bytes CAPK = 5 bytes RID + 1 byte Index |
key | Response returned as a CAKey format: [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_UniPayIII.ctls_retrieveCAPKList | ( | ref byte[] | keys | ) |
Retrieve the Certificate Authority Public Key list
Returns all the CAPK RID and Index installed on the terminal for CTLS.
keys | [key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_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).
tlv | Response returned as a TLV |
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_setApplicationData | ( | byte[] | name, |
byte[] | tlv | ||
) |
Set Application Data by AID
Sets the Application Data for CTLS 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_UniPayIII.ctls_setCAPK | ( | byte[] | key | ) |
Set Certificate Authority Public Key
Sets the CAPK for CTLS as specified by the CAKey structure
key | CAKey format: [5 bytes RID][1 byte Index][1 byte Hash Algorithm][1 byte Encryption Algorithm][20 bytes HashValue][4 bytes Public Key Exponent][2 bytes Modulus Length][Variable bytes Modulus] Where:
|
RETURN_CODE IDTechSDK.IDT_UniPayIII.ctls_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.
tlv | TerminalData configuration data |
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_UniPayIII.ctls_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline | ||
) |
Start a CTLS Transaction Request
Authorizes the CTLS transaction for an CTLS card
The tags will be returned in the callback routine.
amount | Transaction amount value (tag value 9F02) |
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 |
RETURN_CODE IDTechSDK.IDT_UniPayIII.device_buzzer | ( | ) |
Buzzer Device
Buzzer the reader. If success can hear one beep. Otherwise, returns timeout.
RETURN_CODE IDTechSDK.IDT_UniPayIII.device_controlLED | ( | byte | indexLED, |
byte | control | ||
) |
Control LED
Control the reader. If connected, returns success. Otherwise, returns timeout. indexLED description as follows: 00h: LED 0 (Power LED) 01h: LED 1 02h: LED 2 03h: LED 3 10h: Single Tri-Color LED (Unipay III used) FFh: All 4 LEDs + Single Tri-Color LED Where the LEDs are numbered 0, 1, 2, 3 counting from the left. Note: If you are using pass-through mode to control the Power LED (LED 0), it is your responsibility to make sure that it behaves correctly. control description as follows: 00h: LED Off (LED 0~4 + Tri-Color LED) 01h: LED On (LED 0~4) 02h: Green Color (Tri-Color LED) 03h: Red Color (Tri-Color LED) 04h: Amber Color(Tri-Color LED)
RETURN_CODE IDTechSDK.IDT_UniPayIII.device_controlUserInterface | ( | byte[] | values | ) |
Control User Interface
Controls the User Interface: Display, Beep, LED
values | Four bytes to control the user interface Byte[0] = LCD Message Messages 00-07 are normally controlled by the reader.
|
RETURN_CODE IDTechSDK.IDT_UniPayIII.device_enablePassThrough | ( | bool | enablePassThrough | ) |
Enable Pass Through
Enables Pass Through Mode for direct communication with L1 interface (power on icc, send apdu, etc).
enablePassThrough | true = pass through ON, false = pass through OFF |
RETURN_CODE IDTechSDK.IDT_UniPayIII.device_getFirmwareVersion | ( | ref string | response | ) |
Polls device for Firmware Version
response | Response returned of Firmware Version |
string IDTechSDK.IDT_UniPayIII.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_UniPayIII.device_pingDevice | ( | ) |
Ping Device
Pings the reader. If connected, returns success. Otherwise, returns timeout.
RETURN_CODE IDTechSDK.IDT_UniPayIII.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_UniPayIII.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)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
RETURN_CODE IDTechSDK.IDT_UniPayIII.device_setBurstMode | ( | byte | mode | ) |
Send Burst Mode
Sets the burst mode forthe device.
mode | 0 = OFF, 1 = Always On, 2 = Auto Exit |
RETURN_CODE IDTechSDK.IDT_UniPayIII.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
mode | 0 = Auto Poll, 1 = Poll On Demand |
|
static |
Allow fallback for EMV transactions. Default is TRUE
allow | TRUE = allow fallback, FALSE = don't allow fallback |
RETURN_CODE IDTechSDK.IDT_UniPayIII.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 |
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 |
RETURN_CODE IDTechSDK.IDT_UniPayIII.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_UniPayIII.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_UniPayIII.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_UniPayIII.emv_cancelTransaction | ( | ) |
Cancel Transaction
Cancels the currently executing EMV or CTLS transaction.
RETURN_CODE IDTechSDK.IDT_UniPayIII.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_UniPayIII.emv_getEMVConfigurationCheckValue | ( | ref string | response | ) |
Polls device for EMV Configuration Check Value
response | Response returned of Check Value of Configuration |
RETURN_CODE IDTechSDK.IDT_UniPayIII.emv_getEMVKernelCheckValue | ( | ref string | response | ) |
Polls device for EMV Kernel Check Value
response | Response returned of Check Value of Kernel |
RETURN_CODE IDTechSDK.IDT_UniPayIII.emv_getEMVKernelVersion | ( | ref string | response | ) |
Polls device for EMV Kernel Version
response | Response returned of Kernel Version |
RETURN_CODE IDTechSDK.IDT_UniPayIII.emv_removeAllApplicationData | ( | ) |
Remove All Application Data
Removes all the Application Data for EMV Kernel
RETURN_CODE IDTechSDK.IDT_UniPayIII.emv_removeAllCAPK | ( | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK for EMV Kernel
RETURN_CODE IDTechSDK.IDT_UniPayIII.emv_removeAllCRL | ( | ) |
Remove All Certificate Revocation List Entries
Removes all CRLEntry entries
RETURN_CODE IDTechSDK.IDT_UniPayIII.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
AID | Name of ApplicationID Must be between 5 and 16 bytes |
RETURN_CODE IDTechSDK.IDT_UniPayIII.emv_removeCAPK | ( | byte[] | capk | ) |
Remove Certificate Authority Public Key
Removes the CAPK for EMV Kernel as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
RETURN_CODE IDTechSDK.IDT_UniPayIII.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_UniPayIII.emv_retrieveAIDList | ( | ref byte | response[][] | ) |
Retrieve AID list
Returns all the AID names installed on the terminal for EMV Kernel.
response | array of AID name byte arrays |
RETURN_CODE IDTechSDK.IDT_UniPayIII.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.
AID | Name of ApplicationID. Must be between 5 and 16 bytes |
tlv | The TLV elements of the requested AID |
RETURN_CODE IDTechSDK.IDT_UniPayIII.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.
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_UniPayIII.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.
keys | [key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index |
RETURN_CODE IDTechSDK.IDT_UniPayIII.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_UniPayIII.emv_retrieveTerminalData | ( | ref byte[] | tlv | ) |
Retrieve Terminal Data
Retrieves the Terminal Data for EMV Kernel.
tlv | Response returned as a TLV |
RETURN_CODE IDTechSDK.IDT_UniPayIII.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_UniPayIII.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
name | Application name, 10-32 ASCII hex characters representing 5-16 bytes Example "a0000000031010" |
tlv | Application data in TLV format |
RETURN_CODE IDTechSDK.IDT_UniPayIII.emv_setCAPK | ( | byte[] | key | ) |
Set Certificate Authority Public Key
Sets the CAPK for EMV Kernel as specified by the CAKey structure
key | CAKey format: [5 bytes RID][1 byte Index][1 byte Hash Algorithm][1 byte Encryption Algorithm][20 bytes HashValue][4 bytes Public Key Exponent][2 bytes Modulus Length][Variable bytes Modulus] Where:
|
RETURN_CODE IDTechSDK.IDT_UniPayIII.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_UniPayIII.emv_setTerminalData | ( | byte[] | tlv | ) |
Set Terminal Data
Sets the Terminal Data for EMV Kernel
tlv | TerminalData configuration data |
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_UniPayIII.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_UniPayIII.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_UniPayIII.icc_powerOffICC | ( | ) |
Power Off ICC
Powers down the ICC
If Success, empty If Failure, ASCII encoded data of error string
RETURN_CODE IDTechSDK.IDT_UniPayIII.icc_powerOnICC | ( | ref byte[] | ATR | ) |
Power On ICC
Power up the currently selected microprocessor card in the ICC reader
|
static |
Load DLL's
Instructs SDK to load device DLLs. Should be executed on SDK initialization.
RETURN_CODE IDTechSDK.IDT_UniPayIII.msr_cancelMSRSwipe | ( | ) |
Disable MSR Swipe Cancels MSR swipe request.
RETURN_CODE IDTechSDK.IDT_UniPayIII.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_UniPayIII class.