You are currently viewing the documentation for version

Introduction

The new generation of Handpoint APIs and SDKs are engineered to make your life simpler, happier.

Awesomely simple
Created for humans, coders, geeks, no need of dark and complex knowledge of the payment industry.
Superly secure
We take care of the PCI side so you don't have to spend months becoming compliant.
The Handpoint card reader encrypts all sensitive cardholder data so your app does not have to deal with it.
Working with the SDK
The Handpoint Windows SDK is compatible with .NET Framework Version 4.

1. Download the SDK.
2. Create a new windows form project in Visual Studio 2010 (or above) using .Net Framework Version 4.0.
3a. Add the HandpointSDK NuGet Package
to your project.
3b. Alternatively you can manually download the .zip file and add "HandpointSDK.dll" library as reference to your project.
4. Follow the getting started guide, to get you up and running or dive into the documentation.

If you have any questions, do not hesitate to contact us.

version 2.0.4

Get the SDK

API overview

How to implement a Sale Transaction

The below flow chart shows the interaction between the SDK, the payment terminal and your application. The orange arrows represent methods (requests) that need to be invoked to communicate with the Handpoint SDK's. The dark arrows represent events that need to be integrated in your code in order to retrieve information from the SDK´s and the card reader.


How to implement a Sale Transaction with Recovery feature

At some point, the connection between the SDK and the card reader can become unstable. For example, the Bluetooth connection can be cut in the middle of a sale transaction if the smartphone runs out of battery. If this happens, you need to have implemented the “transaction recovery feature” in order to get the receipts from the previous transaction and knowing if it was successful despite the connection problem.



Supported functionality

  • Discovery of remote BT devices.
  • Connect to remote BT device.
  • Physical connection to HiPro external accessory.
  • Automatic or manual reconnection to the card reader.
  • Executing financial transaction.
  • Reporting status of transactions.
  • Control and access to device logs.
  • Barcode scanner with HiPro card readers.
  • Limited card reader simulation.

Processing Payments Simulation

Your test payments are sent against a test server on the Handpoint side which simulates the behavior of an acquiring bank. Funds are not moved and sensitive data from the card is fully encrypted. You can use trigger amounts to generate some specific responses from our server:

Sale amounts
Amount Behaviour
37.79 Issuer response code = 01 (Refer to issuer)
37.84 Issuer response code = 05 (Not authorized)
37.93 Issuer response code = 04 (Pick up card)
37.57 Request is partially approved
37.68 Request timeout


Getting started

Getting started with the simulator

Introduction

This tutorial is guiding you through all the steps to create a basic payment application for Windows using a card reader simulator. The simulator only has limited capabilities and we highly recommend that you order a development kit if you want to carry a full integration. The development kit contains a card reader as well as a test card and will allow you to test your integration from end to end.

The new generation of Handpoint SDK's is designed to make your life easier. Simple and created for humans, it does not require any specific knowledge of the payment industry to be able to start accepting credit/debit card transactions.

At Handpoint we take care of securing every transaction so you don´t have to worry about it while creating your application. We encrypt data from the payment terminal to the bank with our point-to-point encryption solution. Our platform is always up to the latest PCI-DSS security requirements. We undergo an audit on a yearly basis to be able to maintain the license to handle, process, store and transmit card data.

Connecting to the simulator

The SDK offers a method in which you will need to specify the card reader to be used:


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 via bluetooth for surrounding card readers when using the simulator.


hapi.useDevice(new Device("Name", "Port", "Address", ConnectionMethod.Simulator))
            

Controlling responses

The simulator mimics the card reader as much as possible regarding information flow from the SDK interface to your application. It will return all the transaction statuses, transaction results and receipts.

Results of a transaction are controlled by the amount sent into the sale function:
The 3rd position from the right sets the desired financial status, 0 = Authorized and 1 = Declined.
The 4th position from the right sets the desired verification method, 0 = Signature and 1 = PIN.

hapi.Sale(X10XX, Currency.GBP); // amount = X 10 XX - where X represents an integer [0;9]

  • X 00 XX = Signature authorized
  • X 01 XX = Signature declined
  • X 10 XX = Pin authorized
  • X 11 XX = Pin declined

Let's start programming!

  1. Create a C# class
  2. Create a new C# class called MyClass and include com.handpoint.api as a dependency :

    
        using System;
        using System.Collections.Generic;
        using System.Linq;
        using System.Text;
        using com.handpoint.api;
        
        namespace GettingStartedWithSimulator
        {
            class MyClass
            {
            }
        }
                        
  3. Initialize the API
  4. 
        using System;
        using System.Collections.Generic;
        using System.Linq;
        using System.Text;
        using com.handpoint.api;
        
        namespace GettingStartedWithSimulator
        {
            class MyClass
            {
                Hapi api;
        
                public MyClass()
                {
                    InitApi();
                }
                public void InitApi()
                {
                    string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
                    api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
                    // The api is now initialized. Yay! we've even set a default shared secret!
                    // The shared secret is a unique string shared between the card reader and your mobile application.
                    // It prevents other people to connect to your card reader.
                }
            }
        }
                        
  5. Implement the mandatory Events(Events.Required)
  6. 
        using System;
        using System.Collections.Generic;
        using System.Linq;
        using System.Text;
        using com.handpoint.api;
        
        namespace GettingStartedWithSimulator
        {
            class MyClass : Events.Required
            {
                Hapi api;
        
                public MyClass()
                {
                    InitApi();
                }
        
                public void InitApi()
                {
                    string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
                    api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
                    // The api is now initialized. Yay! we've even set a default shared secret!
                    // The shared secret is a unique string shared between the card reader and your mobile application
                    // It prevents other people to connect to your card reader
                }
        
                public void DeviceDiscoveryFinished(List<Device> devices)
                {
                    // Only needed when using a payment terminal
                    //here you get a list of Bluetooth payment terminals paired with your PC
                    // You can also get a list of serial / USB payment terminals attached to your computer
        
                }
        
                public void SignatureRequired(SignatureRequest signatureRequest, Device device)
                {
                    // You'll be notified here if a sale process needs a signature verification
                    // A signature verification is needed if the cardholder uses an MSR or a chip & signature card
                    // This method will not be invoked if a transaction is made with a Chip & PIN card
        
                    api.SignatureResult(true); // This line means that the cardholder ALWAYS accepts to sign the receipt
                    // A specific line will be displayed on the merchant receipt for the cardholder to be able to sign it
                }
        
                public void EndOfTransaction(TransactionResult transactionResult, Device device)
                {
                    // The object TransactionResult holds the different receipts
                    // Other information can be accessed through this object like the transaction ID, the amount...
                }
            }
        }
                        
  7. Add a method to connect to the simulator
  8. 
        public void Connect()
        {
            Device device = new Device("Name", "Address", "Port", ConnectionMethod.SIMULATOR);
            api.UseDevice(device);
        }
                        
  9. Add a method to take payments with the simulator
  10. The simulator mimics the card reader as much as possible regarding the information flow from the SDK interface to your application. The results of the transaction (declined, authorized) and the type of verification method (PIN, signature) will depend on the amount used.

    You can get different responses from the simulator by setting different values for the amount parameter, e.g. for a Sale function :

    
        api.Sale(X10XX, Currency.GBP); // amount = X 10 XX - where X represents an integer [0;9]
                        

    Amount Values

    • X00XX = Signature authorized
    • X01XX = Signature declined
    • X10XX = PIN authorized
    • X11XX = PIN declined

    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.

    Let´s add 4 methods to MyClass in order to represent the 4 cases above :

    
        using System;
        using System.Collections.Generic;
        using System.Linq;
        using System.Text;
        using com.handpoint.api;
        
        namespace GettingStartedWithSimulator
        {
            class MyClass : Events.Required
            {
                Hapi api;
        
                public MyClass()
                {
                    InitApi();
                }
        
                public void InitApi()
                {
                    string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
                    api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
                    // The api is now initialized. Yay! we've even set a default shared secret!
                    // The shared secret is a unique string shared between the card reader and your mobile application.
                    // It prevents other people to connect to your card reader.
                }
        
                public void DeviceDiscoveryFinished(List <Device> devices)
                {
                     // Only needed when using a payment terminal
                     //Here you get a list of Bluetooth payment terminals paired with your PC
                     // You can also get a list of serial / USB payment terminals attached to your computer
        
                }
        
                public void Connect()
                {
                    Device device = new Device("Name", "Address", "Port", ConnectionMethod.SIMULATOR);
                    api.UseDevice(device);
                }
        
                public bool PayWithSignatureAuthorized()
                {
                    return api.Sale(new BigInteger("10000"), Currency.GBP);
                    // amount X00XX where X represents an integer [0;9] --> Signature authorized
                }
        
                public bool PayWithSignatureDeclined()
                {
                    return api.Sale(new BigInteger("10100"), Currency.GBP);
                    // amount X01XX where X represents an integer [0;9] --> Signature declined
                }
        
                public bool PayWithPinAuthorized()
                {
                    return api.Sale(new BigInteger("11000"), Currency.GBP);
                    // amount X10XX where X represents an integer [0;9] --> PIN authorized
                }
                public bool PayWithPinDeclined()
                {
                    return api.Sale(new BigInteger("11100"), Currency.GBP);
                    // amount X11XX where X represents an integer [0;9] --> PIN declined
                }
        
                public void SignatureRequired(SignatureRequest signatureRequest, Device device)
                {
                    // You'll be notified here if a sale process needs a signature verification
                    // A signature verification is needed if the cardholder uses an MSR or a chip & signature card
                    // This method will not be invoked if a transaction is made with a Chip & PIN card
        
                    api.SignatureResult(true); // This line means that the cardholder ALWAYS accepts to sign the receipt.
                    // A specific line will be displayed on the merchant receipt for the cardholder to be able to sign it
                }
        
                public void EndOfTransaction(TransactionResult transactionResult, Device device)
                {
                    // The object TransactionResult stores the different receipts
                    // Other information can be accessed through this object like the transaction ID, the amount...
                }
            }
        }
                        

