Create

post

https://consumer.uk.eagleeye.com/2.0/token/create

This method allows the calling application to create a new Token within AIR platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

JSON Request Payload

resourceType

string

enum

required

Type of Account Token to be created

Allowed:

resourceId

int64

required

Campaign ID or Programme ID (depending on resourceType value)

barcodeImage

boolean

enum

Defaults to false

An optional boolean flag to instruct AIR to include into returned Response an additional attribute barcodeImage containing base64-encoded Barcode Image of the Token. Please note currently 128C Barcode Format is supported only.

Allowed:

tokenDates

[Optional] This optional request structure allows to override Campaign or Programme settings for Token Valid-From and/or Valid-To dates; newly created Token will have these dates as explicitly requested. Please note explicit date-times has to be within a referenced Campaign or Programme validity window.

consumerIdentifier

Only one of following keys could be provided to fulfil Consumer search (by email, by mobile number, by customerId, by external system Reference). If Consumer with provided email or mobile doesn't exist, AIR will create a new Consumer using provided email or mobile. Please note for Campaigns with a strict issuance per Consumer limit this field will be mandatory.

value

object

overrides

object

[Optional] Overrides for reward or continuityQualification of the Token. Both the Unit and Campaign must have overrides enabled to use this.

location

string

[Optional] Outlet incoming identifier to override where this Transaction has happened, if not provided AIR will use location arisen from used API Key

details

object

JSON Object without a fixed structure (EES AIR Meta-Data)

delivery

object

Optional section (key and value), if defined AIR will try to deliver EMAIL or SMS delivery notification to requested end-Client.

mobileWallet

boolean

Defaults to false

An optional boolean flag to instruct the API to include a link to Mobile Wallet in the Response. (Please note this feature requires App Manager service enabled for a Client).

tokenCode

string

Used for the token, if campaign is configured to allow it

accountDetails

object

Responses

201EES AIR successfully processed this request

400EES AIR refuse to process that particular Request as there is something wrong with the Request (e.g. Request Payload is unprocessable, Mandatory Request Parameter value is not provided, etc.)

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

404EES AIR refuse to process that particular Request as requested Resource could not be found or referenced Resource is not active.

415EES AIR refuse to process that particular Request as requested Mime-Type is not supported (Currently only application/json is supported

429Too Many Requests

500EES AIR is not able to process that particular Request due to Unexpected Server Error.