Search for Rewards From a Reward Bank

This API endpoint allows the calling application to retrieve a Points Exchange Bank Reward details by Bank ID and optionally by other filtering criteria

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

EES AIR Bank ID (of type Points Exchange)

Query Params
string

Optional Filtering criteria (e.g. threshold[to]=100) allowing the calling application to narrow down returned results by reward threshold

string

Optional Filtering criteria (e.g. threshold[from]=10) allowing the calling application to narrow down returned results by reward threshold

string

Optional Filtering criteria (e.g. status=ACTIVE) allowing the calling application to narrow down returned results by reward status

string
enum
Defaults to pointsRewardBankRewardId,ASC

This optional request parameter allows the calling application to request a specific sorting order for a result set. Currently supported field names are: pointsRewardBankRewardId and threshold

Allowed:
string
≥ 0
Defaults to 0

This optional request parameter allows the calling application to request a specific page (pagination offset)

string
1 to 100
Defaults to 100

This optional request parameter allows the calling application to influence a length of returned result-set (pagination items per page)

Headers
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:
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:
string
required

Client ID, This will be provided by EES and is unique to the company calling the API.

string
required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret.

string

Unique Reference for the API transaction within the calling company.

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.

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.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json