Let's create a User Interface!

  1. Create buttons
    • Go to your user interface (usually Form1.cs[Design])
    • Select View > Toolbox
    • In the toolbox, under “Common Controls” drag and drop 5 button items to the user interface
    • Select "button1" > Right-Click > Properties
    • Change the attribute "Name" from "button1" to "ConnectToSimulator"
    • Change the attribute "text" from "button1" to "Connect To Simulator"
    • Change the attribute "Name" from "button2" to "PayWithSignatureAuthorized"
    • Change the attribute "text" from "button2" to "Pay With Signature Authorized"
    • Change the attribute "Name" from "button3" to "PayWithSignatureDeclined"
    • Change the attribute "text" from "button3" to "Pay With Signature Declined"
    • Change the attribute "Name" from "button4" to "PayWithPinAuthorized"
    • Change the attribute "text" from "button4" to "Pay With Pin Authorized"
    • Change the attribute "Name" from "button5" to "PayWithPinDeclined"
    • Change the attribute "text" from "button5" to "Pay With Pin Declined"

  2. Create WebBrowsers
  3. Now that we have our 5 buttons let´s create two webBrowsers items to display the merchant receipt as well as the cardholder´s receipt at the end of the transaction.

    • Select View > Toolbox > Common Controls > WebBrowser
    • Drag and drop two web browsers to the user interface
    • Select View > Toolbox > Common Controls > Label
    • Drag and drop two labels to the user interface in order to identify the webBrowser items
    • Change the attribute "Name" from the left webBrowser to "MerchantReceiptBrowser"
    • Change the attribute "Name" from the right webBrowser to "CardholderReceiptBrowser"
    • Change the attribute "Name" from "label1" to "MerchantReceiptLabel"
    • Change the attribute "text" from "label1" to "Merchant Receipt :"
    • Change the attribute "Name" from "label2" to "CardholderReceiptLabel"
    • Change the attribute "text" from "label2" to "Cardholder Receipt :"

