myPOS SDK .NET enabling to integrate Apps with myPOS Card Terminals for Card Payments processing
Branch: master
Clone or download
developermypos New version of myPOSTerminal.dll; Increased app version to 1.0.1.5; A…
…dded new functionalities;

Added Preauthorizations, MO/TO transactions, myPOS GiftCards support; Payment Requests; Send Log and Vending Purchase;
Latest commit 9451d62 Jan 23, 2019

README.md

myPOS-SDK-dotNET

This repository provides .Net C# SDK, which enables to integrate your Application with myPOS Card terminals, processed by its platform, to accept card payments (including but not limited to VISA, Mastercard, UnionPay International, JCB, Bancontact). myPOS SDK .Net communicates transparently to the card terminal(s) via USB cable. To process checkout SDK provides management of the terminal to complete all the steps for transaction processing, return or refund, and communicates to the application transaction status, card masked PAN.

No sensitive card data is ever passed through to or stored on the merchant's application. All data is encrypted by the card terminal, which has been fully certified to the highest industry standards (PCI, EMV I & II, Visa, MasterCard & Amex).

Prerequisites

  1. Merchant account on www.myPOS.eu (or received a test account).
  2. Received myPOS terminal
  3. Requested Access Developers myPOS site.
  4. .Net Framework version 4.5.2

Table of Contents

Integration

As example of integration, please use the sample app provided in this repository as a reference.

Dependency

In order to use myPOS Terminal .Net SDK, you need to have installed .Net Framework version 4.5.2 or above.

  1. In Solution Explorer in Visual Studio, select the project.
  2. On the Project menu, click Add Reference. The Add Reference dialog box opens.
  3. Browse to the downloaded ‘myPOSTerminal.dll’ and click the Select button.
  4. After confirming with OK, the selected reference ‘myPOS Terminal’ will appear under the References node of the project

Initialization

In order to use myPOS Terminal .Net SDK methods, you need to create an object of myPOSTerminal class:

using myPOS;
myPOSTerminal terminal = new myPOSTerminal();

You can set terminal language and receipt configuration mode here. If those are not set anywhere in the application, the POS device will use its default settings:

terminal.SetReceiptMode((ReceiptMode)cmbReceiptMode.SelectedItem);
terminal.SetLanguage(Language.English);

Connect to terminal

Each time the POS device is plugged, you have to specify the COM Port is uses and initiate a new connection:

terminal.Initialize((string)"COM3"); // This COM number is used as an example

Make transactions

Handle response result

There is an event that is raised when a response is received from the POS device on a particular request. You should subscribe to the event to get the response result and any response data that is received.

  1. Define an event handler method
       protected void ProcessResult(ProcessingResult r)
       {
	       // handle the response here
            if (r.TranData != null)
            {
		          // transaction response
            }
 		   }
       
  1. Attach your event handler to the event:
    public Form1()
    {
         InitializeComponent();
          
         terminal.ProcessingFinished += ProcessResult;
    }

Make a payment

Once initialization and connection to terminal is completed, you can start using the myPOS Terminal .Net SDK to accept card payments.

RequestResult r = terminal.Purchase(Amount, cur, txtReference.Text);

Transaction reference is optional parameter and can be empty or NULL.

Make a Refund

You can initiate refund transaction to the customer’s card account with the specified amount.

RequestResult r = terminal.Refund(Amount, cur, txtReference.Text);

Transaction reference is optional parameter and can be empty or NULL.

Reprint last receipt

With this method the host application could request reprint of the last transaction slip.

RequestResult r = terminal.ReprintReceipt();

Custom receipt print

You can print receipt with your custom data using the following delimiters:

\ - symbol
\n – new line \L – prints logo \l – left alignment \c - center alignment \r - right alignment \W – double width \w – normal width \H – double height \h – normal height

terminal.PrintExternal(txtPrintData.Text);

Terminal management

Activate

Before using terminal for a first time, the myPOS Terminal SDK has to initiate Terminal activation, which will setup terminal for processing transaction, setting up Terminal ID, Merchant ID etc.

RequestResult r = terminal.Activate();

Update terminal software

Each time terminal processing transactEach time terminal is processing transaction, the processor host checks for existing pending updates and inform terminal if any. With this method, the update procedure is started and the terminal is going in the update mode.

RequestResult r = terminal.Update();

Deactivate terminal

RequestResult r = terminal.Deactivate();