UniPay SDK Guide for Android  0.02.011
API reference
 All Data Structures Functions Variables Pages
com.idtechproducts.emv.UniPayEMV Class Reference
Inheritance diagram for com.idtechproducts.emv.UniPayEMV:
com.idtechproducts.device.OnReceiverListener

Data Structures

enum  CAPTURE_ENCODE_TYPE
 
enum  CAPTURE_ENCRYPT_TYPE
 
enum  CAPTURE_TYPE
 
enum  EMV_COMPLETION_RESULT
 
enum  EMV_RESULT_CODE_Types
 
enum  EVENT_MSR_Types
 
class  IDTEMVData
 
enum  MESSAGE_Types
 
interface  UniPayEMVDelegate
 

Public Member Functions

void accelerateRead (boolean enabled)
 
 UniPayEMV (Context context, IDT_Device reader, UniPayEMVDelegate del)
 
void setTerminalData (UniPayTerminalDataStruct data)
 
void confirmApplicationCancel ()
 
void confirmApplication (int index)
 
void cancelTransaction ()
 
void startEMVTransaction (double amount, int timeout, int type, Map< String, byte[]> tags)
 
String getEMVKernelVersion ()
 
boolean completeOnlineEMVTransaction (EMV_COMPLETION_RESULT result, String resultCode, String iad, String scripts)
 
UniPayTerminalDataStruct retrieveTerminalData ()
 
void setApplicationData (UniPay_ApplicationID data)
 
UniPay_ApplicationID retrieveApplicationData (String data)
 
void removeApplicationData (String data)
 
Vector< String > retrieveAIDList ()
 
- Public Member Functions inherited from com.idtechproducts.device.OnReceiverListener
void swipeMSRData (IDTMSRData card)
 
void deviceConnected ()
 
void deviceDisconnected ()
 
void plugStatusChange (DEVICE_INTERFACE_Types deviceInterface, boolean deviceInserted)
 
void timeout (String msgInfo)
 
void AutoConfigCompleted (StructConfigParameters profile)
 
void AutoConfigProgress (int progressValue)
 
void ICCNotifyInfo (byte[] dataNotify, String strMessage)
 
boolean getUserGrant (USER_GRANT_TYPE nType, String strMessage)
 
void LoadXMLConfigFileInfo (int index, String strMessage)
 
void msgToConnectDevice ()
 
void msgAudioVolumeAjustFailed (String strMessage)
 

Constructor & Destructor Documentation

com.idtechproducts.emv.UniPayEMV.UniPayEMV ( Context  context,
IDT_Device  reader,
UniPayEMVDelegate  del 
)
inline

UniPay EMV

Initiates a UniPay EMV instance.

Parameters
contextContext of application calling method
readerInstance of IDT_Device SDK
delPass instance of delegate that will receive UniPayEMV messages

Member Function Documentation

void com.idtechproducts.emv.UniPayEMV.accelerateRead ( boolean  enabled)
inline

Accelerate Read Data

Enables multi-record reading from ICC to accelerate EMV transaction time. Enabled by default.

Parameters
enabledTRUE = use accelerated reading, FALSE = use standard reading
void com.idtechproducts.emv.UniPayEMV.cancelTransaction ( )
inline

Cancel Transaction

Cancels the current transaction

boolean com.idtechproducts.emv.UniPayEMV.completeOnlineEMVTransaction ( EMV_COMPLETION_RESULT  result,
String  resultCode,
String  iad,
String  scripts 
)
inline

Complete EMV Transaction Online Request

Completes an online EMV transaction request by the card

The tags will be returned in the emvTransactionData delegate protocol.

Parameters
resultEMV_COMPLETION_RESULT: Used to specify if contacting online host was successful or other problem occurred
resultCodeResult Code from host. Manditory. 2 characters ASCII value. Example "00"
iadIssuer Authentication Data. Optional. 10 bytes, 20 Hex Characters representing data. Example "11223344556677883030"
scriptsIssuer Scripts. Optional. Data represented by Hex Characters. TLV Format. Must start with 71 or 72, followed by length, followed by data. Example "711000112233445566778899AABBCCDDEEFF". Can string multiple scripts, both 71 and 72.

Results are returned on delegate protocol emvTransactionData.

void com.idtechproducts.emv.UniPayEMV.confirmApplication ( int  index)
inline

Set Application

During and EMV transaction flow, if there are multiple applications to chose from, or the terminal settings indicate cardholder confirmation for applicaiton selection, the delegate IDTechEMV_Delegate::confirmApplicationSelection:() will receive an array with all the available applications to choose from. The selected index of the application must be passed back to this method to continue the EMV transaction flow

Parameters
indexThe index of the selected app from the application array passed back from confirmApplicationSelection:()
void com.idtechproducts.emv.UniPayEMV.confirmApplicationCancel ( )
inline

Cancel Set Application

During and EMV transaction flow, if there are multiple applications to chose from, or the terminal settings indicate cardholder confirmation for application selection, the delegate IDTechEMV_Delegate::confirmApplicationSelection:() will receive an array with all the available applications to choose from. If no application selection is performed, this routine must be called to cancel the transaction

String com.idtechproducts.emv.UniPayEMV.getEMVKernelVersion ( )
inline

Returns SDK EMV Kernel Version

Returns
response Kernel Version
void com.idtechproducts.emv.UniPayEMV.removeApplicationData ( String  data)
inline

Remove Application Data by AID

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

Parameters
AIDName of ApplicationID in ASCII, example "A0000000031020". Must be between 5 and 16 characters
Vector<String> com.idtechproducts.emv.UniPayEMV.retrieveAIDList ( )
inline

Retrieve AID list

Returns all the AID names on the terminal.

Return values
responseReturns a Vector<String> of AID Names
UniPay_ApplicationID com.idtechproducts.emv.UniPayEMV.retrieveApplicationData ( String  data)
inline

Retrieve Application Data by AID

Retrieves the Application Data as specified by the AID name passed as a parameter. If aidLen = 0, then requested AID was not found.

Parameters
dataName of ApplicationID in ASCII, example "A0000000031020". Must be between 5 and 16 characters
Returns
responseAID The AID returned as UniPay_ApplicationID
UniPayTerminalDataStruct com.idtechproducts.emv.UniPayEMV.retrieveTerminalData ( )
inline

Retrieve Terminal Data

Retrieves the Terminal Data. The data will be UniPayTerminalDataStruct

Returns
response Response returned as a TerminalData
void com.idtechproducts.emv.UniPayEMV.setApplicationData ( UniPay_ApplicationID  data)
inline

Set Application Data by AID

Sets the Application Data as specified by the UniPay_ApplicationID structure passed as a class

Parameters
dataUniPay_ApplicationID configuration file
void com.idtechproducts.emv.UniPayEMV.setTerminalData ( UniPayTerminalDataStruct  data)
inline

Set Terminal Data

Sets the Terminal Data as specified by the UniPayTerminalDataStruct class passed as a parameter

Parameters
dataTerminalData configuration file
void com.idtechproducts.emv.UniPayEMV.startEMVTransaction ( double  amount,
int  timeout,
int  type,
Map< String, byte[]>  tags 
)
inline

Start EMV Transaction Request

Authorizes the EMV transaction amounts for an ICC card

The tags will be returned in the emvTransactionData delegate protocol.

Parameters
amountTransaction amount value (tag value 9F02)
timeoutTimeout value in seconds.
typeTransaction Type.
tagsAny other optional tags to be included in the request. Passed as a Map<String,byte[]>.

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