Let's link our user interface with methods!

  1. Referencing the user interface(Form1.cs) in MyClass
  2. In MyClass.cs, create an instance of Form1 called UIClass and initialize it. Instantiate MyClass and add form1 as a parameter for the Class.

    
        class MyClass : Events.Required
            {
                Hapi api;
                private Form1 UIClass;
        
                public MyClass(Form1 form1)
                {
                    InitApi();
                    UIClass = form1;
                }
                        
  3. Referencing Myclass in Form1.cs and link methods to the user interface
  4. Go to Form1.cs[Design] and double click on the button "Connect To Simulator". By Double Clicking on the "Connect To Simulator" button you created a method called ConnectToSimulator_Click. Create a new instance of MyClass called "my" in Form1.cs then, inside the new method ConnectToSimulator_Click call the Connect() method from MyClass.

    
        using System;
        using System.Collections.Generic;
        using System.ComponentModel;
        using System.Data;
        using System.Drawing;
        using System.Linq;
        using System.Text;
        using System.Windows.Forms;
        namespace GettingStartedWithSimulator
        {
            public partial class Form1 : Form
            {
                MyClass my;
        
                public Form1()
                {
                    InitializeComponent();
                    my = new MyClass(this);
                }
                private void ConnectToSimulator_Click(object sender, EventArgs e)
                {
                    my.Connect();
                }
            }
        }
                        

    Go back to Form1.cs[Design] and double click on each of the other buttons to automatically generate an OnClick method in Form1.cs. Link each of the buttons to the correct methods in MyClass.cs.

    
        using System;
        using System.Collections.Generic;
        using System.ComponentModel;
        using System.Data;
        using System.Drawing;
        using System.Linq;
        using System.Text;
        using System.Windows.Forms;
        namespace GettingStartedWithSimulator
        {
            public partial class Form1 : Form
            {
                MyClass my;
                public Form1()
                {
                    InitializeComponent();
                    my = new MyClass(this);
                }
                private void ConnectToSimulator_Click(object sender, EventArgs e)
                {
                    my.Connect();
                }
                private void PayWithSignatureAuthorized_Click(object sender, EventArgs e)
                {
                    my.PayWithSignatureAuthorized();
                }
                private void PayWithSignatureDeclined_Click(object sender, EventArgs e)
                {
                    my.PayWithSignatureDeclined();
                }
                private void PayWithPinAuthorized_Click(object sender, EventArgs e)
                {
                    my.PayWithPinAuthorized();
                }
                private void PayWithPinDeclined_Click(object sender, EventArgs e)
                {
                    my.PayWithPinDeclined();
                }
            }
        }
                        

Let´s display the receipts at the end of a transaction!

  1. Fetch the cardholder's and merchant receipts from the method EndOfTransaction in MyClass
  2. At this point all the buttons are connected but we are still missing to display the receipts in the webBrowsers. First, let´s get the receipts from the method EndOfTransaction in myClass.cs.

    
        public void EndOfTransaction(TransactionResult transactionResult, Device device)
                {
                    UIClass.DisplayReceipts(transactionResult.MerchantReceipt, transactionResult.CustomerReceipt);
                }
                        
  3. Create the DisplayReceipts method in form1.cs
  4. 
        public delegate void UpdateReceiptsCallback(string MerchantReceipt, string CustomerReceipt);
                public void DisplayReceipts(string MerchantReceipt, string CustomerReceipt)
                {
                    //Only need to check for one of the webBrowsers
                    if (MerchantReceiptBrowser.InvokeRequired)
                    {
                        UpdateReceiptsCallback d = new UpdateReceiptsCallback(DisplayReceipts);
                        this.Invoke(d, new object[] { MerchantReceipt, CustomerReceipt });
                    }
                    else
                    {
                        MerchantReceiptBrowser.DocumentText = MerchantReceipt;
                        CardholderReceiptBrowser.DocumentText = CustomerReceipt;
                    }
                }
                        

Final Result!

Here is how MyClass.cs and Form1.cs must eventually look like :

  1. MyClass.cs :
  2. 
        using System;
        using System.Collections.Generic;
        using System.Linq;
        using System.Text;
        using com.handpoint.api;
        namespace GettingStartedWithSimulator
        {
            class MyClass : Events.Required
            {
                Hapi api;
                private Form1 UIClass;
                public MyClass(Form1 form1)
                {
                    InitApi();
                    UIClass = form1;
                }
        
                public void InitApi()
                {
                    string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
                    api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
                    // The api is now initialized. Yay! we've even set a default shared secret!
                    // The shared secret is a unique string shared between the card reader and your mobile application.
                    // It prevents other people to connect to your card reader.
                }
        
                public void DeviceDiscoveryFinished(List<Device> devices)
                {
                    // Only needed when using a payment terminal
                    //Here you get a list of Bluetooth payment terminals paired with your PC
                    // You can also get a list of serial / USB payment terminals attached to your computer
        
                }
        
                public void Connect()
                {
                    Device device = new Device("Name", "Address", "Port", ConnectionMethod.SIMULATOR);
                    api.UseDevice(device);
                }
        
                public bool PayWithSignatureAuthorized()
                {
                    return api.Sale(new BigInteger("10000"), Currency.GBP);
                    // amount X00XX where X represents an integer [0;9] --> Signature authorized
                }
        
                public bool PayWithSignatureDeclined()
                {
                    return api.Sale(new BigInteger("10100"), Currency.GBP);
                    // amount X01XX where X represents an integer [0;9] --> Signature declined
                }
        
                public bool PayWithPinAuthorized()
                {
                    return api.Sale(new BigInteger("11000"), Currency.GBP);
                    // amount X10XX where X represents an integer [0;9] --> PIN authorized
                }
                public bool PayWithPinDeclined()
                {
                    return api.Sale(new BigInteger("11100"), Currency.GBP);
                    // amount X11XX where X represents an integer [0;9] --> PIN declined
                }
        
                public void SignatureRequired(SignatureRequest signatureRequest, Device device)
                {
                    // You'll be notified here if a sale process needs a signature verification
                    // A signature verification is needed if the cardholder uses an MSR or a chip & signature card
                    // This method will not be invoked if a transaction is made with a Chip & PIN card
        
        
                    api.SignatureResult(true); // This line means that the cardholder ALWAYS accepts to sign the receipt.
                    // A specific line will be displayed on the merchant receipt for the cardholder to be able to sign it
                }
        
                public void EndOfTransaction(TransactionResult transactionResult, Device device)
                {
                    UIClass.DisplayReceipts(transactionResult.MerchantReceipt, transactionResult.CustomerReceipt);
                }
            }
        }
                        
  3. Form1.cs :
  4. 
        using System;
        using System.Collections.Generic;
        using System.ComponentModel;
        using System.Data;
        using System.Drawing;
        using System.Linq;
        using System.Text;
        using System.Windows.Forms;
        namespace GettingStartedWithSimulator
        {
            public partial class Form1 : Form
            {
                MyClass my;
                public Form1()
                {
                    InitializeComponent();
                    my = new MyClass(this);
                }
                private void ConnectToSimulator_Click(object sender, EventArgs e)
                {
                    my.Connect();
                }
                private void PayWithSignatureAuthorized_Click(object sender, EventArgs e)
                {
                    my.PayWithSignatureAuthorized();
                }
                private void PayWithSignatureDeclined_Click(object sender, EventArgs e)
                {
                    my.PayWithSignatureDeclined();
                }
                private void PayWithPinAuthorized_Click(object sender, EventArgs e)
                {
                    my.PayWithPinAuthorized();
                }
                private void PayWithPinDeclined_Click(object sender, EventArgs e)
                {
                    my.PayWithPinDeclined();
                }
        
                public delegate void UpdateReceiptsCallback(string MerchantReceipt, string CustomerReceipt);
                public void DisplayReceipts(string MerchantReceipt, string CustomerReceipt)
                {
                    //Only need to check for one of the webbrowsers
                    if (MerchantReceiptBrowser.InvokeRequired)
                    {
                        UpdateReceiptsCallback d = new UpdateReceiptsCallback(DisplayReceipts);
                        this.Invoke(d, new object[] { MerchantReceipt, CustomerReceipt });
                    }
                    else
                    {
                        MerchantReceiptBrowser.DocumentText = MerchantReceipt;
                        CardholderReceiptBrowser.DocumentText = CustomerReceipt;
                    }
                }
            }
        }
                        

Let's run our program!

Run the program by clicking the "play" button, click on "Connect to simulator" and then Click on one of the payment types available and have a look at the receipts! Voila!

Getting started with a card reader

Introduction

This tutorial is guiding you through all the steps to create a basic payment application for Android devices using a development card reader.

The new generation of Handpoint SDK's is designed to make your life easier. Simple and created for humans, it does not require any specific knowledge of the payment industry to be able to start accepting credit/debit card transactions.

At Handpoint we take care of securing every transaction so you don´t have to worry about it while creating your application. We encrypt data from the payment terminal to the bank with our point-to-point encryption solution. Our platform is always up to the latest PCI-DSS security requirements. We undergo an audit on a yearly basis to be able to maintain the license to handle, process, store and transmit card data.

Let's start programming!

  1. Create a C# class
  2. Create a new C# class called MyClass and include com.handpoint.api as a dependency :

    
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using com.handpoint.api;
    
    namespace WindowsGettingStartedApp
    {
    class MyClass
    {
    }
    }
                
  3. Initialize the API
  4. 
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using com.handpoint.api;
    
    namespace WindowsGettingStartedApp
    {
    class MyClass
    {
        Hapi api;
    
        public MyClass()
        {
            InitApi();
        }
    
        public void InitApi()
        {
            string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
            api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
            // The api is now initialized. Yay! we've even set a default shared secret!
            // The shared secret is a unique string shared between the card reader and your mobile application.
            // It prevents other people to connect to your card reader.
            // You should replace this default shared secret by the one sent by our support team.
        }
    }
    }
                
  5. Implement the mandatory Events(Events.Required)
  6. 
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using com.handpoint.api;
    
    namespace WindowsGettingStartedApp
    {
    class MyClass : Events.Required
    {
        Hapi api;
        Device device;
    
        public MyClass()
        {
            InitApi();
        }
    
        public void InitApi()
        {
            string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
            api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
            // The api is now initialized. Yay! we've even set a default shared secret!
            // The shared secret is a unique string shared between the card reader and your mobile application.
            // It prevents other people to connect to your card reader.
            // You should replace this default shared secret by the one sent by our support team.
        }
    
        public void DeviceDiscoveryFinished(List<Device> devices)
        {
          // here you get a list of Bluetooth payment terminals paired with your computer
          // You can also get a list of serial / USB payment terminals attached to your computer
    
        }
    
        public void SignatureRequired(SignatureRequest signatureRequest, Device device)
        {
            // You'll be notified here if a sale process needs a signature verification
            // A signature verification is needed if the cardholder uses an MSR or a chip & signature card
            // This method will not be invoked if a transaction is made with a Chip & PIN card
    
            api.SignatureResult(true); // This line means that the cardholder ALWAYS accepts to sign the receipt.
            // A specific line will be displayed on the merchant receipt for the cardholder to be able to sign it
        }
    
        public void EndOfTransaction(TransactionResult transactionResult, Device device)
        {
            // The object TransactionResult holds the different receipts
            // Other information can be accessed through this object like the transaction ID, the amount...
        }
    }
    }
                
  7. Add a method to discover surrounding devices and connect to the card reader
  8. Ensure that the card reader and PC are correctly paired via bluetooth.

    
    public void DiscoverDevices()
    {
    api.ListDevices(ConnectionMethod.BLUETOOTH);
    // This triggers the search for all the bluetooth devices around.
    // You can also search for USB and Serial as a connection method
    }
    
    public void DeviceDiscoveryFinished(List<Device> devices)
    {
    foreach (Device device in devices)
    {
        if (device.Name != null)
        {
            if (device.Name.Equals("PP0513901435"))
            // Put the name of your device, find it by doing C then up arrow on your card reader keypad
            {
                this.device = device;
                //We'll remember the device for this session, it is nice if you would do that too
                api.UseDevice(this.device);
                //Connection to the device is handled automatically in the API
            }
        }
    }
    }
                
  9. Add a method to connect directly to the card reader
  10. Instead of discovering the surrounding devices you can also directly connect to the card reader by implementing the following method:

    
    public void DirectConnect()
    {
        Device device = new Device("PP0513901435", "68:AA:D2:00:D5:27", "", ConnectionMethod.BLUETOOTH);
        //new Device("name", "address", "port", ConnectionMethod);
        //The address always has to be written in UPPER CASE
        api.UseDevice(device);
    }
                
  11. Add a method to take payments
  12. 
    public bool Pay()
        {
            return api.Sale(new BigInteger("1000"), Currency.GBP);
            // Let´s start our first payment of 10 pounds
        }
                
  13. Add a method to disconnect from the card reader
  14. 
    public void Disconnect()
    {
    api.Disconnect();
    }
                
  15. Eventually, MyClass.cs must look like this after implementing all the necessary methods :
  16. 
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using com.handpoint.api;
    
    namespace WindowsGettingStartedApp
    {
    class MyClass : Events.Required
    {
        Hapi api;
        Device device;
    
        public MyClass()
        {
            InitApi();
        }
    
        public void InitApi()
        {
            string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
            api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
            // The api is now initialized. Yay! we've even set a default shared secret!
            // The shared secret is a unique string shared between the card reader and your mobile application.
            // It prevents other people to connect to your card reader.
            // You should replace this default shared secret by the one sent by our support team.
        }
    
        public void DiscoverDevices()
        {
            api.ListDevices(ConnectionMethod.BLUETOOTH);
            // This triggers the search for all the bluetooth devices around.
            // You can also search for USB and Serial as a connection method
        }
    
        public void DeviceDiscoveryFinished(List<Device> devices)
        {
            foreach (Device device in devices)
            {
                if (device.Name != null)
                {
                    if (device.Name.Equals("PP0513901435"))
                    // Put the name of your device, find it by doing C then up arrow on your card reader keypad
                    {
                        this.device = device;
                        //We'll remember the device for this session, it is nice if you would do that too
                        api.UseDevice(this.device);
                        //Connection to the device is handled automatically in the API
                    }
                }
            }
        }
    
        // You can also connect directly to a specific device without having to discover the other devices around :
        public void DirectConnect()
        {
            Device device = new Device("PP0513901435", "68:AA:D2:00:D5:27", "", ConnectionMethod.BLUETOOTH);
            //The MAC Adress always has to be written in UPPER CASE
            //new Device("name", "address", "port", ConnectionMethod);
            api.UseDevice(device);
        }
    
        public bool Pay()
        {
            return api.Sale(new BigInteger("1000"), Currency.GBP);
            // Let´s start our first payment of 10 pounds
        }
    
        public void SignatureRequired(SignatureRequest signatureRequest, Device device)
        {
            // You'll be notified here if a sale process needs a signature verification
            // A signature verification is needed if the cardholder uses an MSR or a chip & signature card
            // This method will not be invoked if a transaction is made with a Chip & PIN card
    
            api.SignatureResult(true); // This line means that the cardholder ALWAYS accepts to sign the receipt.
            // A specific line will be displayed on the merchant receipt for the cardholder to be able to sign it
        }
    
        public void EndOfTransaction(TransactionResult transactionResult, Device device)
        {
            // The object TransactionResult holds the different receipts
            // Other information can be accessed through this object like the transaction ID, the amount...
        }
    
        public void Disconnect()
        {
            api.Disconnect();
        }
    }
    }
                

Let's create a User Interface!

  1. Create buttons
    • Go to your user interface (usually Form1.cs[Design])
    • Select View > Toolbox
    • In the toolbox, under “Common Controls” drag and drop 3 button items to the user interface
    • Select "button1" > Right-Click > Properties
    • Change the attribute "Name" from "button1" to "PayButton"
    • Change the attribute "text" from "button1" to "Pay Now"
    • Change the attribute "Name" from "button2" to "ConnectButton"
    • Change the attribute "text" from "button2" to "Connect To Card reader"
    • Change the attribute "Name" from "button3" to "DisconnectButton"
    • Change the attribute "text" from "button3" to "Disconnect From Card Reader"

  2. Create WebBrowsers
  3. Now that we have our 3 buttons, let´s create two webBrowsers items to display the merchant receipt as well as the cardholder´s receipt at the end of the transaction.

    • Select View > Toolbox > Common Controls > WebBrowser
    • Drag and drop two web browsers to the user interface
    • Select View > Toolbox > Common Controls > Label
    • Drag and drop two labels to the user interface in order to identify the webBrowser items
    • Change the attribute "Name" from the left webBrowser to "MerchantReceiptBrowser"
    • Change the attribute "Name" from the right webBrowser to "CardholderReceiptBrowser"
    • Change the attribute "Name" from "label1" to "MerchantReceiptLabel"
    • Change the attribute "text" from "label1" to "Merchant Receipt :"
    • Change the attribute "Name" from "label2" to "CardholderReceiptLabel"
    • Change the attribute "text" from "label2" to "Cardholder Receipt :"

Let's link our user interface with methods!

  1. Referencing the user interface(Form1.cs) in MyClass
  2. In MyClass.cs, create an instance of Form1 called UIClass and initialize it. Instantiate MyClass and add form1 as a parameter for the Class.

    
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using com.handpoint.api;
    
    namespace WindowsGettingStartedApp
    {
    class MyClass : Events.Required
    {
        Hapi api;
        Device device;
        private Form1 UIClass;
        public MyClass(Form1 form1)
        {
            InitApi();
            UIClass = form1;
        }
                
  3. Referencing Myclass in Form1.cs and link methods to the user interface
  4. Go to Form1.cs[Design] and double click on the button "Pay Now". By Double Clicking on it you created a method called PayButton_Click. Create a new instance of MyClass called "my" in Form1.cs then, inside the new method PayButton_Click call the Pay() method from MyClass.

    
    using System;
    using System.Collections.Generic;
    using System.ComponentModel;
    using System.Data;
    using System.Drawing;
    using System.Linq;
    using System.Text;
    using System.Windows.Forms;
    namespace WindowsGettingStartedApp
    {
    public partial class Form1 : Form
    {
        MyClass my;
        public Form1()
        {
            InitializeComponent();
            my = new MyClass(this);
        }
        private void PayButton_Click(object sender, EventArgs e)
        {
            my.Pay();
        }
    }
    }
                

    Go back to Form1.cs[Design] and double click on each of the other buttons to automatically generate an OnClick method in Form1.cs. Link each of the buttons to the correct methods in MyClass.cs.

    
    using System;
    using System.Collections.Generic;
    using System.ComponentModel;
    using System.Data;
    using System.Drawing;
    using System.Linq;
    using System.Text;
    using System.Windows.Forms;
    namespace WindowsGettingStartedApp
    {
    public partial class Form1 : Form
    {
        MyClass my;
        public Form1()
        {
            InitializeComponent();
            my = new MyClass(this);
        }
        private void PayButton_Click(object sender, EventArgs e)
        {
            my.Pay();
        }
        private void ConnectButton_Click(object sender, EventArgs e)
        {
            my.DiscoverDevices();
            //my.DirectConnect();
        }
        private void DisconnectButton_Click(object sender, EventArgs e)
        {
            my.Disconnect();
        }
    }
    }
                

Let´s display the receipts at the end of a transaction!

  1. Fetch the cardholder's and merchant receipts from the method EndOfTransaction in MyClass
  2. At this point all the buttons are connected but we are still missing to display the receipts in the webBrowsers. First, let´s get the receipts from the method EndOfTransaction in myClass.cs.

    
    public void EndOfTransaction(TransactionResult transactionResult, Device device)
        {
            UIClass.DisplayReceipts(transactionResult.MerchantReceipt, transactionResult.CustomerReceipt);
        }
                
  3. Create the DisplayReceipts method in form1.cs
  4. 
    public delegate void UpdateReceiptsCallback(string MerchantReceipt, string CustomerReceipt);
    public void DisplayReceipts(string MerchantReceipt, string CustomerReceipt)
    {
    //Only need to check for one of the webbrowsers
    if (MerchantReceiptBrowser.InvokeRequired)
    {
        UpdateReceiptsCallback d = new UpdateReceiptsCallback(DisplayReceipts);
        this.Invoke(d, new object[] { MerchantReceipt, CustomerReceipt });
    }
    else
    {
        MerchantReceiptBrowser.DocumentText = MerchantReceipt;
        CardholderReceiptBrowser.DocumentText = CustomerReceipt;
    }
    }
                

Final Result!

Here is how MyClass.cs and Form1.cs must eventually look like :

  1. MyClass.cs :
  2. 
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using com.handpoint.api;
    namespace WindowsGettingStartedApp
    {
    class MyClass : Events.Required
    {
        Hapi api;
        Device device;
        private Form1 UIClass;
        public MyClass(Form1 form1)
        {
            InitApi();
            UIClass = form1;
        }
        public void InitApi()
        {
            string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
            api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
            // The api is now initialized. Yay! we've even set a default shared secret!
            // The shared secret is a unique string shared between the card reader and your mobile application.
            // It prevents other people to connect to your card reader.
            // You should replace this default shared secret by the one sent by our support team.
        }
        public void DiscoverDevices()
        {
            api.ListDevices(ConnectionMethod.BLUETOOTH);
            // This triggers the search for all the bluetooth devices around.
            // You can also search for USB and Serial as a connection method
        }
        public void DeviceDiscoveryFinished(List<Device> devices)
        {
            foreach (Device device in devices)
            {
                if (device.Name != null)
                {
                    if (device.Name.Equals("PP0513901435"))
                    // Put the name of your device, find it by doing C then up arrow on your card reader keypad
                    {
                        this.device = device;
                        //We'll remember the device for this session, it is nice if you would do that too
                        api.UseDevice(this.device);
                        //Connection to the device is handled automatically in the API
                    }
                }
            }
        }
        // You can also connect directly to a specific device without having to discover the other devices around :
        public void DirectConnect()
        {
            Device device = new Device("PP0513901435", "68:AA:D2:00:D5:27", "", ConnectionMethod.BLUETOOTH);
            //The MAC Adress always has to be written in UPPER CASE
            //new Device("name", "address", "port", ConnectionMethod);
            api.UseDevice(device);
        }
        public bool Pay()
        {
            return api.Sale(new BigInteger("1000"), Currency.GBP);
            // Let´s start our first payment of 10 pounds
        }
        public void SignatureRequired(SignatureRequest signatureRequest, Device device)
        {
            // You'll be notified here if a sale process needs a signature verification
            // A signature verification is needed if the cardholder uses an MSR or a chip & signature card
            // This method will not be invoked if a transaction is made with a Chip & PIN card
            api.SignatureResult(true); // This line means that the cardholder ALWAYS accepts to sign the receipt.
            // A specific line will be displayed on the merchant receipt for the cardholder to be able to sign it
        }
        public void EndOfTransaction(TransactionResult transactionResult, Device device)
        {
            UIClass.DisplayReceipts(transactionResult.MerchantReceipt, transactionResult.CustomerReceipt);
        }
        public void Disconnect()
        {
            api.Disconnect();
        }
    }
    }
                
  3. Form1.cs :
  4. 
    using System;
    using System.Collections.Generic;
    using System.ComponentModel;
    using System.Data;
    using System.Drawing;
    using System.Linq;
    using System.Text;
    using System.Windows.Forms;
    namespace WindowsGettingStartedApp
    {
    public partial class Form1 : Form
    {
        MyClass my;
        public Form1()
        {
            InitializeComponent();
            my = new MyClass(this);
        }
        private void PayButton_Click(object sender, EventArgs e)
        {
            my.Pay();
        }
        private void ConnectButton_Click(object sender, EventArgs e)
        {
            my.DiscoverDevices();
            //my.DirectConnect();
        }
        private void DisconnectButton_Click(object sender, EventArgs e)
        {
            my.Disconnect();
        }
        public delegate void UpdateReceiptsCallback(string MerchantReceipt, string CustomerReceipt);
        public void DisplayReceipts(string MerchantReceipt, string CustomerReceipt)
        {
            //Only need to check for one of the webbrowsers
            if (MerchantReceiptBrowser.InvokeRequired)
            {
                UpdateReceiptsCallback d = new UpdateReceiptsCallback(DisplayReceipts);
                this.Invoke(d, new object[] { MerchantReceipt, CustomerReceipt });
            }
            else
            {
                MerchantReceiptBrowser.DocumentText = MerchantReceipt;
                CardholderReceiptBrowser.DocumentText = CustomerReceipt;
            }
        }
    }
    }
                

Let's run our program!

Run the program by clicking the "play" button :

  1. Click on "Connect To Card Reader", this can take a little bit of time (10 sec max) due to the fact that we are looking for all the devices around before connecting to a specific one
  2. Click "Pay Now"
  3. Follow the instructions on the card reader
  4. When the transaction is finished, the receipts should be displayed in the webBrowsers
  5. Click on "Disconnect From Card Reader" to stop the connection with the card reader

Transactions

Sale

method Available since 1.0.0

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.

Parameters

Parameter Notes
amount *
BigInteger
Amount of funds to charge - in the minor unit of currency (f.ex. 1000 is 10.00 GBP)
currency *
Currency
Currency of the charge
map
Map
A map including extra optional transaction parameters.


Events invoked

currentTransactionStatus
Invoked during a transaction, it fetches statuses coming from the card reader (ex : 'waiting for card' or 'waiting for PIN entry')
signatureRequired
Invoked if card verification requires signature.
endOfTransaction
Invoked when the card reader finishes processing the transaction

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Initiate a sale for 10.00 Pounds
api.Sale(new BigInteger(1000),Currency.GBP);

Reversal

method Available since 1.0.0

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.

Parameters

Parameter Notes
amount *
BigInteger
Amount of funds to charge - in the minor unit of currency (f.ex. 1000 is 10.00 GBP)
currency *
Currency
Currency of the charge
originalTransactionID *
String
As received from the card reader (EFTTransactionID)
map
Map
A map including extra optional transaction parameters.


Events invoked

currentTransactionStatus
Invoked during a transaction, it fetches statuses coming from the card reader (ex : 'waiting for card' or 'waiting for PIN entry')
signatureRequired
Invoked if card verification requires signature.
endOfTransaction
Invoked when the card reader finishes processing the transaction

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Initiate a reversal for 10.00 Pounds
api.SaleReversal(new BigInteger(1000),Currency.GBP,"1234567");

Refund

method Available since 1.0.0

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.

Parameters

Parameter Notes
amount *
BigInteger
Amount of funds to charge - in the minor unit of currency (f.ex. 1000 is 10.00 GBP)
currency *
Currency
Currency of the charge
map
Map
A map including extra optional transaction parameters.


Events invoked

currentTransactionStatus
Invoked during a transaction, it fetches statuses coming from the card reader (ex : 'waiting for card' or 'waiting for PIN entry')
signatureRequired
Invoked if card verification requires signature.
endOfTransaction
Invoked when the card reader finishes processing the transaction

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Initiate a refund for 10.00 in Great British Pounds
api.Refund(new BigInteger(1000),Currency.GBP);

Refund reversal

method Available since 1.0.0

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.

Parameters

Parameter Notes
amount *
BigInteger
Amount of funds to charge - in the minor unit of currency (f.ex. 1000 is 10.00 GBP)
currency *
Currency
Currency of the charge
originalTransactionID *
String
As received from the card reader (EFTTransactionID)
map
Map
A map including extra optional transaction parameters.


Events invoked

currentTransactionStatus
Invoked during a transaction, it fetches statuses coming from the card reader (ex : 'waiting for card' or 'waiting for PIN entry')
signatureRequired
Invoked if card verification requires signature.
endOfTransaction
Invoked when the card reader finishes processing the transaction

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Initiate a refund reversal for 10.00 in Great British Pounds
api.RefundReversal(new BigInteger(1000),Currency.GBP,"1234567");

Signature result

method Available since 1.0.0

SignatureResult

A signatureRequest 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.

Parameters

Parameter Notes
accepted *
Boolean
pass true if merchant accepts customer signature


Events invoked

currentTransactionStatus
Invoked during a transaction, it fetches statuses coming from the card reader (ex : 'waiting for card' or 'waiting for PIN entry')
endOfTransaction
Invoked when the card reader finishes processing the transaction

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Receiving a SignatureRequest from the SDK.
public void SignatureRequired(SignatureRequest signatureRequest, Device device)
{
    //If you accept the signature
    api.SignatureResult(true);
}

Cancel transaction

method Available since 1.0.0

CancelRequest

This method attempts to cancel the current transaction on the card reader. Note that operations cannot be cancelled at certain points during the transaction process

Events invoked

currentTransactionStatus
Invoked during a transaction, it fetches statuses coming from the card reader (ex : 'waiting for card' or 'waiting for PIN entry')
endOfTransaction
Invoked when the card reader finishes processing the transaction

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Attempts to cancel an operation
api.CancelRequest();

Device management

Connect

method Available since 1.0.0

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.

Parameters

Parameter Notes
device *
Device
This parameter specifies to the system which device you want to use for the operations.


Events invoked

ConnectionStatusChanged
Each time the card reader state changes (ex : going from Connected to Disconnected) the ConnectionStatusChanged event is called. It causes the connection manager to invoke this event with the appropriate information.

Returns

Boolean
true if the operation was successful.

Code example

//Connect to a device
Device device = new Device("CardReader7", "08:00:69:02:01:FC", "1", ConnectionMethod.BLUETOOTH);

api.UseDevice(device);

Disconnect

method Available since 1.0.0

Disconnect

Disconnects from default device.

Events invoked

ConnectionStatusChanged
Causes the connection manager to invoke this event with the appropriate information.

Returns

Boolean
true if the operation was successful.

Code example

//Disconnect from current device
api.Disconnect();

Set shared secret

method Available since 1.0.0

SetSharedSecret

Validates the app for this session, thus enabling financial transactions

Parameters

Parameter Notes
sharedSecret *
String
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


Events invoked

None
No events invoked.

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Sets the shared secret using the test key
api.SetSharedSecret("0102030405060708091011121314151617181920212223242526272829303132");

Set parameter

method Available since 1.0.0

SetParameter

Changes values of certain parameters on the card reader.

Parameters

Parameter Notes
param *
DeviceParameter
The name of the parameter to change
value *
String
New value of the parameter


Events invoked

None
No events are invoked.

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Changes the bluetooth name of card reader
api.SetParameter(DeviceParameter.BluetoothName, "OrangeCardReader");

Set logging level

method Available since 1.1.2

SetLogLevel

Sets the log level of the hapi for both the device and the API.

Parameters

Parameter Notes
level *
LogLevel
The desired log level. Can be LogLevel.None, LogLevel.Info, LogLevel.Full, LogLevel.Debug


Events invoked

None
No events are invoked.

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Sets the log level to info
api.SetLogLevel(LogLevel.info);

Request device logs

method Available since 1.0.0

GetDeviceLogs

Fetches the logs from the device and reports them to the DeviceLogsReady event.

Events invoked

deviceLogsReady
Invoked when hapi has finished downloading logs from the card reader.

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Downloads logs from device
api.GetDeviceLogs();

Update device

method Available since 1.0.0

Update

The update operation checks for update to the card reader and initiates an update if needed.

Events invoked

None
Information about this process should be available at the device's screen.

Returns

Boolean
true if the operation was successfully sent to device

Code example

//Check for card reader update
api.Update();

List Devices (search)

method Available since 1.0.0

ListDevices

Starts the search for devices to connect with the specified ConnectionMethod

Parameters

Parameter Notes
method *
ConnectionMethod
The means of connection you intend to use to talk to the device. (Bluetooth, Serial, USB, etc...)


Events invoked

deviceDiscoveryFinished
Invoked after the search is finished returning a list of the devices finished.

Code example

//Search for Bluetooth devices
api.ListDevices(ConnectionMethod.BLUETOOTH);

Events subscribers

Add Required Event Handler

method Available since 1.0.0

AddRequiredEventHandler

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.

Parameters

Parameter Notes
listener *
Required
An implementation of the Events.Required interface


Returns

Boolean
true if the new listener was added successfully

Code example

//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);
}

Add Status Notification Event Handler

method Available since 1.0.0

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.

Parameters

Parameter Notes
listener *
Status
An implementation of the Events.Status interface


Returns

Boolean
true if the new listener was added successfully

Code example

//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);
}

Add Log Event Handler

method Available since 1.0.0

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.

Parameters

Parameter Notes
listener *
Log
An implementation of the Events.Log interface


Returns

Boolean
true if the new listener was added successfully

Code example

//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);
}

