![]() |
IDTech Android SDK Guide
1.00.057
API reference for Kiosk III
|
Public Member Functions | |
IDT_KioskIII (OnReceiverListener callback, Context context) | |
boolean | device_setDeviceType (ReaderInfo.DEVICE_TYPE deviceType) |
IDT_KioskIII (OnReceiverListener callback, Context context, boolean isSRED) | |
boolean | device_setDeviceType (ReaderInfo.DEVICE_TYPE deviceType, boolean isSRED) |
void | setIDT_Device (FirmwareUpdateTool fwTool) |
boolean | device_isSRED () |
DEVICE_TYPE | device_getDeviceType () |
void | registerListen () |
void | unregisterListen () |
void | release () |
String | config_getSDKVersion () |
String | config_getXMLVersionInfo () |
String | phone_getInfoManufacture () |
String | phone_getInfoModel () |
void | log_setVerboseLoggingEnable (boolean enable) |
void | log_setSaveLogEnable (boolean enable) |
int | log_deleteLogs () |
void | config_setXMLFileNameWithPath (String path) |
boolean | config_loadingConfigurationXMLFile (boolean updateAutomatically) |
boolean | device_connectWithProfile (StructConfigParameters profile) |
boolean | device_isConnected () |
int | device_startRKI () |
int | device_setMerchantRecord (int index, boolean enabled, String merchantID, String merchantURL) |
int | device_getMerchantRecord (int index, ResDataStruct respData) |
int | device_getFirmwareVersion (StringBuilder version) |
int | device_pingDevice () |
int | device_setBurstMode (byte mode) |
int | device_setPollMode (byte mode) |
int | device_controlUserInterface (byte[] values) |
int | device_getTransactionResults (IDTMSRData cardData) |
int | config_getSerialNumber (StringBuilder serialNumber) |
String | device_getResponseCodeString (int errorCode) |
int | device_sendDataCommand (String cmd, boolean calcLRC, String data, ResDataStruct respData) |
int | device_sendDataCommand (String cmd, boolean calcLRC, String data, ResDataStruct respData, int timeout) |
int | device_updateFirmware (String[] commands) |
int | device_reviewAllSetting (ResDataStruct respData) |
int | icc_passthroughOnICC () |
int | icc_passthroughOffICC () |
int | ctls_retrieveApplicationData (String aid, ResDataStruct respData) |
int | ctls_removeApplicationData (String aid, ResDataStruct respData) |
int | ctls_setApplicationData (byte[] TLV, ResDataStruct respData) |
int | ctls_setConfigurationGroup (byte[] TLV, ResDataStruct respData) |
int | ctls_retrieveTerminalData (ResDataStruct respData) |
int | ctls_setTerminalData (byte[] TLV, ResDataStruct respData) |
int | ctls_retrieveAidList (ResDataStruct respData) |
int | ctls_retrieveCAPK (byte[] data, ResDataStruct respData) |
int | ctls_removeCAPK (byte[] capk, ResDataStruct respData) |
int | ctls_setCAPK (byte[] key, ResDataStruct respData) |
int | ctls_retrieveCAPKList (ResDataStruct respData) |
int | ctls_removeAllApplicationData () |
int | ctls_removeAllCAPK () |
int | ctls_startTransaction (double amount, double amtOther, int type, final int timeout, byte[] tags) |
int | ctls_cancelTransaction () |
Static Public Member Functions | |
static IDT_Device | getIDT_Device () |
com.idtechproducts.device.IDT_KioskIII.IDT_KioskIII | ( | OnReceiverListener | callback, |
Context | context | ||
) |
It is the constructor of the main class IDT_KioskIII. When it is called, the SDK will create the Instance for IDT_KioskIII device. The interface OnReceiverListner needs to be implemented in the application.
callback | OnReceiverListener callback |
context | Application context |
com.idtechproducts.device.IDT_KioskIII.IDT_KioskIII | ( | OnReceiverListener | callback, |
Context | context, | ||
boolean | isSRED | ||
) |
It is the constructor of the main class IDT_KioskIII. When it is called, the SDK will create the Instance for IDT_Augusta device. The interface OnReceiverListner needs to be implemented in the application.
callback | OnReceiverListener callback |
context | Application context |
isSRED | True if SRED device |
String com.idtechproducts.device.IDT_KioskIII.config_getSDKVersion | ( | ) |
READER CONFIG API LIST Get the version of SDK.
sdkVersion | for version string. |
int com.idtechproducts.device.IDT_KioskIII.config_getSerialNumber | ( | StringBuilder | serialNumber | ) |
Get the serial number of device.
serialNumber | returns Serial Number string. |
String com.idtechproducts.device.IDT_KioskIII.config_getXMLVersionInfo | ( | ) |
Get XML configuration version.
boolean com.idtechproducts.device.IDT_KioskIII.config_loadingConfigurationXMLFile | ( | boolean | updateAutomatically | ) |
Load XML Configuration File.
xmlFilename,XML | Configuration File Name. |
void com.idtechproducts.device.IDT_KioskIII.config_setXMLFileNameWithPath | ( | String | path | ) |
set XML Configuration File Name with the full path.
xmlFilename,XML | Configuration File Name. |
int com.idtechproducts.device.IDT_KioskIII.ctls_cancelTransaction | ( | ) |
Cancel CTLS (or MSR) Transaction
Cancels the currently executing CTLS transaction (or MSR swipe request).
int com.idtechproducts.device.IDT_KioskIII.ctls_removeAllApplicationData | ( | ) |
Remove all Application Data
Removes all the Application Data
int com.idtechproducts.device.IDT_KioskIII.ctls_removeAllCAPK | ( | ) |
Remove All Certificate Authority Public Key
Removes all CAPK
int com.idtechproducts.device.IDT_KioskIII.ctls_removeApplicationData | ( | String | aid, |
ResDataStruct | respData | ||
) |
Remove Application Data
Removes the Application Data as specified by the AID name passed as a parameter
aid | Aid file to remove. |
respData | Status Code in ResDataStruct.statusCode. If no application data exists, status code will be 0x60. Format error status code 0x05 |
int com.idtechproducts.device.IDT_KioskIII.ctls_removeCAPK | ( | byte[] | capk, |
ResDataStruct | respData | ||
) |
Remove Certificate Authority Public Key
Removes the CAPK as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
respData | Status Code in ResDataStruct.statusCode. |
int com.idtechproducts.device.IDT_KioskIII.ctls_retrieveAidList | ( | ResDataStruct | respData | ) |
Retrieve Aid List
Returns all the AID names installed on the terminal.
respData | Array of AID string names passed back in ResDataStruct.stringArray. Status Code in ResDataStruct.statusCode. If no AIDs exists, status code will be 0x60 |
int com.idtechproducts.device.IDT_KioskIII.ctls_retrieveApplicationData | ( | String | aid, |
ResDataStruct | respData | ||
) |
Allow fallback for EMV transactions. Default is TRUE
allow | TRUE = allow fallback, FALSE = don't allow fallback Retrieve Application Data |
Retrieves the TLV values of a provide AID.
aid | Aid file to retrieve. |
respData | Returns TLV in ResDataStruct.resData. Status Code in ResDataStruct.statusCode. If no application data exists, status code will be 0x60 |
int com.idtechproducts.device.IDT_KioskIII.ctls_retrieveCAPK | ( | byte[] | data, |
ResDataStruct | respData | ||
) |
Retrieve Certificate Authority Public Key
Retrieves the CAPK as specified by the RID/Index passed as a parameter.
capk | 6 bytes CAPK = 5 bytes RID + 1 byte Index |
key | Response returned in ResDataStruct.resData: [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:
|
int com.idtechproducts.device.IDT_KioskIII.ctls_retrieveCAPKList | ( | ResDataStruct | respData | ) |
Retrieve the Certificate Authority Public Key list
Returns all the CAPK RID and Index installed on the terminal.
respData | ResDataStruct.resData = [key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index |
int com.idtechproducts.device.IDT_KioskIII.ctls_retrieveTerminalData | ( | ResDataStruct | respData | ) |
Retrieve Terminal Data
Retrieves the TLV values of a the terminal.
respData | Returns TLV in ResDataStruct.resData. Status Code in ResDataStruct.statusCode. If no terminal data exists, status code will be 0x60 |
int com.idtechproducts.device.IDT_KioskIII.ctls_setApplicationData | ( | byte[] | TLV, |
ResDataStruct | respData | ||
) |
Set Application Data by AID
Sets the Application Data for CTLS as specified by the TLV data
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"
int com.idtechproducts.device.IDT_KioskIII.ctls_setCAPK | ( | byte[] | key, |
ResDataStruct | respData | ||
) |
Set Certificate Authority Public Key
Sets the CAPK as specified by the CAKey structure
key | CAKey format: [5 bytes RID][1 byte Index][1 byte Hash Algorithm][1 byte Encryption Algorithm][20 bytes HashValue][4 bytes Public Key Exponent][2 bytes Modulus Length][Variable bytes Modulus] Where:
|
respData | Status Code in ResDataStruct.statusCode. |
int com.idtechproducts.device.IDT_KioskIII.ctls_setConfigurationGroup | ( | byte[] | TLV, |
ResDataStruct | respData | ||
) |
Set Configuration Data for AID Group
Sets the Configuration Data for CTLS as specified by the TLV data
tlv | Configuration data in TLV format The first tag of the TLV data must be the group number (FFE4). A second tag must exisdt |
int com.idtechproducts.device.IDT_KioskIII.ctls_setTerminalData | ( | byte[] | TLV, |
ResDataStruct | respData | ||
) |
Set Terminal Data
Sets the Terminal Data as specified by the TerminalData structure passed as a parameter
TLV | TerminalData configuration file. |
respData | Status Code in ResDataStruct.statusCode. If Flash error, status code will be 0x62. Format error status code 0x05 |
int com.idtechproducts.device.IDT_KioskIII.ctls_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | type, | ||
final int | timeout, | ||
byte[] | tags | ||
) |
Start CTLS (or MSR) Transaction Request
Authorizes the CTLS (or MSR) 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) |
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. 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 |
boolean com.idtechproducts.device.IDT_KioskIII.device_connectWithProfile | ( | StructConfigParameters | profile | ) |
connect the device with Profile.
profile,the | profile is the one which is the result from Auto config. |
int com.idtechproducts.device.IDT_KioskIII.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.
|
DEVICE_TYPE com.idtechproducts.device.IDT_KioskIII.device_getDeviceType | ( | ) |
Gets type of device
int com.idtechproducts.device.IDT_KioskIII.device_getFirmwareVersion | ( | StringBuilder | version | ) |
DEVICE INFO API Get the firmware version of device.
version | for version string. |
int com.idtechproducts.device.IDT_KioskIII.device_getMerchantRecord | ( | int | index, |
ResDataStruct | respData | ||
) |
Get Merchant Record
Gets the merchant record for the device.
respData | response data from reader. Merchant Record Index: 1 byte enabled: 1 byte Merchant ID: 32 bytes Length of Merchant URL: 1 byte Merchant URL: 64 bytes |
String com.idtechproducts.device.IDT_KioskIII.device_getResponseCodeString | ( | int | errorCode | ) |
Get Response Code String
Interpret a response code and return string description.
errorCode | Error code, range 0x0000 - 0xFFFF, example 0x0300 |
int com.idtechproducts.device.IDT_KioskIII.device_getTransactionResults | ( | IDTMSRData | cardData | ) |
Get Transaction Results Gets the transaction results when the reader is functioning in "Auto Poll" mode
cardData | The transaction results |
boolean com.idtechproducts.device.IDT_KioskIII.device_isConnected | ( | ) |
get the status if the device connected.
boolean com.idtechproducts.device.IDT_KioskIII.device_isSRED | ( | ) |
Check if the device is SRED
int com.idtechproducts.device.IDT_KioskIII.device_pingDevice | ( | ) |
Ping Device
Pings the reader. If connected, returns success. Otherwise, returns timeout.
int com.idtechproducts.device.IDT_KioskIII.device_reviewAllSetting | ( | ResDataStruct | respData | ) |
Review All Configuration Settings
it returns the current values for all the parameters that can be set using the Set Configuration command. Each parameter is returned as a TLV data object. Floor Limits for different AIDs are preceded by the TLV of the specific AID associated with that object.
aid | Aid file to retrieve. |
respData | Returns TLV in ResDataStruct.resData. Status Code in ResDataStruct.statusCode. If no application data exists, status code will be 0x60 |
int com.idtechproducts.device.IDT_KioskIII.device_sendDataCommand | ( | String | cmd, |
boolean | calcLRC, | ||
String | data, | ||
ResDataStruct | respData | ||
) |
Sends a Direct Command Sends a NEO IDG ViVOtech 2.0 command
command | Two bytes command (including subCommand) as per NEO IDG Reference Guide (UniPayIII) |
calcLRC | Not used for IDG devices |
data | Command data (if applicable) for IDG devices |
response | Returns response ResDataStruct.resData. Status Code in ResDataStruct.statusCode |
int com.idtechproducts.device.IDT_KioskIII.device_sendDataCommand | ( | String | cmd, |
boolean | calcLRC, | ||
String | data, | ||
ResDataStruct | respData, | ||
int | timeout | ||
) |
Sends a Direct Command Sends a NEO IDG ViVOtech 2.0 command
command | Two bytes command (including subCommand) as per NEO IDG Reference Guide (UniPayIII) |
calcLRC | Not used for IDG devices |
data | Command data (if applicable) for IDG devices |
response | Returns response ResDataStruct.resData. Status Code in ResDataStruct.statusCode |
timeout | Command timeout |
int com.idtechproducts.device.IDT_KioskIII.device_setBurstMode | ( | byte | mode | ) |
Set Burst Mode
Sets the burst mode for the device.
mode | 0 = OFF, 1 = Always On, 2 = Auto Exit |
boolean com.idtechproducts.device.IDT_KioskIII.device_setDeviceType | ( | ReaderInfo.DEVICE_TYPE | deviceType | ) |
Defines connection USB or Audio Jack
deviceType | DEVICE_TYPE.IDT_KioskIII |
boolean com.idtechproducts.device.IDT_KioskIII.device_setDeviceType | ( | ReaderInfo.DEVICE_TYPE | deviceType, |
boolean | isSRED | ||
) |
Defines connection USB
deviceType | DEVICE_TYPE.DEVICE_KIOSK_III |
isSRED | True if SRED device |
int com.idtechproducts.device.IDT_KioskIII.device_setMerchantRecord | ( | int | index, |
boolean | enabled, | ||
String | merchantID, | ||
String | merchantURL | ||
) |
Set Merchant Record
Sets the merchant record for the device.
index | Merchant Record Index. The valid value is 1–6. |
enabled | 1: The Merchant ID is valid, 0: The Merchant ID is not valid. |
merchantID | The tag is 9F25. |
merchantURL | The tag is 9F29. |
int com.idtechproducts.device.IDT_KioskIII.device_setPollMode | ( | byte | mode | ) |
Set Poll Mode
Sets the poll mode for the device. Auto Poll keeps reader active, Poll On Demand only polls when requested by terminal
mode | 0 = Auto Poll, 1 = Poll On Demand |
int com.idtechproducts.device.IDT_KioskIII.device_startRKI | ( | ) |
Start remote key injection.
int com.idtechproducts.device.IDT_KioskIII.device_updateFirmware | ( | String[] | commands | ) |
DEVICE INFO API Update the firmware of device.
commands | for all the lines/commands of the firmware text file. |
int com.idtechproducts.device.IDT_KioskIII.icc_passthroughOffICC | ( | ) |
Disables pass through mode for ICC. Required when executing transactions (start EMV, start MSR, authenticate transaction)
int com.idtechproducts.device.IDT_KioskIII.icc_passthroughOnICC | ( | ) |
DEVICE INFO API Update the firmware of device.
commands | for all the lines/commands of the firmware text file. |
int com.idtechproducts.device.IDT_KioskIII.log_deleteLogs | ( | ) |
void com.idtechproducts.device.IDT_KioskIII.log_setSaveLogEnable | ( | boolean | enable | ) |
Enable/Disable save the log into the root path of SD card.
enableShowLog,true | enable save the log, the log includes the .txt text log and .wav signals file. false: disable save the log. |
void com.idtechproducts.device.IDT_KioskIII.log_setVerboseLoggingEnable | ( | boolean | enable | ) |
Enable/Disable Verbose Logging show in the logcat view window.
enableShowLog,true | enable to show the log in the logcat view window. false: disable to show the log in the logcat view window. |
String com.idtechproducts.device.IDT_KioskIII.phone_getInfoManufacture | ( | ) |
Get manufacture version.
String com.idtechproducts.device.IDT_KioskIII.phone_getInfoModel | ( | ) |
Get phones's model number information.
void com.idtechproducts.device.IDT_KioskIII.registerListen | ( | ) |
General API:registerListen.
registerListen to enable SDK detect the phone jack plug in/off notification
void com.idtechproducts.device.IDT_KioskIII.release | ( | ) |
release, make the SDK in the idle status.
void com.idtechproducts.device.IDT_KioskIII.setIDT_Device | ( | FirmwareUpdateTool | fwTool | ) |
For System Use Only
fwTool | Parameter for firmware update |
void com.idtechproducts.device.IDT_KioskIII.unregisterListen | ( | ) |
unregisterListen to disable the detect