Refund

post

https://pos.uk.eagleeye.com/2.0/connect/wallet/refund

This API endpoint allows the calling application to record within AIR a refund (return) transaction. Request attribute basket should contain only a list of returned items (please note each returned item should have the attribute salesKey=REFUND), allowing AIR to update the original transaction. If one or more returned items had triggered an offer redemption, then AIR will unredeem appropriate COUPON(s) and depending on a Campaign setting (unredeemable) will put them back into the Consumer Wallet or Cancel them. Likewise, if loyalty points were earned in the original transaction, then depending on Scheme configuration (isRefundable) AIR will debit the difference arisen from the basket differences. Please note location provided to this endpoint will only be used to record where this refund happened (in which Store or Outlet); Settle's transaction location will be used for basket re-analysis, if applicable.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

JSON Payload

reference

string

required

Refund Transaction Reference

originalTransaction

object

required

basket

object

required

location

object

Headers

Accept-Encoding

string

enum

Defaults to ''

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.

Allowed:

Connection

string

enum

Defaults to close

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).

Allowed:

Content-Type

string

Defaults to application/json

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

X-EES-AUTH-CLIENT-ID

string

required

Client ID, provided by EES during on-boarding. Please note: the authentication mechanic requires the receipt of the full payload so any headers that would chunk the request up, such as transfer-encoding: chunked could potentially cause authentication failures.

X-EES-AUTH-HASH

string

required

Request Authentication Hash, calculated by concatenating Request URI Path with API prefix, Request Query String(s) if applicable, Request Payload if applicable and Client Secret. Please note: the authentication mechanic requires the receipt of the full payload so any headers that would chunk the request up, such as transfer-encoding: chunked could potentially cause authentication failures.

X-EES-TRANSACTION-ID

string

Optional Unique Reference for the API Request (Transaction) within the calling company

X-CUSTOM-SUBSYSTEM-ID

string

Optional header provided by the calling application for EES AIR to identify what was the external Subsystem ID / Name. Please note this header is not essential for AIR to process a Request, this header and its value will be intercepted by AIR and will show up in Wallet Event Notifications, if applicable.

X-CUSTOM-KEY

string

Optional header(s) provided by the calling application to EES AIR. Please note a) this header name has to follow pattern X-CUSTOM-* (i.e. X-CUSTOM-EMAIL) b) this header is not essential for AIR to process a Request, this header and its value will be intercepted by AIR and will show up in Wallet Event Notifications, if applicable.

X-HTTP-Method-Override

string

enum

Optional HTTP header, if present, it will instruct EES AIR to override the real HTTP Method, used during this connection. This is due to some networking or software limitations on Client side, allowing the calling application to perform only GET or POST calls.

Allowed:

X-POSCONNECT-TRANSACTION-DATETIME

string

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).

Responses

200EES AIR has successfully processed a Request

207EES AIR has processed a partially successful Request

400EES AIR Refuse to process that particular Request as there is something wrong with the Request (e.g. missing Mandatory Request parameter or Mandatory Request Payload attribute is missing, Request payload is unprocessable, etc)

401EES AIR Refuse to process that particular Request due to Authentication error. This could be caused by missing mandatory AUTH header(s), invalid Hash calculation, invalid or inactive API Key used, etc.

403EES AIR Refuse to process that particular Request due to Request Authorization error(s). This indicates that used API Key has not got required permissions to perform this operation.

404EES AIR Refuse to process that particular Request as requested/referenced resource could not be found.

409EES AIR understands this request, but refuses to process it, due to present Conflict with the current state of the target resource or because performing this operation would lead to a Conflict within AIR.

415EES AIR is not able to understand that request due to not supported Content-Type value.

429EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded.

500EES AIR refuses to process that particular Request due to Unexpected Server Error.

503EES AIR refuses to process that particular Request due to Service(s) being Unavailable (i.e. Scheduled Maintenance)

504EES AIR refuses to process that particular Request due to Networking Issues