Remove Required Event Handler

method Available since 1.0.0

RemoveRequiredEventHandler

Removes a listener so information is not passed on to that listener any more.

Parameters

Parameter Notes
listener *
Required
The listener to be removed


Returns

Boolean
true if the listener was removed successfully

Code example

//Remove a listener for required events
this.api.RemoveRequiredEventHandler(this);

Remove Status Notification Event Handler

method Available since 1.0.0

RemoveStatusNotificationEventHandler

Removes a listener so information is not passed on to that listener any more.

Parameters

Parameter Notes
listener *
Status
The listener to be removed


Returns

Boolean
true if the listener was removed successfully

Code example

//Remove a listener for status notification events
this.api.RemoveStatusNotificationEventHandler(this);

Remove Log Event Handler

method Available since 1.0.0

RemoveLogEventHandler

Removes a listener so information is not passed on to that listener any more.

Parameters

Parameter Notes
listener *
Log
The listener to be removed


Returns

Boolean
true if the listener was removed successfully

Code example

//Remove a listener for log events
this.api.RemoveLogEventHandler(this);

Events

Device discovery finished

method Available since 1.0.0

DeviceDiscoveryFinished

deviceDiscoveryFinished event gets called when a device discovery has finished and returns a list of devices.

Parameters

Parameter Notes
device *
Device
The device that is invoking the event


