EAeagleeye
Token

Debit

This method allows the calling application to Debit an Account identified by Account Id or Token. Applicable to Stored Value Account types. This API is replaced by the POS Connect account APIs.

post/token/debit

Request

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

Request body

OR
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"
  }
}

Changes

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