Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Token

Verify

This API method allows the calling application to verify a Token or Account that has been presented by a consumer.

These checks can be used for a variety of use cases in order to:

  • Check it is genuine and valid within AIR.

  • Check it hasn't already been redeemed (for single use Tokens/Accounts).

  • Check it's valid to redeem at that time (within the desired Valid-From & Valid-To range).

  • Check if the parent Campaign is still active.

  • Check it hasn't been locked by another Outlet.

  • Check if there is enough balance.

  • Check if the pin provided (passphrase) is correct (optional parameter).

  • Optionally, to improve the customer experience and reduce the fraud risk. Verified Tokens or Accounts could be locked as part of this request if instructed to do so (please note Campaign settings could prevent them from being locked).

    Locked Tokens/Accounts can be redeemed, credited or debited, without unlocking, as long as the location specified in the API key or explicit location 'override' remains the same; otherwise, the Token/Account should be unlocked by the calling application e.g if a Consumer changes their mind and no longer wishes to redeem it.

    Alternatively, they will be automatically unlocked after reaching the defined lock time-out. This API is replaced by the POS Connect account APIs.

post/token/verify

Request body

OR

Example request

{
  "details": {
    "key1": "Value1",
    "key2": "AnotherValue"
  }
}

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)

Example response

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