Subscribers Needed

AddRequiredEventHandler
This listener has to be implemented (preferably during initialisation) in order to retrieve the devices information.

Code example

//Receiving a list of connectable devices
List<Device> myListOfDevices = new List<Device>();
public void DeviceDiscoveryFinished(List<Device> devices)
{
    foreach(Device device in devices)
    {
        myListOfDevices.Add(device);
    }
}

Signature required

method Available since 1.0.0

SignatureRequired

signatureRequired event gets called when a card requires a signature instead of PIN entry and has two parameters, request and device.

Parameters

Parameter Notes
request *
SignatureRequest
Holds the signature request
device *
Device
The device that is invoking the event


Subscribers Needed

AddRequiredEventHandler
This listener has to be implemented (preferably during initialisation) in order to retrieve signature information.

Code example

//Receiving a SignatureRequest from the SDK.
public void SignatureRequired(SignatureRequest signatureRequest, Device device)
{
    //You might want to print out the receipt or ask the customer to sign the receipt on your device
    DisplayReceiptInUI(signatureRequest.MerchantReceipt)
    //If you accept the signature
    api.SignatureResult(true);
}

End of transaction

method Available since 1.0.0

EndOfTransaction

EndOfTransaction event gets called at the end of each transaction and has two parameters, result and device.

