Sign in
Programmes

Get Programme

This method allows the calling application to retrieve a Programme by id.

get/programmes/{id}

Path parameters

idstring Int64 required

EES AIR Programme ID.

Headers

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

This flag denotes the number of attempts that have been made for this request.

Response

OK.

idId — unresolved $ref
typeType — unresolved $ref
statusStatus — unresolved $ref
referenceReference — unresolved $ref
detailsDetails — unresolved $ref
settingsSettings — unresolved $ref
partnersPartners — unresolved $ref
rulesRules — unresolved $ref
dateCreatedDateCreated — unresolved $ref
lastUpdatedLastUpdated — unresolved $ref

Example response

{
  "id": "1001",
  "type": "STANDARD",
  "status": "ACTIVE",
  "reference": "TestReference",
  "details": {
    "name": "Test Programme",
    "description": "Test Description",
    "startDate": "2025-07-01 00:00:00",
    "endDate": "9999-12-31 00:59:59",
    "tags": [
      "test"
    ]
  },
  "settings": {
    "tokenProvider": "EES",
    "tokenFormat": "8Digits",
    "cardNumber": {
      "bin": "123456",
      "scheme": "12"
    },
    "accountClientType": "BASIC",
    "defaultAccountClientState": "BASIC",
    "passphrase": true,
    "refreshToken": true,
    "currency": "GBP"
  },
  "partners": {
    "creation": [
      {
        "partner": "123"
      }
    ],
    "redemption": [
      {
        "partner": "124"
      }
    ]
  },
  "rules": {
    "expiry": {
      "type": "DAYS_AFTER_ACTIVATION",
      "date": "null,",
      "value": 50
    },
    "balances": {
      "maxBalance": 10000,
      "minLoadAmount": 1,
      "maxLoadAmount": 1000,
      "maxDebitAmount": 1000
    },
    "redemption": {
      "couponLimit": 0
    },
    "storeRestrictions": {
      "banner1": {
        "included": {
          "locationIdentifiers": null
        }
      },
      "banner2": {
        "included": {
          "locationIdentifiers": {
            "banner2": [
              "outlet1"
            ]
          }
        }
      }
    }
  },
  "dateCreated": "2025-05-09 15:47:58",
  "lastUpdated": "2025-06-12 13:30:19"
}

Changes