v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Wallet

Spend

This API applies the calculated operations from the spend-calculate API to a wallet and spends points from a customer's points account. This creates an active Wallet Transaction in the wallet found by the identity passed into the request.

post/connect/wallet/spend

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

referencestring string

A unique transaction reference which will be applied to the created wallet transaction.

lockboolean

Optional boolean flag, allowing the calling application to instruct AIR to lock verified Accounts. If provided as true no operations (e.g. spending points or redeeming accounts) will be performed until you Settle the transaction, otherwise operations will be performed.

parentWalletTransactionReferencestring string

The reference of the open transaction to link to as the parent of this spend transaction.

transactionDetailsTransactionDetailsEntity

JSON Object without a fixed structure (EES AIR Meta-Data)

metaMetaWalletTransactionEntity

Key-Value object that will appear in the Wallet Transaction created. Note: You will only see this in the response if you have showWalletTransactionMeta enabled in your posConnect responseFilters config. Key name and key values should be less then 255 characters.

Example request

{
  "transactionDetails": {
    "key1": "Value1",
    "key2": "AnotherValue"
  }
}

Response

Response payload from calling the spend endpoint