Parameters

Parameter Notes
result *
TransactionResult
Holds the results for the transaction
device *
Device
The device that is invoking the event


Subscribers Needed

AddRequiredEventHandler
This listener has to be implemented (preferably during initialisation) in order to retrieve transaction information.

Code example

//Receiving a TransactionResult from the SDK.
public void EndOfTransaction(TransactionResult transactionResult, Device device)
{
    //You might want to display this information in the UI
    postTransactionResultToUI(transactionResult);
}

Connection status changed

method Available since 1.0.0

ConnectionStatusChanged

ConnectionStatusChanged event gets called when the state of a card reader connection changes.

Parameters

Parameter Notes
status *
ConnectionStatus
An enum containing the status code for the connection
device *
Device
The device that is invoking the event


Subscribers Needed

AddStatusNotificationEventHandler
This listener has to be implemented (preferably during initialisation) in order to retrieve the different connection statuses (e.g : CONNECTED, DISCONNECTED...).

Code example

//Receiving a new ConnectionStatus from the SDK
public void ConnectionStatusChanged(ConnectionStatus connectionStatus, Device device)
{
    //You might want to display this information in the UI
    postNewStatusToUI(connectionStatus);
}

Current transaction status

method Available since 1.0.0

CurrentTransactionStatus

currentTransactionStatus event gets called when the state of an ongoing transaction changes.

