Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Programmes

Search for Programmes

This method allows the calling application to retrieve all Programmes.

get/programmes

Query parameters

idinteger

Optional Filtering criteria based on one or more ids.

status'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'PENDING' | 'DRAFT' | 'REJECTED' | 'READY' | 'STOPPED' | 'DELETED'

This is a status of the Programme.

type'VOUCHER' | 'DEBIT' | 'PLASTIC' string

Optional Filtering criteria (e.g. type=VOUCHER) allow the calling application to narrow down returned results by type.

tagstring string

EES AIR Programme Tag.

accountClientTypestring

The default client type for an Account unless otherwise stated during individual Account creation.

startDatestring date-time
Example:yyyy-mm-dd+hh:mm:ss

When the Programme starts.

endDatestring date-time
Example:yyyy-mm-dd+hh:mm:ss

When the Programme ends.

dateCreatedstring date-time
Example:yyyy-mm-dd+hh:mm:ss

The date the Programme was created.

lastUpdatedstring date-time
Example:yyyy-mm-dd+hh:mm:ss

The date the Programme was last updated.

orderBy[]'id,ASC' | 'id,DESC' | 'status,ASC' | 'status,DESC' | 'lastUpdated,ASC' | 'lastUpdated,DESC' string

This optional request parameter allows the calling application to request a specific sorting order for a result set. Currently supported field names are: id, status and lastUpdated

offsetinteger
Example:51

Offset allows you to skip a number of items before returning data.

limitinteger

The number of items to return.

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.

offsetinteger

The number of Programmes skipped when returning the data.

limitinteger

The number of Programmes limited in the results, up to a maximum of 100.

totalinteger

The total number of Programmes matching your search.

Example response

{
  "limit": 50,
  "total": 1,
  "orderBy": [
    {
      "name": "id",
      "order": "ASC"
    }
  ],
  "results": [
    {
      "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"
    }
  ]
}