v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Message At Till

Create

This API endpoint allows the calling application to request a set of additional information from EES AIR. These Messages could then be displayed on a Till screen, printed on a Consumer receipt, etc. EES AIR uses configurations or even data from external systems to construct returned Messages.

post/connect/messages

Headers

Accept-Encoding'''' | ''gzip'' | ''deflate'' | ''gzip,deflate'' | ''deflate,gzip'' string

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding Response header. Currently supported gzip and deflate. Please note if this request header is not present, no compression will be used.

Connection'keep-alive' | 'close' string

This general HTTP header controls (or rather influences) whether the network connection stays open after the current request finishes. If the sent value is keep-alive, the connection should stay in a special state, allowing to be reused for subsequent requests to the same server. Please note these connections will be closed after reaching timeout threshold controlled by EES server (usually after 5 seconds).

Content-Typestring string

Standard HTTP header to inform EES API what type of content was passed in request payload

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-CUSTOM-SUBSYSTEM-IDstring string

Optional header provided by the calling application for EES AIR to identify what was the external Subsystem Id / Name.

X-CUSTOM-KEYstring string

Optional header(s) provided by the calling application to EES AIR. Please note this header name has to follow pattern X-CUSTOM-*

Request body

walletIdstring string

EES Wallet ID. Issued coupons will be added to the wallet associated to this walletId. Optional

referencestring string required

Merchant Reference for a Consumer Transaction

Example request

{
  "identity": {
    "identityValue": "john.roe@domain.org"
  },
  "reference": "0c215d3e-5e53-45e0-9233-13d97378a8eb"
}

Response

EES AIR has successfully processed a Request

referencestring string required

Unique Merchant's reference (unique for each operation request)

messagesobject[]