The new generation of Handpoint APIs and SDKs are engineered to make your life simpler, happier.
To start building your application and test simple changes without having to use a card reader you can use the built in simulator.
If you follow the Getting started guide for the hapi SDK there is a method used there which tells the SDK which device to use,
hapi.useDevice(new Device("Name", "Port", "Address", ConnectionMethod.****))Simply set the ConnectionMethod to Simulator, i.e. ConnectionMethod.Simulator. The SDK does the rest. You don't need to search for devices when using the simulator.
hapi.useDevice(new Device("Name", "Port", "Address", ConnectionMethod.Simulator))The simulator mimics the card reader as much as possible regarding information flow from the hapi interface to your application. E.g. it will return all the transaction statuses, transaction results and receipts. Results are controlled by the 3rd and 4th numbers from the right in the amount parameter.
The 3rd number from right sets desired financial status, Authorized or Declined. Default status is Authorized. The 4th number from right sets desired verification method, Signature or PIN. Default method is Signature.
Values
X 00 XX = Signature authorized X 01 XX = Signature declined X 10 XX = Pin authorized X 11 XX = Pin declined
You can get different responses from the simulator by setting different values for the amount parameters in transactions, e.g. for Sale function:
hapi.Sale(X10XX, Currency.GBP); // amount = X 10 XX - where X represents an integer [0;9]Replacing the 'X's with numbers then the example will result in a successful transaction where the verification method of the transaction was done through a correct PIN input.
sale
A sale initiates a payment operation to the card reader. In it's simplest form you only have to pass the amount and currency but it also accepts a map with extra parameters.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
amount |
BigInteger | Required | Amount of funds to charge - in the minor unit of currency (f.ex. 1000 is 10.00 GBP) |
currency |
Currency | Required | Currency of the charge |
map |
Map | Optional | A map including extra optional transaction parameters. |
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Initiate a sale for 10.00 in Great British Pounds
api.sale(new BigInteger("1000"),Currency.GBP);saleReversal
A sale Reversal, also called sale VOID allows the user to reverse a previous sale operation. This operation reverts (if possible) a specific sale identified with a transaction id. In it's simplest form you only have to pass the amount, currency and originalTransactionID but it also accepts a map with extra parameters. Note that transactions can only be reversed within the same day as the transaction was made.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
amount |
BigInteger | Required | Amount of funds to charge - in the minor unit of currency (f.ex. 1000 is 10.00 GBP) |
currency |
Currency | Required | Currency of the charge |
originalTransactionID |
String | Required | As received from the card reader (EFTTransactionID) |
map |
Map | Optional | A map including extra optional transaction parameters. |
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Initiate a reversal for 10.00 in Great British Pounds
api.saleReversal(new BigInteger("1000"),Currency.GBP,"00000000-0000-0000-0000-000000000000");refund
A refund initiates a refund operation to the card reader. This operation moves funds from the merchant account to the cardholder´s credit card. In it's simplest form you only have to pass the amount and currency but it also accepts a map with extra parameters.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
amount |
BigInteger | Required | Amount of funds to charge - in the minor unit of currency (f.ex. 1000 is 10.00 GBP) |
currency |
Currency | Required | Currency of the charge |
map |
Map | Optional | A map including extra optional transaction parameters. |
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Initiate a refund for 10.00 in Great British Pounds
api.refund(new BigInteger("1000"),Currency.GBP);refundReversal
A Refund Reversal, also called Refund VOID allows the merchant to reverse a previous refund operation. This operation reverts (if possible) a specific refund identified with a transaction id. In it's simplest form you only have to pass the amount, currency and originalTransactionID but it also accepts a map with extra parameters. Note that transactions can only be reversed within the same day as the transaction was made.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
amount |
BigInteger | Required | Amount of funds to charge - in the minor unit of currency (f.ex. 1000 is 10.00 GBP) |
currency |
Currency | Required | Currency of the charge |
originalTransactionID |
String | Required | As received from the card reader (EFTTransactionID) |
map |
Map | Optional | A map including extra optional transaction parameters. |
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Initiate a refund reversal for 10.00 in Great British Pounds
api.refundReversal(new BigInteger("1000"),Currency.GBP,"00000000-0000-0000-0000-000000000000");cancelRequest
This method attempts to cancel the current transaction on the card reader. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called cancelAllowed in the currentTransactionStatus event that can be used to check if the transaction is in a state that allows cancel.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Attempts to cancel an operation
api.cancelRequest();TipAdjustment
A tip adjustment operation allows merchants to adjust the tip amount of a sale transaction before the batch of transactions is settled by the processor at the end of the day.
Note: This functionality is only available for the restaurant industry in the United States and the processors currently supporting this functionality are TSYS and VANTIV.
Dependencies
The code example provided depends on RxJava, take a look a their documentation to see how to easily include this dependency in your android project. If you do not want to use RxJava or any additional dependencies then AsyncTask, provided by android, can be used instead for this asynchronous processing. Still we recommend using RxJava as it improves readability and maintainability a lot
| Parameter | Type | Validation | Notes |
|---|---|---|---|
tipAmount |
BigDecimal | Required | Tip amount added to the original (base) transaction amount - in the minor unit of currency (f.ex. 1000 is 10.00 GBP) |
originalTransactionID |
String | Required | Unique id of the original sale transaction as received from the card reader (EFTTransactionID) |
Observable.fromCallable(new Callable() {
@Override
public FinancialStatus call() throws Exception {
return api.tipAdjustment(new BigDecimal(1000), "2bc23910-c3b3-11e6-9e62-07b2a5f091ec");
}
})
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer() {
@Override
public void accept(@NonNull FinancialStatus status) throws Exception {
if (status == FinancialStatus.AUTHORISED) {
//SUCCESS
} else if (status == FinancialStatus.DECLINED) {
//DECLINED
} else {
//FAILED
}
}); signatureResult
A signatureRequired event is invoked during transaction when signature verification is needed (f.ex when payment is done with a magstripe card). The merchant is required to ask the cardholder for signature and approve (or disapprove) the signature. signatureResult tells the card reader if the signature was approved by passing true in the method. To disapprove then false is passed.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
accepted |
Boolean | Required | pass true if merchant accepts customer signature |
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Approves signature automatically in signatureRequired event
@Override
public void signatureRequired(SignatureRequest signatureRequest, Device device){
api.signatureResult(true);
}useDevice
Configures the device as the preferred device and tries to connect to it. Everytime a new connection is started the SDK will make 3 attempts to reestablish the connection. If those attempts fail, the connection is considered dead.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
device |
Device | Required | This parameter specifies to the system which device you want to use for the operations. |
//Connect to a device
Device device = new Device("CardReader7", "08:00:69:02:01:FC", "1", ConnectionMethod.BLUETOOTH);
api.useDevice(device);disconnect
Disconnect will stop the active connection (and reconnection process). Please note that the method does NOT ignore the current state of the card reader. This means that if a disconnect is attempted during a transaction it will not be successful and the method will return false. If a transaction is not in progress the disconnect will take 1-3 seconds to successfully finish and will then return true.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Disconnect from current device
api.disconnect();setSharedSecret
Validates the app for this session, thus enabling financial transactions
| Parameter | Type | Validation | Notes |
|---|---|---|---|
sharedSecret |
String | Required | The shared secret is a key provided by Handpoint when you get your account that enables you to perform live operations with the card reader. However, if you're developing with a starter kit, the test shared secret is specified in the example |
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Sets the shared secret using the test key
api.setSharedSecret("0102030405060708091011121314151617181920212223242526272829303132");setParameter
Changes values of certain parameters on the card reader.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
param |
DeviceParameter | Required | The name of the parameter to change |
value |
String | Required | New value of the parameter |
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Changes the bluetooth name of card reader
api.setParameter(DeviceParameter.BluetoothName, "OrangeCardReader");setLogLevel
Sets the log level (info, debug...) for both the card reader and the API. Note : At the end of a transaction, the card reader logs are always automatically fetched to the API.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
level |
LogLevel | Required | The desired log level. Can be LogLevel.None, LogLevel.Info, LogLevel.Full, LogLevel.Debug |
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Sets the log level to info
api.setLogLevel(LogLevel.info);getDeviceLogs
Fetches the logs from the device and reports them to the deviceLogsReady event.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Downloads logs from device
api.getDeviceLogs();getPendingTransaction
Please note this method is only supported on Card Readers with EFT Software versions 1.7.x and 2.2.x and up
In the case of a communication failure between the device and the API a TransactionResult might have not been delivered to the API. This function fetches a pending TransactionResult (which contains receipts) from the device, if any. If no TransactionResult was pending a result will be delivered containing default fields. In order to receive only valid TransactionResults this function should only be called when pendingTransactionResult event is invoked or when HapiManager.isTransactionResultPending() is true. To receive events when a TransactionResult is pending on the device please add a Events.PendingResults listener.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Fetches a pending TransactionResult from a device
api.getPendingTransaction();update
The update operation checks for update to the card reader and initiates an update if needed. The update can either be a software update or a configuration update.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
device |
Device | Optional | This parameter specifies to the system which device you want to use for the operations. If none is supplied the system will attempt to use a default device, if any. |
//Check for card reader update
api.update();listDevices
Starts the search for devices to connect with the specified ConnectionMethod
| Parameter | Type | Validation | Notes |
|---|---|---|---|
method |
ConnectionMethod | Required | The means of connection you intend to use to talk to the device. (Bluetooth, Serial, USB, etc...) |
//Search for Bluetooth devices
api.listDevices(ConnectionMethod.BLUETOOTH);startMonitoringConnections
Starts a connection monitoring service. The service listens to events sent by the operating system about the connected hardware. If the service notices that a previously connected device suddenly disconnects on the hardware layer it attempts to reconnect to that particular device. Since this is a service it is necessary that the service is turned off before the application ends its life-time. This means that, if the service was running, stopMonitoringConnections() has to be called before the application is exited completely. Note that the service currently only works with BLUETOOTH. In the case of BLUETOOTH the service will attempt to reconnect to the device three times, if unsuccessful the connection is considered Disconnected.
//Starts the connection monitoring service
//app starts it's life-time
api.startMonitoringConnections();
...
//app ends its life-time
api.stopMonitoringConnectionsstopMonitoringConnections
Stops a connection monitoring service. The service listens to events sent by the operating system about the connected hardware. If the service notices that a previously connected device suddenly disconnects on the hardware layer it attempts to reconnect to that particular device. Since this is a service it is necessary that the service is turned off before the application ends its life-time. This means that, if the service was running, stopMonitoringConnections() has to be called before the application is exited completely. Note that the service currently only works with BLUETOOTH. In the case of BLUETOOTH the service will attempt to reconnect to the device three times, if unsuccessful the connection is considered Disconnected.
//Starts the connection monitoring service
//app starts it's life-time
api.startMonitoringConnections();
...
//app ends its life-time
api.stopMonitoringConnectionsaddRequiredEventHandler
Adds a listener so necessary information can be retrieved. Such as signature verification, receipts and list of devices. This listener fetches information from the following events : deviceDiscoveryFinished, signatureRequired and endOfTransaction. The corresponding removal method, removeRequiredEventHandler, must be called before the end of your applications life-time to prevent memory leakage.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
listener |
Required | Required | An implementation of the Events.Required interface |
//Register a listener for required events
this.api.addRequiredEventHandler(this);
//In this context the keyword "this" is an implementation of:
interface Events.Required {
void signatureRequired(SignatureRequest request, Device device);
void endOfTransaction(TransactionResult result, Device device);
void deviceDiscoveryFinished(List devices);
} addStatusNotificationEventHandler
Adds a listener so transaction information can be retrieved. This listener fetches information from the following events : connectionStatusChanged, currentTransactionStatus. The corresponding removal method, removeStatusNotificationEventHandler, must be called before the end of your applications life-time to prevent memory leakage.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
listener |
Status | Required | An implementation of the Events.Status interface |
//Register a listener for transaction information events
this.api.addStatusNotificationEventHandler(this);
//In this context the keyword "this" is an implementation of:
interface Events.Status {
void connectionStatusChanged(ConnectionStatus status, Device device);
void currentTransactionStatus(StatusInfo info, Device device);
}addLogEventHandler
Adds a listener so log information can be retrieved. This listener fetches information from the following events : onMessageLogged, deviceLogsReady. The corresponding removal method, removeLogEventHandler, must be called before the end of your applications life-time to prevent memory leakage.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
listener |
Log | Required | An implementation of the Events.Log interface |
//Register a listener for log information events
this.api.addLogEventHandler(this);
//In this context the keyword "this" is an implementation of:
interface Events.Log {
void deviceLogsReady(String logs, Device device);
void onMessageLogged(LogLevel level, String message);
}addPendingResultsEventHandler
Adds a listener so information can be retrieved when there is a pending TransactionResult. This listener fetches information from the following events : pendingTransactionResult, transactionResultReady. The corresponding removal method, removePendingResultsEventHandler, must be called before the end of your applications life-time to prevent memory leakage.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
listener |
PendingResults | Required | An implementation of the Events.PendingResult interface |
//Register a listener for log information events
this.api.addPendingResultsEventHandler(this);
//In this context the keyword "this" is an implementation of:
interface Events.PendingResults {
void pendingTransactionResult(Device device);
void transactionResultReady(TransactionResult transactionResult, Device device);
}removeRequiredEventHandler
Removes a listener so information is not passed on to that listener any more.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
listener |
Required | Required | The listener to be removed |
//Remove a listener for required events
this.api.removeRequiredEventHandler(this);removeStatusNotificationEventHandler
Removes a listener so information is not passed on to that listener any more.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
listener |
Status | Required | The listener to be removed |
//Remove a listener for status notification events
this.api.removeStatusNotificationEventHandler(this);removeLogEventHandler
Removes a listener so information is not passed on to that listener any more.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
listener |
Log | Required | The listener to be removed |
//Remove a listener for log events
this.api.removeLogEventHandler(this);removePendingResultsEventHandler
Removes a listener so information is not passed on to that listener any more.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
listener |
PendingResults | Required | The listener to be removed |
//Remove a listener for pending results events
this.api.removePendingResultsEventHandler(this);deviceDiscoveryFinished
deviceDiscoveryFinished event gets called when a device discovery has finished and returns a list of devices.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
device |
Device | Required | The device that is invoking the event |
//Receiving a list of connectable devices
List myListOfDevices = new List();
@Override
public void DeviceDiscoveryFinished(List devices)
{
foreach(Device device in devices){ myListOfDevices.Add(device);
}
} signatureRequired
signatureRequired event gets called when a card requires a signature instead of PIN entry and has two parameters, request and device.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
request |
SignatureRequest | Required | Holds the signature request |
device |
Device | Required | The device that is invoking the event |
@Override
public void signatureRequired(SignatureRequest signatureRequest, Device device) {
signatureRequest.getMerchantReceipt();
api.signatureResult(true);
}endOfTransaction
endOfTransaction event gets called at the end of each transaction and has two parameters, result and device.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
result |
TransactionResult | Required | Holds the results for the transaction |
device |
Device | Required | The device that is invoking the event |
@Override
public void endOfTransaction(TransactionResult transactionResult, Device device) {
Log.d(App, transactionResult.getCustomerReceipt());
}connectionStatusChanged
connectionStatusChanged event gets called when the state of a card reader connection changes.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
status |
ConnectionStatus | Required | An enum containing the status code for the connection |
device |
Device | Required | The device that is invoking the event |
@Override
public void connectionStatusChanged(ConnectionStatus connectionStatus, Device device) {
Log.d(App, connectionStatus.name());
}currentTransactionStatus
currentTransactionStatus event gets called when the state of an ongoing transaction changes.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
statusInfo |
StatusInfo | Required | An object containing information about the current transaction |
device |
Device | Required | The device that is invoking the event |
@Override
public void currentTransactionStatus(StatusInfo statusInfo, Device device) {
}onMessageLogged
onMessageLogged event gets called for all log messages that are being logged. This is only intended for debugging.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
logLevel |
LogLevel | Required | An enum containing the log level |
message |
String | Required | A String containing the current log message |
@Override
public void onMessageLogged(LogLevel logLevel, String message){
Log.d("API log", message);
}deviceLogsReady
DeviceLogsReady event gets called when the card reader logs requested by a call to getDeviceLogs() are ready. This Event is really useful if there has been a communication error between the card reader and the API (e.g : Bluetooth communication lost). After reconnecting, you can then fetch the card reader logs to the API.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
logs |
String | Required | String containing the current log |
device |
Device | Required | The device that is invoking the event |
@Override
public void deviceLogsReady(String logs, Device device){
Log.d("Device logs:", logs);
}pendingTransactionResult
In the case of a communication failure between the device and the API a TransactionResult might have not been delivered to the API. This event is invoked when the device has a pending TransactionResult. This event might be invoked when reconnecting to a device after a communication failure during a transaction. This event will not be called if HapiManager.Settings.autoRecoverTransactionResult is set to true.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
device |
Device | Required | The device that is invoking the event |
@Override
public void pendingTransactionResult(Device device){
//Here you might want to call api.getPendingTransaction(); to receive the TransactionResult
}transactionResultReady
In the case of a communication failure between the device and the API a TransactionResult might have not been delivered to the API. This event will be invoked after using hapi.getPendingTransaction();. When there is no pending transaction the TransactionResult will contain default/error fields and no receipts. This event is called if HapiManager.Settings.autoRecoverTransactionResult is set to true.
| Parameter | Type | Validation | Notes |
|---|---|---|---|
result |
TransactionResult | Required | Holds the results for the transaction |
device |
Device | Required | The device that is invoking the event |
@Override
public void transactionResultReady(TransactionResult transactionResult, Device device){
//Here you might want to do stuff to the transactionResult
}TransactionType
An enum representing different types of transactions.
UNDEFINED
SALE
VOID_SALE
REFUND
VOID_REFUND
CANCEL_SALE
CANCEL_REFUND
TransactionResult
An object holding information about a transaction result.
| Property | Type | Accessor | Description |
|---|---|---|---|
StatusMessage |
String | get | Gets the status message from the TransactionResult. The status message is a human readable string from our servers which contains a value representing the result from the server side. "AUTH CODE 12345" for an example. |
Type |
TransactionType | get | Gets the transaction type from the TransactionResult. The transaction type represents which type of transaction was done. "SALE" for an example. |
FinStatus |
FinancialStatus | get | Gets the financial status from the TransactionResult. The financial status describes the conclusion of the transaction as received from the card reader. "AUTHORISED" for an example. |
RequestedAmount |
BigInteger | get | Gets the requested amount from the TransactionResult. The requested amount is the payment amount sent in the original request to the card reader, i.e. the amount which was to charge the card with. |
GratuityAmount |
BigInteger | get | Gets the gratuity amount from the TransactionResult. The gratuity amount is an additional amount added to the requested payment amount which represents additional fee added to the requested amount. This is used when the card reader is supporting the tipping functionality. An example: A sale is started with the amount 1000 and the card reader is set to support tipping. The card reader asks if a tip should be applied by the customer. The customer inputs an additional amount as a tip, lets say 100. The card is then charged for the requested amount, 1000, as well as the additional gratuity amount, 100. The result will be that the card will be charged for 1100. A calculated gratuity percentage will also be returned. |
GratuityPercentage |
double | get | Gets the gratuity percentage from the TransactionResult The gratuity percentage is used to calculate an additional amount to the requested amount. The card reader calculates that amount, rounded up to the closest whole number. This is used when the card reader is supporting the tipping functionality. An example: A sale is started with the amount 1000 and the card reader is set to support tipping. The card reader asks if a tip should be applied by the customer. Instead of the customer adding a value he selects the percentage of the requested amount to be applied as a tip, lets say 10%. The card is then charged for the requested amount, 1000, as well as the additional gratuity percentage, 10%. The result will be that the card will be charged for 1100. A calculated gratuity amount will also be returned. |
TotalAmount |
BigInteger | get | Gets the total amount from the TransactionResult. The total amount is the amount the card was charged for. It is possible that the total amount is not the same as the requested amount since an additional fee can be added, with the customer's approval, via the tipping functionality. |
Currency |
Currency | get | Gets the currency from the TransactionResult. The currency used in this transaction. |
TransactionID |
String | get | Gets the device transaction id from the TransactionResult. The transaction id is an internal increasing counter in the card reader which is incremented in each transaction. |
eFTTransactionID |
String | get | Gets the device transaction id from the TransactionResult. The EFT (electronic funds transfer) transaction id is a unique GUID from the servers which is linked to this transaction in order to search for a particual transaction. This id is used if a transaction is to be reversed. |
OriginalEFTTransactionID |
String | get | Gets the original EFT transaction id from the TransactionResult. The original EFT (electronic funds transfer) transaction id is a unique GUID previously received from the servers in order to reverse a transaction. This id is sent with the new eFTTransactionID in order to reference the original transaction. An example: A transaction is made. An eFTTransactionID is received. That transaction has to be reversed. A new transaction is started, now a reverse transaction, with the previously received eFTTransactionID as a parameter in the transaction. In the end result there will be a new eFTTransactionID, for the reverse transaction, and an originalEFTTransactionID referencing the original transaction. |
eFTTimestamp |
Date | get | Gets the time stamp from the TransactionResult. The eFTTimestamp represents the time when the transaction was done. This time is set by the device communicating to the card reader when the connection is established to the card reader. |
AuthorisationCode |
String | get | Gets the authorisation code from the TransactionResult. If the transaction was authorised the value represented can be used to search for a transaction in our system. |
VerificationMethod |
VerificationMethod | get | Gets the verification method from the TransactionResult. The verification method represents the card holder verification method used to allow the payment. "PIN" for an example. |
CardEntryType |
CardEntryType | get | Gets the card entry type from the TransactionResult. The card entry type is the method the card information was input to card reader. "ICC" for an example represents "Integrated Circuit Card" i.e. the information was read from the chip of the card. |
CardSchemeName |
String | get | Gets the card scheme name from the TransactionResult. The scheme which was used when the transaction was made. |
ErrorMessage |
String | get | Gets the error message from the TransactionResult. If there was an error during the transaction it is represented here in a human readable text. |
CustomerReference |
String | get | Gets the customer reference from the TransactionResult. If a customer reference was added, as an optional parameter, when the transaction was started. It is received here, unaltered. The customer reference can be used to reference in internal systems. |
BudgetNumber |
String | get | Gets the budget number from the TransactionResult. If a budget number was added, as an optional parameter, when the transaction was started. It is received here, unaltered. The budget number can be used to split payments over a period of months. |
RecoveredTransaction |
boolean | get | Gets the flag recovered transaction from the TransactionResult. This flag is true if the transaction result is from a previous transaction which failed to get sent from the card reader, false otherwise. In the case that the communication between the device and the card reader breaks down, the card reader will attempt to send the result of the previous transaction as an immediate reply when the next transaction is started. If this happens the transaction is flagged as a "RecoveredTransaction". This should be displayed very well in the UI since this is *NOT* the result from the transaction just started. |
CardTypeId |
String | get | Gets the card type id from the transaction. The card type id is an identifier inside the Handpoint gateway which represents what kind of card was used. "U015" for an example represents SAS Airline-Systems in our systems. |
MerchantReceipt |
String | get | Gets the merchant receipt from the TransactionResult. An HTML containing the merchant receipt. |
CustomerReceipt |
String | get | Gets the customer receipt from the TransactionResult. An HTML containing the customer receipt. |
DeviceStatus |
DeviceStatus | get | Gets the device status from the TransactionResult. |
HapiFactory
A factory to provide a unified entrypoint and to simplify the way to instantiate the Hapi object.
getAsyncInterface( Events.Required requiredListener , Context context );
| Parameter | Type | Validation | Notes |
|---|---|---|---|
requiredListener |
Events.Required | Required | A listener object to report the required events. |
context |
Context | Required | The Android context in order to handle bluetooth. |
//An Android Context is required to be able to handle bluetooth
public void initApi(Context context) {
String sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
this.api = HapiFactory.getAsyncInterface(this, context).defaultSharedSecret(sharedSecret);
}ConnectionMethod
An enum representing different types of connection methods.
Currently BLUETOOTH and SIMULATOR are supported for android devices.
USB
SERIAL
BLUETOOTH
HTTPS
WIFI
ETHERNET
SIMULATOR
//Currently BLUETOOTH and SIMULATOR are the only ConnectionMethod available.
public enum ConnectionMethod {
USB,
SERIAL,
BLUETOOTH,
HTTPS,
WIFI,
ETHERNET,
SIMULATOR
}Device
An object to store the information about the device we're working with.
Device( String name , String address , String port , ConnectionMethod connectionMethod , String sharedSecret , int timeout );
| Parameter | Type | Validation | Notes |
|---|---|---|---|
name |
String | Required | A name to identify the device |
address |
String | Required | The address of the device you wish to connect to. E.g.: "08:00:69:02:01:FC" for bluetooth or "192.168.1.105" for ethernet. |
port |
String | Required | The port to connect to. |
connectionMethod |
ConnectionMethod | Required | Enumerated type to specify the type of connection with the device. E.g: Bluetooth, Serial, etc... |
sharedSecret |
String | Optional | This is used if you want this specific device to use the specified sharedSecret instead of the default one proviced in the initialization. |
timeout |
int | Optional | The amount of miliseconds to consider the connection has timed out. If not set, the default timeout is 15 seconds. |
| Property | Type | Accessor | Description |
|---|---|---|---|
Id |
String | get | An unique identifier of the device. |
//Create and init a new Device
Device dev = new Device("CardReader7", "08:00:69:02:01:FC", "1", ConnectionMethod.BLUETOOTH);ConnectionStatus
A list of statuses given to a connection
Connected
Connecting
Disconnected
Disconnecting
Initializing
NotConfigured
SignatureRequest
A class containing information about a signature request/signature verification.
| Property | Type | Accessor | Description |
|---|---|---|---|
Timeout |
int | get | int the value of the timeout in seconds. |
MerchantReceipt |
String | get | String the merchant receipt as html. |
Currency
An enum of most currencies in the world.
Contains the ISO name, ISO number and the name of the currency. Additionally contains information about how many decimals the currency uses.
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BOV
BRL
BSD
BTN
BWP
BYR
BZD
CAD
CDF
CHF
CLP
CNY
COP
COU
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EEK
EGP
ERN
ETB
EUR
FJD
FKP
GBP
GEL
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
INR
IQD
IRR
ISK
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LVL
LYD
MAD
MDL
MKD
MMK
MNT
MOP
MUR
MVR
MWK
MXN
MXV
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
STD
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
USD
UZS
VEF
VND
VUV
WST
XAF
XCD
XOF
XPF
YER
ZAR
ZMK
ZWL
DeviceParameter
An enum describing all the available commands to send to a device.
When used a legal value is expected with the command
BluetoothName
BluetoothPass
SystemTimeout
ScreenTimeout
SignatureTimeout
DeviceStatus
A class that holds the device status.
| Property | Type | Accessor | Description |
|---|---|---|---|
SerialNumber |
String | get | Gets the serial number of the device |
BatteryStatus |
String | get | Gets the battery status in percentages of a device |
BatterymV |
String | get | Gets the battery milli volts of a device |
BatteryCharging |
String | get | Gets the battery charging status of a device |
ExternalPower |
String | get | Gets the status of an external power of a device |
ApplicationName |
String | get | Gets the application name used on a device |
ApplicationVersion |
String | get | Gets the application version number used on a device |
FinancialStatus
An enum representing different statuses of a finalized transaction
UNDEFINED
AUTHORISED
DECLINED
PROCESSED
FAILED
CANCELLED
statusInfo
A class containing information about the status of the transaction.
| Property | Type | Accessor | Description |
|---|---|---|---|
cancelAllowed |
bool | get | A bool representing if the card reader will accept a cancel request. |
status |
Status | get | A Status enum representing the status of the transaction. |
message |
String | get | A String containing the status message of the transaction. |
deviceStatus |
DeviceStatus | get | A DeviceStatus object containing information about the device. |
LogLevel
An enum describing the different levels of logging used in the hapi and used in the device.
None
Info
Full
Debug
OptionalParameters
A class containing optional transaction parameters now supported by the device.
| Property | Type | Accessor | Description |
|---|---|---|---|
Budget |
String | static | Budget is only available for sale transactions. A String representing the key for a budget number.A budget number can be used to split up an amout over a period of months. The value has to be a |
CustomerReference |
String | static | CustomerReference is available for all transactions. A String representing the key for a customer reference. A customer reference can be used for an internal marking system. The value is sent as a |
VerificationMethod
An enum representing different verification methods used in the transaction.
UNDEFINED
SIGNATURE
PIN
PIN_SIGNATURE
FAILED
NOT_REQUIRED
status
An enum containing information about the status of the transaction.
UserCancelled
WaitingForCard
CardInserted
ApplicationSelection
ApplicationConfirmation
AmountValidation
PinInput
ManualCardInput
WaitingForCardRemoval
TipInput
AuthenticatingPos
WaitingForSignature
ConnectingToHost
SendingToHost
ReceivingFromHost
DisconnectingFromHost
PinInputComplete
Undefined
CardEntryType
An enum representing different card entry types.
UNDEFINED
MSR
ICC
CNP
HapiManager
A static class containing information about the current status of the SDK
| Property | Type | Accessor | Description |
|---|---|---|---|
DefaultSharedSecret |
String | get | Gets the default shared secret is use in the SDK. |
LogLevel |
LogLevel | get | Gets the current log level of the SDK and card reader. |
inTransaction |
boolean | get | Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and card reader but the transaction has been completed on the card reader. |
SdkVersion |
String | get | Gets the current Sdk version. |
isTransactionResultPending |
boolean | get | In the case of a communication failure between the device and the API a TransactionResult might have not been delivered to the API. This function checks if there is a pending TransactionResult. This field is only updated when connecting to a device. If this function returns true the TransactionResult (which includes the receipt) can be fetched with hapi.getPendingTransactionResult();. This function serves the same functionality as the event pendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched. |
Settings.autoRecoverTransactionResult |
boolean | get/set | In the case of a communication failure between the device and the API a TransactionResult might have not been delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending TransactionResult when detected and return it via transactionResultReady. The function pendingTransactionResult is never invoked if this property is set to true. If set to false pendingTransactionResult will be called when a TransactionResult is pending. |
//Check if the SDK is in transaction
boolean inTransaction = HapiManager.inTransaction(someConnectedDevice);
//Check the current logLevel
LogLevel level = HapiManager.getLogLevel();