Wallet Transaction

Get by Reference

This API endpoint allows the calling application to retrieve an existing Wallet Transaction for the calling Unit.

get/connect/wallet/transaction

Request

  • Base URL
    https://pos.uk.eagleeye.com/2.0
  • URL
    https://pos.uk.eagleeye.com/2.0/connect/wallet/transaction
  • Auth
    API key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH

Query parameters

referencestring string required

The reference of the Wallet Transaction to return.

Headers

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

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'

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, 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-HASHstring 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-IDstring string

Optional Unique Reference for the API Request (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. 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-KEYstring 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.

Response

OK

walletTransactionIdstring required

Wallet Transaction ID

parentWalletTransactionIdstring nullable required

Parent Wallet Transaction ID

walletIdstring nullable required

Wallet ID

referencestring nullable required

Calling party's reference to this transaction

identityIdstring nullable required

The Identity ID responsible for this transaction.

typestring nullable required

Transaction Type, defined per retailer

status'ACTIVE' | 'SETTLED' | 'EXPIRED' | 'CANCELLED' | 'DELETED' | 'PURGED' | 'FULFILLING' | 'FULFILLED' required

Transaction status

metaMetaEntity required

Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters

statestring nullable required

Transaction state

transactionDateTimestring date-time required

Transaction date-time in ATOM format.

transactionDateTimeOffsetstring string

The offset of the date-time from UTC in format "+00:00".

expiryDatestring date-time nullable required

Transaction Expiry Timestamp (date-time in ATOM format), when transaction should expiry and automatically be settled.

channelstring required

Channel used for Transaction creation or update

dateCreatedstring date-time required

Date this Wallet Transaction was created

lastUpdatedstring date-time required

Date this Wallet Transaction was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.