eConnect.PosSdk 4.0.1

eConnect PosSdk

.NET client for eConnect POS JsonApi.

Supported Platforms

• .NET 8.0 and above
• .NET Standard 2.0 (for .NET Framework 4.6.1+ compatibility)

Installation

dotnet add package eConnect.PosSdk

Quick Start

using eConnect.PosSdk;
using eConnect.PosSdk.ApiEvents;
using Microsoft.Extensions.Logging;

// Sample authentication parameters — production values provided by eConnect
var options = new PosClientOptions
{
    PluginId = "b510fb1f-124f-46dc-a7f3-cc9813755fa6",
    AuthId = Guid.NewGuid().ToString(),
    Host = "devcenter.econnect.tv",
    Port = 6500,
    UseSsl = true,                             // optional, defaults to true
    TcpTimeout = TimeSpan.FromMinutes(1),      // optional, defaults to 1 minute
    KeepAliveInterval = TimeSpan.FromMinutes(2) // optional, defaults to 2 minutes
    // set KeepAliveInterval = TimeSpan.Zero to disable keep-alive messages
};

// PosClient requires an ILogger instance (use NullLogger.Instance if logging is not needed)
await using var client = await PosClient.CreateAsync(options, logger);

var signIn = new SignInEvent
{
    RevenueCenterNumber = 1,
    TerminalNumber = 123,
    EmployeeNumber = 456
};

string response = await client.SendAsync(signIn);
// response == "Valid signin event object received"

Full Transaction Example

var newCheck = new NewCheckEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712
};
await client.SendAsync(newCheck);

var itemAdd = new ItemAddEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712,
    ItemId = "049000608779",
    ItemName = "Apple (Golden Delicious)",
    Quantity = 1,
    Amount = 0.99M
};
await client.SendAsync(itemAdd);

var totalDue = new TotalDueEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712,
    Amount = -.99M
};
await client.SendAsync(totalDue);

var tenderApply = new TenderApplyEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712,
    TenderTypeNumber = 5,
    TenderTypeName = "Cash",
    Amount = 1M
};
await client.SendAsync(tenderApply);

var changeDue = new ChangeDueEvent
{
    RevenueCenterNumber = 248,
    TerminalNumber = 1132,
    EmployeeNumber = 634277,
    CheckNumber = 237712,
    Amount = .01M
};
await client.SendAsync(changeDue);

var closeCheck = new CloseCheckEvent
{
    RevenueCenterNumber = 11291,
    TerminalNumber = 88332,
    EmployeeNumber = 634277,
    CheckNumber = 237712
};
await client.SendAsync(closeCheck);

Configuration Options

Error Handling

SendAsync throws specific exceptions you can handle:

try
{
    string response = await client.SendAsync(myEvent);
}
catch (PosMessageException ex)
{
    // Inspect ex.ValidationErrors for details, fix the message, and resend
}
catch (TimeoutException)
{
    // Retry the send, or dispose and create a new client
}
catch (Exception ex) when (ex is SocketException or IOException)
{
    // Connection lost — dispose and create a new client
    await client.DisposeAsync();
    client = await PosClient.CreateAsync(options, logger);
    // Retry the send
}

Testing

eConnect provides a TCP JSON API Test Service, showing sample credentials that work in combination with an online Testing Console.

Migrating from v3 to v4

Version 4.0 introduces a static factory pattern. The PosClient constructor is no longer public, and ConnectAsync() / TryConnectAsync() have been removed from IPosClient.

This ensures every IPosClient instance is always in a connected state when obtained.