EAeagleeye
Token

Create

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

post/token/create

Request

  • Base URL
    https://consumer.uk.eagleeye.com/2.0
  • URL
    https://consumer.uk.eagleeye.com/2.0/token/create
  • Auth
    API key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH

Request body

resourceType'CAMPAIGN' | 'PROGRAMME' required

Type of Account Token to be created

resourceIdinteger required

Campaign ID or Programme ID (depending on resourceType value)

barcodeImagetrue

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.

locationstring string

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

detailsTransactionDetailsEntity

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

mobileWalletboolean

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).

tokenCodestring

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

Example request

{
  "resourceType": "CAMPAIGN",
  "resourceId": 1178,
  "tokenDates": {
    "start": "2026-02-02T00:00:00+00:00",
    "end": "2027-02-02T00:00:00+00:00"
  }
}

Response

EES AIR successfully processed this request

accountIdinteger required

Account ID (EES Reference)

accountTypeIdinteger required

Account Type ID (EES Internal Type Reference)

accountType'Endpoints applicable to COUPON Account Type' | 'Endpoints applicable to STORED_VALUE Account Type' required

Account Type

accountSubType'ECOUPON' | 'CONTINUITY' | 'PAPER' | 'VOUCHER' | 'DEBIT' | 'PLASTIC' required

Account Sub-type

tokenstring string required

Generated Token

tokenIdinteger required

Token ID (EES Reference)

consumerIdinteger

Consumer ID (EES Reference)

issuerIdinteger required

Issuer ID

barcodeImagestring string

An base64-encoded Barcode Image of the generated Token. Please note currently 128C Barcode Type is supported only.

accountStatus'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED' required

Account status

tokenStatus'INACTIVE' | 'ACTIVE' | 'REDEEMED' | 'CANCELLED' | 'EXPIRED' | 'INVALIDATED' required

Token status

serialNumberstring string

Token Serial Number. Please note this optional attribute is available for Stored Value Account only. This attribute will not show up in the Response unless appropriate Programme setting is turned on

resourceType'CAMPAIGN' | 'PROGRAMME' required

Resource Type

resourceIdinteger required

Programme Id, Campaign Id

pinstring string

This JSON property would return randomly generated by the AIR PIN, if a referenced Resource (Campaign or Programme) is configured to support PINs. Because of security reasons AIR would return this PIN value only as part of Token Create Response

accountTransactionIdstring string nullable required

ID of the Account Transaction created as result of this API endpoint call (if applicable, as not all AIR operations would generate Account Transaction)

mobileWalletUrlstring string required

Mobile Wallet URL, this attribute will be returned only if

Example response

{
  "tokenDates": {
    "start": "2026-02-02T00:00:00+00:00",
    "end": "2026-02-02T00:00:00+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.