Parameters

Parameter Notes
statusInfo *
StatusInfo
An object containing information about the current transaction
device *
Device
The device that is invoking the event


Subscribers Needed

AddStatusNotificationEventHandler
This listener has to be implemented (preferably during initialisation) in order to retrieve the different states from the card reader (e.g : Waiting for card, Waiting for PIN entry...).

Code example

//Receiving a transaction status from the SDK.
public void currentTransactionStatus(StatusInfo statusInfo, Device device)
{
    //You might want to display some of this information in the UI
    DisplayTransactionStatusInUI(statusInfo)
}

Message logged

method Available since 1.0.0

OnMessageLogged

OnMessageLogged event gets called for all log messages that are being logged. This is only intended for debugging.

Parameters

Parameter Notes
logLevel *
LogLevel
An enum containing the log level
message *
String
A String containing the current log message


Subscribers Needed

AddLogEventHandler
This listener has to be implemented (preferably during initialisation) in order to retrieve the different log messages.

Code example

//Receiving a log from the SDK
public void OnMessageLogged(LogLevel logLevel, String message)
{
    //You do not want to display this information in the UI
    Debug.WriteLine(message);
}

Logs ready

method Available since 1.0.0

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.

Parameters

Parameter Notes
logs *
String
String containing the current log
device *
Device
The device that is invoking the event


Subscribers Needed

AddLogEventHandler
This listener has to be implemented (preferably during initialisation) in order to retrieve the card reader logs.

Code example

