MPOS(RCKT) Connection
Method:
- connectMPOSBluetooth(macAddress: String?,giftCardType: Int = 0,context: Context,iBTCRResult : IBTCRServiceResult)
This method is used for connecting MPOS Device.Parameters
Parameters:
- String | [IN] macAddress | MPos device mac address
- Int | [IN] giftCardType | Which Type of gift card type to be accepted
0 – Not Selected, 1 - Valutech, 2 – Factor4
- context | [IN]context | context
- callback | [IN]iBTCRResult | interface IBTCRServiceResult that implements mandatory callback events (Callback function).
Interface: IBTCRServiceResult
- onSuccess() – This event will be triggered when device is successfully connected
- onDisconnect()- This event will be triggered when device is disconnect
- onFailure(errorMessage: String?) - This event will be triggered when device is some connection problem
Parameters
- errorMessage
Returns
- “Bluetooth is disabled” – Bluetooth disable in the device
- “Require Permission for Bluetooth connect” – Need Bluetooth permission
- “Require Nearby devices permission” – Require Nearby device permission
MPOS Disconnection
Method:
- disconnectBluetooth(context: Context, iBTCRServiceResult: IBTCRServiceResult?)
This method is used for disconnect connecting MPOS Device.
Parameters:
- Context | [IN] context | context
- callback | [IN] iBTCRServiceResult | interface IBTCRServiceResult that implements
- mandatory callback events(Callback function).
Interface: IBTCRServiceResult
- onSuccess() – not used
- onDisconnect()- This event will be triggered when device is disconnect
- onFailure(errorMessage: String?) - This event will be triggered when device is some connection problem
Parameters
- errorMessage
Connection status Check
Method:
- isRCKTDeviceConnected(): Boolean
To Check status of RCKT device is connected or not
- true – Device is connected
- false – Device is not connected
Read Card Info
Method:
- presentCard( context: Context, transactionInfo: TransactionInfo,resourceId: Int? = null, iPresentCardResult: IPresentCardResult)
This method is used for card related functionalities(Pin bypass, fallback) and getting card information.
Parameters:
- context | [IN] context | context
- TransactInfo | [IN] transactionInfo | Input transaction related data
- Int | [IN] resourceId | For this card fragment screen, a new XML layout
- Callback | [IN] iPresentCardResult | interface IPresentCardResult that implements
- mandatory callback events(Callback function).
Interface: IPresentCardResult
onSuccess(cardInfo: CardInfo, status: Int) – This event will be triggered when succeed state
Parameters
- cardInfo – Output response of card information
- status – get reversal transactions available status
1 – Reversal transaction is available
0 – Reversal transaction not available
- onConfirmation (status: String?): Boolean- This event will be triggered when shows dialog with Yes an No button’s
- onFailure(errorMessage: String?) - This event will be triggered when failure state
- onNotification (Message: String?) - This event will be triggered when shows empty dialog
- onWarning(Message: String?) - This event will be triggered when shows dialog with ok button
Perform Transaction
Method:
- performTxn(context: Context, inputVo: InputVo, iPerformTxnResult: IPerformTxnResult?)
This method is used for Perform transaction functionalities.
Parameters:
- [IN]context – context
- [IN]inputVo – Input transaction related data
- [IN]iPerformTxnResult - interface IPerformTxnResult that implements mandatory callback events(Callback function).
Interface: IPerformTxnResult
- onSuccess(outputVo: OutputVo) – This event will be triggered when succeed state
Parameters
- outputVo – Output response of Perform transaction information
- onFailure(errorMessage: String, outputVo: OutputVo?, status: Int) – This event will be triggered when failure state
Parameters:
- errorMessage – error message
- outputVo – Output response of Perform transaction information
- status – get reversal transactions available status
1 – Reversal transaction is available
0 – Reversal transaction not available
onProgress(progressMessage: String?)
For loading purpose to be used
Parameters
- progressMessage – Progress message
Pin Input
Method:
- getPin(context: Context, pinInputVo: PinInputVo, iGetPinResult: IGetPinResult?)
This method is used getting pin from rckt
Parameters:
- [IN]context – context
- [IN]pinInputVo – Input data
- [IN]iGetPinResult - interface IGetPinResult that implements mandatory callback events(Callback function).
Interface: IGetPinResult
onSuccess(pinOutputVo: PinOutputVo)– This event will be triggered when succeed state
Parameters
- pinOutputVo – Output response of get pin information
- onFailure(errorMessage: String) – This event will be triggered when failure state
Parameters
- errorMessage – error message
Get Device Info
Method:
- getDeviceInfo(context: Context,iDeviceInfoServiceResult: IDeviceInfoServiceResult)
This method is used getting device information from rckt
Parameters:
- [IN]context – context
- [IN] iDeviceInfoServiceResult - interface IDeviceInfoServiceResult that implements mandatory callback events(Callback function).
Interface: IDeviceInfoServiceResult
- onSuccess(deviceInfo: DeviceInfo?) – This event will be triggered when succeed state
Parameters
- deviceInfo – Output response of get device information
- onFailure(errorMessage: String) - This event will be triggered when failure state
Parameters
- errorMessage – error message
Load Configuration
Method:
- loadConfig(context: Context,iLoadConfigServiceResult: ILoadConfigServiceResult)
This method is used for load aid,capk
Parameters:
- context | [IN] context | context
- callback | [IN] iLoadConfigServiceResult | interface ILoadConfigServiceResult that implements mandatory callback events (Callback function).
Interface: ILoadConfigServiceResult
- onSuccess() – This event will be triggered when device is successfully loaded
- onProgress(progressMessage: String?) – The progress message has shown
- onUpdate(): Boolean – When aid is already updated its will triggered
- onFailure(errorMessage: String?) - This event will be triggered when device is some connection problem.
Download Demo RKI
Method:
- downloadDemoRKI(context: Context, iRKIKeyDownloadResult: IRKIKeyDownloadResult?)
This method is used for download demo rki
Parameters:
- context | [IN] context | context
- callback | [IN] iRKIKeyDownloadResult | interface IRKIKeyDownloadResult that implements mandatory callback events (Callback function).
Interface: IRKIKeyDownloadResult
- onSuccess() – This event will be triggered when device is successfully download.
- onFailure(errorMessage: String?) - This event will be triggered when device is some connection problem.
Fetch Transaction
Method:
- fetchTxn(context: Context, inputVo: InputVo, iPerformTxnResult: IPerformTxnResult?)
This method is used for Perform transaction functionalities.
Parameters:
- [IN]context – context
- [IN]inputVo – Input transaction related data
- [IN]iPerformTxnResult - interface IPerformTxnResult that implements mandatory callback events(Callback function).
Interface: IPerformTxnResult
- onSuccess(outputVo: OutputVo)– This event will be triggered when succeed state
Parameters
- outputVo – Output response of Perform transaction information
- onFailure(errorMessage: String, outputVo: OutputVo?, status: Int)
This event will be triggered when failure state
Parameters
- errorMessage – error message
- outputVo – Output response of Perform transaction information
- status – get reversal transactions available status
1 – Reversal transaction is available
0 – Reversal transaction not available
onProgress(progressMessage: String?) - For loading purpose to be used
Parameters
- progressMessage – Progress message
Get Stan Number
Method:
- getStanNo(ctx: Context?): String
This method is used for get stan number
Parameters
- [IN]context – context
Reset Stan Number
Method
- resetStanNo (ctx: Context?)
This method is used for reset stan number
Parameters:
- [IN]context – context
Clear Reversal
Method
- clearReversal(context: Context):Boolean
This method is used for clear reversal transaction data
Parameters:
[IN]context – context
Returns:
- true – Successfully cleared
- false - failed
Class: TransactionInfo
Int |[IN] amount | Amount |0-9999999
Int |[IN] processor | Processor Name
Int |[IN] tranMode |Transaction Mode
Int |[IN] tranCode |Transaction Type
Int |[IN] cardReadTimeout | Card Read Timeout in seconds| default value is 30
Int |[IN] pinInputTimeout | Pin Input Timeout in seconds|default value is 30
Int |[IN] pinByPass | State of Pin ByPass enable/disable
0 – Disable 1 – Enable
Int |[IN] fallBackCount | Card Fallback Count default value is 2
Int |[IN] fallBack | State of Card Fallback enable/disable
0 – Disable 1 – Enable
Int |[IN] disablePin | State of pin enable/disable
0 – Disable 1 – Enable
Class: CardInfo
String |[OUT] track2 | Encrypted Track 2 data
String |[OUT] track2Ksn | Get KSN of the Track 2 data
String |[OUT] maskedPan | Get Masked Pan Number
String |[OUT] expiryDate | Expiry date of card
String |[OUT] cardHolderName | Card Holder Name
String |[OUT] DE55Data | TLV data
String |[OUT] pinBlock | Encrypted pin
String |[OUT] pinBlocKsn | Get KSN of the pin
String |[OUT] aid | Get Aid value
String |[OUT] tsi | Terminal Status Information
String |[OUT] tvr | Terminal Verification Results
String |[OUT] cardLabel | Card Label Information
String |[OUT] applicationLabel | Application Label
String |[OUT] appPreferredName | Application Preferred Name
Int |[OUT] fallback | Get Fallback count
Boolean |[OUT] isSignMandatory | Need Signature is Mandatory
true – Signature Mandatory false- Signature Not Mandatory
Int |[OUT] paymentMethod | Get Payment Type
Int |[OUT] pinType | Get Pin Type
0 - Default 1 – Online Pin 2 – Offline Pin
Class: InputVo
String |[IN] txnServerIP | Perform transaction Ip(Demo or Production)
Int |[IN] txnServerPort | Perform transaction Port Number(Demo or Production)
Int |[IN] connectionTimeout | Connection Timeout in seconds default value is 30
Int |[IN] sendTimeout | Send Request Timeout in seconds default value is 30
Int |[IN] receiveTimeout | Receive Response Timeout in seconds default value is 30
Int |[IN] tranMode |Transaction Mode
Int |[IN] tranCode |Transaction Type
Int |[IN] parentTranCode| Parent Transaction Type
2 – VOID 20 - TIP ADJUSTMENT 21 - TICKET_ACTIVATION
Int |[IN] amount | Amount |0-9999999
Int |[IN] feeAmount | Custom Fee Amount | 0-9999999
Int |[IN] stateTaxAmount | State Tax Amount | 0-9999999
Int |[IN] cityTaxAmount | City Tax Amount | 0-9999999
Int |[IN] tip Amount | Tip Amount | 0-9999999
Int |[IN] cashbackAmount | Debit Cashback Amount | 0-9999999
String |[IN] track2 | Encrypted Track 2 data
String |[IN] track2Ksn | KSN of the Track 2 data
String |[IN] rrn | Retrieval Reference Number
String |[IN] cardNo | Card Number
String |[IN] expiryDate | Expiry Date
String |[IN] cardHolderName | Card Holder Name
String |[IN] tlv | tlv data
String |[IN] pinBlock | Pin information
String |[IN] ksn | Pin block ksn
String |[IN] stanNo | System Trace Audit Number
String |[IN] paymentMethod | Payment Method
Int |[IN] fallback | Fallback Type
0 – Default
String |[IN] approvalCode | Approval Code for fetch transaction
String |[IN] terminalId | Terminal Id for fetch transaction
String |[IN] epiId | Epi Id
String |[IN] profileId | Profile Id
“0”- Traditional “1” – Surcharge
String |[IN] ebtSerialNo | Serial no for ebt voucher sale
String |[IN] ebtApprovalCode | Approval code for ebt voucher sale
String |[IN] cardHolderAddress | Card Holder Address
String |[IN] cardHolderZip | Card Holder Zip
String |[IN] cvv | cvv no
Int |[IN] tipFeeAmt | Tip Fee Amount
Int |[IN] fetchType| Getting data from Fetch Type
1 - Tran no
2 - Card no
String |[IN] tranNo | Tran Number for getting fetch data
Int |[IN] pinType | Pin Type get it from card information.
String |[IN] clerkId | input clerk id
String |[IN] clerkName | input clerk Name
String |[IN] clerkLabel | input clerk Label
String |[IN] vasLabel1| Additional input vas label 1
String |[IN] vasLabel2| Additional input vas label 2
String |[IN] vasLabel3| Additional input vas label 3
String |[IN] vasData1| Additional input vas data 1
String |[IN] vasData2| Additional input vas data 2
String |[IN] vasData3| Additional input vas data 3
Class: OutputVo
Int |[OUT] tranMode |Transaction Mode
Int |[OUT] tranCode |Transaction Type
Int |[OUT] tranAmount | Transaction Amount
Int |[OUT] isPartialApproved | Partial Approved flag
1 – Partial Approved Other - not partial Approved
String |[OUT] rrn | Retrieval Reference Number
String |[OUT] localDate | Transaction date String |[OUT] localTime | Transaction Time
String |[OUT] authId | Gift card type of Transaction Authorization Id
String |[OUT] responseCode | Response code of transaction
"00" - Success "10" – Partial Approved Transaction "VH" - hsm host failed "VT" - hsm invalid data "VI" - hsm invalid format
String |[OUT] terminalId| Response code of terminal Id
String |[OUT] errorCode | This value describes an error code that identifies where the error occurred for which the transaction has been rejected
Int |[OUT] balanceAmount | Balance Amount of Ebt Card and gift card types
Int |[OUT] totalTran | Total transaction count
Int |[OUT] batchNo | Batch Number
String |[OUT] adtlRespData | Additional Approval Code
String |[OUT] hostAuthRespTxt | Host Auth Response Text
String |[OUT] txnId | Host Transaction Id
String |[OUT] respText | Response Message
String |[OUT] tranNo | Tran Number of transaction
List |[OUT] fetchVOList | List of transaction fetch data
Class: PinInputVo
String |[IN] panNumber | Card number
String |[IN] message | To show in rckt device
Int |[IN] pinInputTimeout | Pin input Timeout
Int |[IN] processor | Processor Name
Class: PinOutputVo
String |[OUT] pinBlock | Pin information
String |[OUT] pinBlocKsn | Pin block ksn
Class: FetchVO
Int |[OUT] tranMode |Transaction Mode
Int |[OUT] tranCode |Transaction Type
Int |[OUT] parentTranCode| Parent Transaction Type 2 – VOID 20 - TIP ADJUSTMENT 21 - TICKET_ACTIVATION
Int |[OUT] tranAmount | Transaction Amount
Int |[OUT] isPartialApproved | Partial Approved flag 1 – Partial Approved Other - not partial Approved
String |[OUT] rrn | Retrieval Reference Number
String |[OUT] dateAndMonth | Transaction date and month
String |[OUT] time | Transaction Time String |[OUT] year | Transaction Year
String |[OUT] authId | Gift card type of Transaction Authorization Id
String |[OUT] responseCode| Response code of transaction "00" - Success "10" – Partial Approved Transaction "VH" - hsm host failed "VT" - hsm invalid data "VI" - hsm invalid format
String |[OUT] errorCode | This value describes an error code that identifies where the error occurred for which the transaction has been rejected
Int |[OUT] ebtBalance | Balance Amount of Ebt transaction
Int |[OUT] batchNo | Batch Number
String |[OUT] adtlRespData | Additional Approval Code
String |[OUT] hostAuthRespTxt | Host Auth Response Text
String |[OUT] respText | Response Message
String |[OUT] tranNo | Tran Number of transaction
String |[OUT] customFee | Custom Fee Amount
String |[OUT] stateTax | State Tax Amount
String |[OUT] cityTax | City Tax Amount
String |[OUT] tipAmount | Tip Amount
String |[OUT] debitCashBack | Debit Cashback Amount
String |[OUT] cashDiscountAmt| Cash Discount Amount
String |[OUT] merchantFee | Merchant Fee Amount
String |[OUT] taxAmount| Tax Amount
String |[OUT] surchargeFee | Surcharge Fee Amount
String |[OUT] stanNo | System Trace Audit Number
String |[OUT] paymentMethod | Payment Method
Int |[OUT] fallback | Fallback Type
0 – Default
String |[OUT] aid | Get Aid value
String |[OUT] tsi | Terminal Status Information
String |[OUT] tvr | Terminal Verification Results
String |[OUT] tid | Terminal Id
String |[OUT] mid | Merchant Id
String |[OUT] mmid | Multi Merchant Id
String |[OUT] epiId | Epi Id
String |[OUT] profileId | Profile Id
“0”- Traditional “1” – Surcharge
String |[OUT] preferedName | Preferred Name
String |[OUT] cashDiscountAmt | Cash Discount Amount
Int |[OUT] tipAdjust | Tip Adjusted status
1 – Tip Adjusted Others – Tip not adjusted
Int |[OUT] tipEligible | Tip Adjust Eligible
0 – Not Eligible 1 – Eligible
Int |[OUT] tipFeeAmt | Tip Fee Amount
String |[OUT] clerkId | input clerk id
String |[OUT] clerkName | input clerk Name
String |[OUT] clerkLabel | input clerk Label
String |[OUT] vasLabel1 | Additional input vas label 1
String |[OUT] vasLabel2 | Additional input vas label 2
String |[OUT] vasLabel3 | Additional input vas label 3
String |[OUT] vasData1 | Additional input vas data 1
String |[OUT] vasData2 | Additional input vas data 2
String |[OUT] vasData3 | Additional input vas data 3
Class: DeviceInfo
Fields
String |[OUT] serialNo | Device Serial Number
String |[OUT] firmwareVer | Device Firmware Version
String |[OUT] appVer | App Version
String |[OUT] batteryPercentage | Device Battery Percentage
String |[OUT] batteryStatus | Device Battery Status
String |[OUT] emvKernal | EMV Kernal
String |[OUT] clsKernel | Cls Kernal
String |[OUT] rootfs | RootFS Number
String |[OUT] deviceModel | Device Model
1 SALE
2 VOID
3 PRE_AUTH
4 TICKET
5 RETURN
6 EBT_VOUCHER_SALE
7 EBT_VOUCHER_RETURN
8 EBT_BALANCE
9 SETTLEMENT
18 VOID
19 PRE_SALE
20 TIP_ADJUSTMENT
21 TICKET
35 REVERSAL_TRANSACTION
38 BALANCE_ENQUIRY
39 FETCH_TXN
43 FETCH_SUM
44 WITHDRAWAL
49 GIFT_ACTIVATION
50 GIFT_DEACTIVATION
51 GIFT_ADDVAL
0 CREDIT
1 DEBIT
2 EBT FOOD
3 EBT CASH
4 CASH
5 GIFT CARD
1 MANUAL CP
2 MANUAL CNP
3 SWIPE
4 EMV
5 CLESS EMV
6 CLESS MAG
1 Tsys Processor
2 FDR OMAHA(F/B)
3 FDR NORTH / CARDNET
4 FDR NORTH / BUYPASS
5 FDR NORTH / NASHVILLE
Please see the link for RCKT SDK