v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Reward Bank

Get Reward Bank

This API endpoint allows the calling application to retrieve a Points Exchange Bank details by Bank ID

get/banks/pointsreward/{bankId}

Path parameters

bankIdstring string required

EES AIR Bank 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

pointsRewardBankIdstring string required

EES AIR Points Exchange Bank ID

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

Points Exchange Bank Status

mode'PUBLIC' | 'PERSONAL' string required

Bank's mode: PERSONAL - only nominated Consumers can see and exchange rewards from this Bank, (nominee list could change while running a Scheme and/or Reward Bank); PUBLIC - all Consumers could see and exchange rewards using this Reward Bank)

namestring string required

Bank Name

referencestring string required

Points Exchange Bank External Reference

dateCreatedstring ees-datetime required

Points Exchange Bank Created Date-time (ATOM format)

lastUpdatedstring ees-datetime required

Points Exchange Bank Last updated Date-time (ATOM format)

exchangeLimitinteger nullable required

Number of times a Wallet or Wallet Link can exchange rewards from this Bank

Example response

{
  "pointsRewardBankId": "1172",
  "status": "ACTIVE",
  "mode": "PUBLIC",
  "reference": "000001185",
  "name": "My Points Exchange Bank",
  "dateCreated": "2019-07-02T13:54:43+00:00",
  "lastUpdated": "2020-03-09T13:20:17+00:00",
  "exchangeLimit": 2
}