//Receiving a log from the device
public void DeviceLogsReady(string logs, Device device)
{
    //You might want to save this information
    WriteLogsToDisk(logs);
}

Objects

Transaction Type

enum Available since 1.0.0

TransactionType

An enum representing different types of transactions.

Possible values

UNDEFINED SALE VOID_SALE REFUND VOID_REFUND CANCEL_SALE CANCEL_REFUND

Transaction Result

object Available since 1.0.0 Deprecated since 1.1.3

Warning!

This object has been marked as deprecated. We strongly discourage you to use it.



TransactionResult

A class holding information about a transaction result.

Properties

Property Description
StatusMessage
String
Gets the statusMessage from the TransactionResult
Type
TransactionType
Gets the transaction type from the TransactionResult
FinStatus
FinancialStatus
Gets the financial status from the TransactionResult
RequestedAmount
BigInteger
Gets the requested amount from the TransactionResult
GratuityAmount
BigInteger
Gets the gratuity amount from the TransactionResult
GratuityPercentage
double
Gets the gratuity percentage from the TransactionResult
TotalAmount
BigInteger
Gets the total amount from the TransactionResult
Currency
Currency
Gets the currency from the TransactionResult
TransactionID
String
Gets the device transaction id from the TransactionResult
eFTTransactionID
String
Gets the device transaction id from the TransactionResult
OriginalEFTTransactionID
String
Gets the original EFT transaction id from the TransactionResult
eFTTimestamp
Date
Gets the time stamp from the TransactionResult
AuthorisationCode
String
Gets the authorisation code from the TransactionResult
VerificationMethod
VerificationMethod
Gets the verification method from the TransactionResult
CardEntryType
CardEntryType
Gets the card entry type from the TransactionResult
CardSchemeName
String
Gets the card scheme name from the TransactionResult
ErrorMessage
String
Gets the error message from the TransactionResult
CustomerReference
String
Gets the customer reference from the TransactionResult
BudgetNumber
String
Gets the budget number from the TransactionResult
MerchantReceipt
String
Gets the merchant receipt from the TransactionResult
CustomerReceipt
String
Gets the customer receipt from the TransactionResult
DeviceStatus
DeviceStatus
Gets the device status from the TransactionResult

Handpoint API (Hapi) factory

object Available since 1.0.0

HapiFactory

A factory to provide a unified entrypoint and to simplify the way to instantiate the Hapi object.

Methods

Static factory

getAsyncInterface( Events.Required requiredListener );

Parameter Notes
requiredListener *
Events.Required
A listener object to report the required events.

Code example

public void InitApi()
{
	string sharedSecret = "0102030405060708091011121314151617181920212223242526272829303132";
	api = HapiFactory.GetAsyncInterface(this).DefaultSharedSecret(sharedSecret);
	//The api is now initialized. Yay! we've even set a default shared secret!
}

Connection Method

enum Available since 1.1.2

ConnectionMethod

An enum representing different types of connection methods.

BLUETOOTH and SIMULATOR are supported for Windows.

Possible values

USB SERIAL BLUETOOTH HTTPS WIFI ETHERNET SIMULATOR

Code example

//Currently BLUETOOTH, and SIMULATOR are the only ConnectionMethod available.
public enum ConnectionMethod 
{
	USB,
	SERIAL,
	HTTPS,
	WIFI,
	ETHERNET,
	BLUETOOTH,
	SIMULATOR
}

Device

object Available since 1.0.0

Device

An object to store the information about the device we're working with.

Methods

Constructor

Device( String name , String address , String port , ConnectionMethod connectionMethod , String sharedSecret , int timeout );

Parameter Notes
name *
String
A name to identify the device
address *
String
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
The port to connect to.
connectionMethod *
ConnectionMethod
Enumerated type to specify the type of connection with the device. E.g: Bluetooth, Serial, etc...
sharedSecret
String
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
The amount of miliseconds to consider the connection has timed out. If not set, the default timeout is 15 seconds.

Properties

Property Description
Id
String
An unique identifier of the device.

Code example

//Create and init a new Device
Device dev = new Device("CardReader7", "08:00:69:02:01:FC", "1", ConnectionMethod.BLUETOOTH);

Connection Status

enum Available since 1.1.2

ConnectionStatus

A list of statuses given to a connection

Possible values

Connected Connecting Disconnected Disconnecting Initializing NotConfigured

Signature Request

object Available since 1.1.2

SignatureRequest

A class containing information about a signature request/signature verification.

Properties

Property Description
Timeout
int
int the value of the timeout in seconds.
MerchantReceipt
String
String the merchant receipt as html.

Currency

enum Available since 1.0.0

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.

Possible values

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

Device Parameter

enum Available since 1.0.0

DeviceParameter

An enum describing all the available commands to send to a device.

When used a legal value is expected with the command

Possible values

BluetoothName BluetoothPass SystemTimeout ScreenTimeout SignatureTimeout

Device Status

object Available since 1.1.2

DeviceStatus

A class that holds the device status.

Properties

Property Description
SerialNumber
String
Gets the serial number of the device
BatteryStatus
String
Gets the battery status in percentages of a device
BatterymV
String
Gets the battery milli volts of a device
BatteryCharging
String
Gets the battery charging status of a device
ExternalPower
String
Gets the status of an external power of a device
ApplicationName
String
Gets the application name used on a device
ApplicationVersion
String
Gets the application version number used on a device

Financial Status

enum Available since 1.0.0

FinancialStatus

An enum representing different statuses of a finalized transaction

Possible values

UNDEFINED AUTHORISED DECLINED PROCESSED FAILED CANCELLED

Status Info

object Available since 1.0.0

statusInfo

A class containing information about the status of the transaction.

Properties

Property Description
CancelAllowed
bool
A bool representing if the card reader will accept a cancel request.
status
Status
A Status enum representing the status of the transaction.
message
string
A String containing the status message of the transaction.
DeviceStatus
DeviceStatus
A DeviceStatus object containing information about the device.

Log Level

enum Available since 1.0.0

LogLevel

An enum describing the different levels of logging used in the hapi and used in the device.

Possible values

None Info Full Debug

Optional Transaction Parameters

object Available since 1.0.0

OptionalParameters

A class containing optional transaction parameters now supported by the device.

Properties

Property Description
Budget
String
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 String of 2 digits representing the number of months to split the transaction to. Example: "03" or "24"

CustomerReference
String
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 String of a maximum 25 characters and received back when the transaction has been processed. Example: "C.nr. 212311"

Verification Method

enum Available since 1.0.0

VerificationMethod

An enum representing different verification methods used in the transaction.

Possible values

UNDEFINED SIGNATURE PIN PIN_SIGNATURE FAILED NOT_REQUIRED

Status

enum Available since 1.0.0

status

An enum containing information about the status of the transaction.

Possible values

UserCancelled WaitingForCard CardInserted ApplicationSelection ApplicationConfirmation AmountValidation PinInput ManualCardInput WaitingForCardRemoval TipInput AuthenticatingPos WaitingForSignature ConnectingToHost SendingToHost ReceivingFromHost DisconnectingFromHost PinInputComplete Undefined

Card Entry Type

enum Available since 1.0.0

CardEntryType

An enum representing different card entry types.

Possible values

UNDEFINED MSR ICC CNP