Create a Reward Bank with Rewards

post

https://resources.uk.eagleeye.com/banks/pointsreward

This API endpoint allows the calling application to create a Reward Bank with Rewards

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Json Payload.

name

string

required

Bank Name

reference

string

Points Exchange Bank External Reference

mode

string

enum

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)

Allowed:

status

string

enum

required

Points Exchange Bank Status

Allowed:

exchangeLimit

int32 | null

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

rewards

array of objects

rewards

Headers

X-EES-AUTH-CLIENT-ID

string

required

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

X-EES-AUTH-HASH

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

string

Unique Reference for the API transaction within the calling company.

X-CUSTOM-SUBSYSTEM-ID

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.

X-CUSTOM-KEY

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

201EES AIR has successfully processed a Request

207Only some of the Reward Bank Rewards were created successfully. The failures are listed separately in the response.

400EES AIR Refuse to process that particular Request as there is something wrong with the Request (e.g., missing Mandatory Request parameter or Mandatory Request Payload attribute is missing, Request payload cannot be processed, etc)

401EES AIR Refuse to process that particular Request due to Authentication error. This could be caused by missing mandatory AUTH header(s), invalid Hash calculation, invalid or inactive API Key used, etc

403EES AIR Refuse to process that particular Request due to Request Authorization error(s). This indicates that used API Key has not got required permissions to perform this operation.

404EES AIR Refuse to process that particular Request as requested/referenced resource could not be found.

409EES AIR understands this request, but refuse to process it, due to present Conflict with the current state of the target resource or because performing this operation would lead to a Conflict within AIR.

415EES AIR is not able to understand that request due to not supported Content-Type value.

429EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded.

500EES AIR refuses to process that particular Request due to Unexpected Server Error.

503EES AIR refuses to process that particular Request due to Service(s) being Unavailable (i.e. Scheduled Maintenance)

504EES AIR refuses to process that particular Request due to Networking Issues