ingenico-pos-dotnet-lib

.netstandard2.0 Class library for communication with Asseco Group Ingenico POS Device written in C#

Info

• Developed in Visual Studio 2019
• C# netstandard2.0
• Tested on Ingenico ict-220 Probably works on other models

Download

Donwloading the package from NuGet

You can download the IngenicoPOS Package form NuGet, which will automatically download all of the necessary dependencies, or you can install it with:

• Package Manager

  Install-Package IngenicoPOS -Version 1.0.1

• .NET CLI

  dotnet add package IngenicoPOS --version 1.0.1

• Paket CLI

  paket add IngenicoPOS --version 1.0.1

  or by adding PackageReference:

  <PackageReference Include="IngenicoPOS" Version="1.0.1" />

Manually downloading the assembly

1. Download the latest release IngenicoPOS.dll from IngenicoPOS Releases
2. Put the IngenicoPOS.dll to your project dependencies
3. Add the IngenicoPOS.dll as a project dependency

NOTE: Make sure the project also depends on System.IO.Ports

Usage

Import

To use the available classes, you will need to import them into the project (unless you really want to type IngenicoPOS. every single time):

using IngenicoPOS;

Connection

To Connect with the POS device, we will initialize POS class and connect to it

const string PORT = "COM9";  // Port of the POS Device (COM0 is just an example)

POS posDevice = new POS(PORT);
posDevice.Connect();  // Will return true if connection is made, otherwise will return false

// To check whether the posDevice is connected, we can do it with
if ( posDevice.IsConnected ) {
    // The device is connected
} else {
    // Nope :/
}

Sale

To charge a card, we can use the POS.Sale( Amount ):

const string PORT = "COM9";  // Port of the POS Device (COM0 is just an example)

POS posDevice = new POS(PORT);

if ( posDevice.Connect() ) {
    // We will charge the card for 100,00
    SaleResponse res = posDevice.Sale(10000);

    if ( res.Success ) {
        // Sale was successful :D
    } else{
        // Sale wasn't successful :(
    }
} else {
    // Device not connected :/
}

Development

1. Clone the repository with

   git clone https://github.com/F4pl0/ingenico-pos-dotnet-lib.git

2. Open in Visual Studio 2019 (To eliminate compatibility issues)
3. Get Dependent NuGet Packages (If they aren't already in the project)

Happy Development

Dependencies

• NuGet MSTest.TestAdapter Tests only
• NuGet MSTest.TestFramework Tests only
• NuGet System.IO.Ports Required for library

Tests

1. Test01Connection
   Tests the connectivity with the device on the PORT port.
2. Test02Sale
   Upon connecting, tests the POS.Sale( Int64 Amount ) Which returns SaleResponse.
   The main test is to check whether the SaleResponse.Success is true

Classes

NOTE: Only public variables/functions are listed

POS

This is the main class of the library.

Constructors

Variables

Functions

Consts

Class with constants prior to the communication.

Subclasses / Constant sets

Utils

Static Functions for the core functionality of the library.

Functions

ECRMessage

This class represents the message that is sent to the POS ( from ECR/PC.. )

Constructors

Variables

POSMessage

This class represents the message that POS device sends

Constructors

Variables

Functions

SaleResult

POS.Sale() returns this class as a result to the transaction.

Constructors

Variables