|
RETURN_CODE | config_getSerialNumber (ref string response) |
|
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response) |
|
RETURN_CODE | device_getFirmwareVersion (ref string response) |
|
RETURN_CODE | device_getMerchantRecord (int index, ref byte[] record) |
|
RETURN_CODE | device_getTransactionResults (ref IDTTransactionData results) |
|
RETURN_CODE | device_pingDevice () |
|
RETURN_CODE | device_controlUserInterface (byte[] values) |
|
RETURN_CODE | device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response) |
|
RETURN_CODE | ctls_retrieveAIDList (ref byte[][] response) |
|
RETURN_CODE | ctls_getAllConfigurationGroups () |
|
RETURN_CODE | ctls_retrieveApplicationData (byte[] AID, ref byte[] tlv) |
|
RETURN_CODE | ctls_removeApplicationData (byte[] AID) |
|
RETURN_CODE | ctls_setApplicationData (byte[] tlv) |
|
RETURN_CODE | ctls_setConfigurationGroup (byte[] tlv) |
|
RETURN_CODE | ctls_retrieveTerminalData (ref byte[] tlv) |
|
RETURN_CODE | ctls_setTerminalData (byte[] tlv) |
|
RETURN_CODE | ctls_getConfigurationGroup (int group, ref byte[] tlv) |
|
RETURN_CODE | ctls_removeConfigurationGroup (int group) |
|
RETURN_CODE | ctls_setCAPK (byte[] key) |
|
RETURN_CODE | ctls_retrieveCAPK (byte[] capk, ref byte[] key) |
|
RETURN_CODE | ctls_removeCAPK (byte[] capk) |
|
RETURN_CODE | ctls_removeAllCAPK () |
|
RETURN_CODE | ctls_retrieveCAPKList (ref byte[] keys) |
|
RETURN_CODE | ctls_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags) |
|
RETURN_CODE | ctls_cancelTransaction () |
|
RETURN_CODE | device_setBurstMode (byte mode) |
|
RETURN_CODE | device_setMerchantRecord (int index, bool enabled, string merchantID, string merchantURL) |
|
RETURN_CODE | device_setPollMode (byte mode) |
|
RETURN_CODE | device_startRKI () |
|
RETURN_CODE | device_enablePassThrough (bool enablePassThrough) |
|
Class for KioskIII ICC reader
RETURN_CODE IDTechSDK.IDT_KioskIII.config_getSerialNumber |
( |
ref string |
response | ) |
|
Polls device for Serial Number
- Parameters
-
response | Returns Serial Number |
- Returns
- RETURN_CODE: Values can be parsed with device_getResponseCodeString
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_cancelTransaction |
( |
| ) |
|
Cancel EMV Transaction
Cancels the currently executing EMV transaction.
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_getAllConfigurationGroups |
( |
| ) |
|
Retrieve All Configuration Groups
Returns all the Configuration Groups installed on the terminal for CTLS as a callback with DeviceState.ConfigurationGroup
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_getConfigurationGroup |
( |
int |
group, |
|
|
ref byte[] |
tlv |
|
) |
| |
Get Configuration Group
Retrieves the Configuration for the specified Group.
- Parameters
-
group | Configuration Group |
tlv | return data |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_removeAllCAPK |
( |
| ) |
|
Remove All Certificate Authority Public Key
Removes all the CAPK for CTLS
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.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
- Parameters
-
AID | Name of ApplicationID Must be between 5 and 16 bytes |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_removeCAPK |
( |
byte[] |
capk | ) |
|
Remove Certificate Authority Public Key
Removes the CAPK as specified by the RID/Index
- Parameters
-
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_removeConfigurationGroup |
( |
int |
group | ) |
|
Remove Configuration Group
Removes the Configuration as specified by the Group. Must not by group 0
- Parameters
-
- Return values
-
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_KioskIII.ctls_retrieveAIDList |
( |
ref byte |
response[][] | ) |
|
Retrieve AID list
Returns all the AID names installed on the terminal for CTLS.
- Parameters
-
response | array of AID name byte arrays |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.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.
- Parameters
-
AID | Name of ApplicationID. Must be between 5 and 16 bytes |
tlv | The TLV elements of the requested AID |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_retrieveCAPK |
( |
byte[] |
capk, |
|
|
ref byte[] |
key |
|
) |
| |
Retrieve Certificate Authority Public Key
Retrieves the CAPK for CTLS as specified by the RID/Index passed as a parameter.
- Parameters
-
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:
- 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_KioskIII.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.
- 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_KioskIII.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_getConfigurationGroup(0).
- Parameters
-
tlv | Response returned as a TLV |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_setApplicationData |
( |
byte[] |
tlv | ) |
|
Set Application Data by AID
Sets the Application Data for CTLS as specified by TLV data
- Parameters
-
tlv | Application data in TLV format The first tag of the TLV data must be the group number (FFE4). The second tag of the TLV data must be the AID (9F06) |
Example valid TLV, for Group #2, AID a0000000035010: "ffe401029f0607a0000000051010ffe10101ffe50110ffe30114ffe20106"
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_setCAPK |
( |
byte[] |
key | ) |
|
Set Certificate Authority Public Key
Sets the CAPK for CTLS as specified by the CAKey structure
- Parameters
-
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:
- 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_KioskIII.ctls_setConfigurationGroup |
( |
byte[] |
tlv | ) |
|
Set Configuration Group
Sets the Configuration Group for CTLS as specified by the TLV data
- Parameters
-
tlv | Configuration Group Data in TLV format The first tag of the TLV data must be the group number (FFE4). A second tag must exist |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.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.
- Parameters
-
tlv | TerminalData configuration data |
- Return values
-
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_KioskIII.ctls_startTransaction |
( |
double |
amount, |
|
|
double |
amtOther, |
|
|
int |
exponent, |
|
|
int |
type, |
|
|
int |
timeout, |
|
|
byte[] |
tags |
|
) |
| |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
The tags will be returned in the callback routine.
- Parameters
-
amount | Transaction amount value (tag value 9F02) |
amtOther | Other amount value, if any (tag value 9F03) |
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. |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required) 9F26 = four bytes = ApplePay Terminal Capabilities Information (required)
- Byte 1 = RFU
- Byte 2 = Terminal Type
- - Bit 8 = VAS Support (1=on, 0 = off)
- - Bit 7 = Touch ID Required (1=on, 0 = off)
- - Bit 6 = RFU
- - Bit 5 = RFU
- - Bit 1,2,3,4
- - - 0 = Payment Terminal
- - - 1 = Transit Terminal
- - - 2 = Access Terminal
- - - 3 = Wireless Handoff Terminal
- - - 4 = App Handoff Terminal
- - - 15 = Other Terminal
- Byte 3 = RFU
- Byte 4 = Terminal Mode
- - 0 = ApplePay VAS OR ApplePay
- - 1 = ApplePay VAS AND ApplePay
- - 2 = ApplePay VAS ONLY
- - 3 = ApplePay ONLY 9F2B = 5 bytes = ApplePay VAS Filter. Each byte filters for that specific merchant index (optional) DF01 = 1 byte = ApplePay VAS Protocol. (optional)
- - Bit 1 : 1 = URL VAS, 0 = Full VAS
- - Bit 2 : 1 = VAS Beeps, 0 = No VAS Beeps
- - Bit 3 : 1 = Silent Comm Error, 2 = EMEA Comm Error
- - Bit 4-8 : RFU
RETURN_CODE IDTechSDK.IDT_KioskIII.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
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.device_enablePassThrough |
( |
bool |
enablePassThrough | ) |
|
Enable Pass Through
Enables Pass Through Mode for direct communication with L1 interface (power on icc, send apdu, etc).
- Parameters
-
enablePassThrough | true = pass through ON, false = pass through OFF |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.device_getFirmwareVersion |
( |
ref string |
response | ) |
|
Polls device for Firmware Version
- Parameters
-
response | Response returned of Firmware Version |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.device_getMerchantRecord |
( |
int |
index, |
|
|
ref byte[] |
record |
|
) |
| |
Get Merchant Record Gets the merchant record for ApplePay VAS
- Parameters
-
index | Merchant Record index, valid values 1-6 |
record | Data returned containing 99 bytes: Byte 0 = Merchand Index Byte 1 = Merchant Enabled (1 = enabled) Byte 2 - 33 = Merchant Protocol Hash-256 value Byte 34 = Length of Merchant URL Bytes 35 - 99 = URL |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.device_getTransactionResults |
( |
ref IDTTransactionData |
results | ) |
|
Get Transaction Results Gets the transaction results when the reader is functioning in "Auto Poll" mode
- Parameters
-
results | The transaction results |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE
RETURN_CODE IDTechSDK.IDT_KioskIII.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_KioskIII.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.
- Parameters
-
cmd | NSData representation of command to execute |
calcLRC | No applicable for Kiosk III |
response | Response data |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.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
-
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.device_setBurstMode |
( |
byte |
mode | ) |
|
Send Burst Mode
Sets the burst mode forthe device.
- Parameters
-
mode | 0 = OFF, 1 = Always On, 2 = Auto Exit |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.device_setMerchantRecord |
( |
int |
index, |
|
|
bool |
enabled, |
|
|
string |
merchantID, |
|
|
string |
merchantURL |
|
) |
| |
Set Merchant Record Sets the merchant record for ApplePay VAS
- Parameters
-
index | Merchant Record index, valid values 1-6 |
enabled | Merchant Enabled/Valid flag |
merchantID | Merchant unique identifer registered with Apple. Example com.idtechproducts.applePay |
merchantURL | Merchant URL, when applicable |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.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
-
mode | 0 = Auto Poll, 1 = Poll On Demand |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_KioskIII.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
static String IDTechSDK.IDT_KioskIII.SDK_Version |
( |
| ) |
|
|
static |
SDK Version
Returns the current version of SDK
- Returns
- Framework version
static void IDTechSDK.IDT_KioskIII.setCallback |
( |
CallBack |
my_Callback | ) |
|
|
static |
Set Callback
Sets the class callback
static void IDTechSDK.IDT_KioskIII.setCallback |
( |
IntPtr |
my_Callback, |
|
|
SynchronizationContext |
context |
|
) |
| |
|
static |
Set Callback
Sets the class callback
- Parameters
-
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 bool IDTechSDK.IDT_KioskIII.useSerialPort |
( |
int |
port | ) |
|
|
static |
Use Serial Port Interface
Instructs SDK to attempt to use the Serial Port for communication with KioskIII using default baud rate
- Parameters
-
port | Serial Port to use. Example COM1 = 1. |
- Returns
- bool TRUE=successful, FALSE=failure
static bool IDTechSDK.IDT_KioskIII.useSerialPort |
( |
int |
port, |
|
|
int |
baud |
|
) |
| |
|
static |
Use Serial Port Interface with baud rate
Instructs SDK to attempt to use the Serial Port for communication with KioskIII
- Parameters
-
port | Serial Port to use. Example COM1 = 1. |
baud | Baud rate to override default. Example 115200; |
- Returns
- bool TRUE=successful, FALSE=failure
static bool IDTechSDK.IDT_KioskIII.useUSB |
( |
| ) |
|
|
static |
Use USB Interface
Instructs SDK to attempt to use USB for communication with Kiosk III
The documentation for this class was generated from the following file: