v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Reward Bank

Get a Reward from a Reward Bank

This API endpoint allows the calling application to retrieve a Reward details by Bank ID and Reward ID

get/banks/pointsreward/{bankId}/rewards/{rewardId}

Path parameters

bankIdstring string required

EES AIR Bank ID (of type Points Exchange)

rewardIdstring string required

EES AIR Bank Reward ID (of type Points Exchange)

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-*

Response

EES AIR has successfully processed a Request

pointsRewardBankRewardIdstring string required

EES AIR Points Exchange Bank Reward ID

pointsRewardBankIdstring string required

EES AIR Points Exchange Bank ID

status'ACTIVE' | 'INACTIVE' | 'SUSPENDED' string required

Points Exchange Bank Reward Status

resourceType'CAMPAIGN' string required

Reward Type

resourceIdstring string required

EES AIR Resource ID of what is the reward. This cannot be the same ID as an existing reward from this Bank.

costinteger required

Reward cost (in Points)

thresholdinteger required

Reward threshold (in Points). If this is not provided then the cost is used as the threshold.

dateCreatedstring ees-datetime required

Points Exchange Bank Reward Created Date-time

lastUpdatedstring ees-datetime required

Points Exchange Bank Reward Last updated Date-time

Example response

{
  "rewardId": "1",
  "bankId": "1172",
  "status": "ACTIVE",
  "resourceType": "CAMPAIGN",
  "resourceId": "1749",
  "cost": 100,
  "threshold": 100,
  "dateCreated": "2019-07-02T13:54:43+00:00",
  "lastUpdated": "2019-07-02T13:54:43+00:00"
}