Open

This API endpoint allows the calling application to open an AIR Wallet by providing an Identity Value (if no identity is passed then the end point can be configured to operate in unidentified customer mode). AIR will check if provided Identity Value is genuine, active and known to AIR; and if so - return details of Wallet(s) and details for presented Wallet Identity. Additionally the calling application could instruct AIR to return additional data related to returned default Entities, like walletConsumer, other walletIdentities from the same Wallet, list available walletAccounts from the same Wallet, etc. Additionally the calling application could instruct AIR to perform Analyse Basket and to return back a list of suggestions what are the applicable offers for that Consumer, based on configured in AIR rules and provided Consumer's Basket Content or even request a more sophisticated action like Adjudicate Basket where AIR would return adjudicated Basket Object with applied applicable promotions, offers, etc.

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-*

X-POSCONNECT-TRANSACTION-DATETIMEstring eesDateTime

The ability to specify the date and time that should be used to adjudicate. This can be used to create transactions for past events, whilst ensuring the consumer receives the rewards that they were eligible for at that time. This functionality is only available for events less than 6 months in the past. Please note requested transaction date-time has to use ATOM Date-Time format Y-m-d\TH:i:sP, (e.g. 2017-12-31T23:59:59+09:00).

Request body

referencestring string

Merchant Reference (please note this reference has to be unique). In combination with lock, analysed accounts can be locked using this reference

lockboolean

Optional boolean flag, allowing the calling application to instruct AIR to lock the accounts in the transaction. A reference must be passed which will be used to lock the transactions

Response

EES AIR has successfully processed a Request

basketAdjudicationResultobject nullable required

details TBC

v1

Open

Headers

Request body

Response