Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Accounts

Retrieve Available Loyalty Points

This API method allows calling applications to retrieve detailed information about how a customers points will expire. This end point is only applicable to schemes where Points Expiry is enabled. The response is a date organised list for the dates on which the points expire, and the value of the points on that date.

get/wallet/{walletId}/account/{accountId}/points/available

Path parameters

walletIdstring string required

EES AIR Wallet ID

accountIdstring string required

EES AIR Wallet Account ID

Query parameters

orderBy[]string string

Query string for controlling sort order. Please note this query string needs to be constructed from field name + comma sign and sorting order (ASC/DESC). Currently AIR supports sorting by keys: validTo

Response

OK

limitinteger

The maximum number of transactions that were considered.

totalinteger

Total number of results in this response.

totalRecordsinteger

Total number of records used to calculate the results.

offsetinteger

Pagination Offset

Example response

{
  "results": [
    {
      "validTo": "2017-01-17T13:20:48+00:00"
    }
  ]
}