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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

JSON Request Payload

int64

EES AIR Account ID

string
required

Token (Value)

boolean
Defaults to false

Optional boolean flag to instruct AIR to lock this token to the particular location so it can not be verified, redeemed nor debited elsewhere, until the lock is present.

string

If this key is present in the Request payload, AIR will perform an additional check and only if this value matches the PIN stored in AIR then Verify action will be attempted. Up to the calling application to include PIN into a Request Payload or not.

string

[Optional] Outlet incoming identifier where this Transaction has happened

details
object

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

Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json