Arkos framework provides a standardized interface, compliant with Nexo Retail Protocol Specifications V3, and that enables an easy and scalable integration of payment services to any Sale Systems.
Getting Started
Message Structure
Transport Protocols
Services
Nexo Retail Protocol Spectifications version 3.0 are available on http://www.nexo-standards.org.
Message Structure
The management of the messages is specified in Section 3.4 Messages Managerment of Nexo Retailer protocol specifications.
All messages of the Nexo Retail protocol share a common structure:
The Message Envelope, which is a data container for the whole message. The envelope identifies the protocol and the position inside a message pair: the request or the response.
The Message Header, which contains information dedicated to the management of the Sale to POI protocol. All the messages of the protocol contain the same message header structure.
The Message Body, where the data related to the service are grouped. Each message has a different message body structure.
An optional Security Trailer, containing the protection of the whole message.
Message Header
The Message header is common to all messages.
Data Name | Description |
---|---|
ProtocolVersion | Version of the Sale to POI protocol specifications. |
MessageClass | Class of message dialogue. |
MessageCategory | Category of message. |
MessageType | Type of message of the Sale to POI protocol. |
ServiceID | Identification of a message pair, which processes a transaction. |
DeviceID | Identification of a device message pair. |
SaleID | Identification of a Sale System or a Sale Terminal. |
POIID | Identification of a POI System or a POI Terminal. |
Data Coding and Decoding
Arkos supports both XML/Schema and JSON data formats for coding/decoding messages.
Dialogue Management
Arkos supports:
Request/Response Message Exchange where the requestor sends a message request, the responder process the service requested, and sends a message response containing the result of the processing.
Request Only Message Exchange where the requestor sends a message request, the responder process the service requested, and do not send a message response at the end of the processing.
Unsolicited message notification.
Transport Protocols
Transport Protocols are specified in Section 3.3 Transport Protocols of Nexo Retailer protocol specifications.
The following transports protocols may be used:
TCP (Transmission Control Protocol) as described in Section 3.3.2 TCP Protocol,
HTTP (Hypertext Transfert Protocol) as described in Section 3.3.3 HTTP Protocol,
HTTPS (or HTTP over SSL/TLS) as described in Section 3.3.4 HTTPS Protocol,
Sale to POI Protocol over TLS as described in Section 3.3.5 Sale to POI Protocol over TLS.
TCP Protocol
Message Delimitation
The TCP protocol is a stream protocol which does not offer message delimitation or data-unit
delimiting. It uses the general mechanism of message delimitation provided for all the transport
protocols.
Message delimitation or data-unit delimiting is the service provided by the transport protocol allowing
the recognition of an application data-unit by the transport protocol, in order to transfer a complete
application message to the Application Protocol.
Application messages are preceded by four bytes containing the length in network order, of the
application message. The length does not include the four bytes containing the length.
Services
ARKOS Vanilla version supports the following services in Nexo Retailer. Additional services are also supported depending on the customers project requiements and device capabilities.
Synchronisation services
Open a Session (Login Request) : Begins the association between two components of the Sale System and the POI System.
Close a Session (Logout Response) : Ends the association between two components of the Sale System and the POI System.
Financial services
Initiate a Standard Purchase (Normal Payment) : Realizes the normal purchase payment of goods or services by the customer with a payment card.
Please contact our team to know about all the services that are available.