Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Token Formats

Search for Token Formats

This method allows the calling application to search token formats using query parameters.

get/tokenFormats

Query parameters

id[]integer

EES AIR Token Format ID.

safeNamestring int64

EES AIR Token Format Safe Name.

namestring

EES AIR Token Format Name.

offsetinteger
Example:51

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

limitinteger

The number of items to return.

orderBystring

Requested result set sorting order

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 Token Formats skipped when returning the data.

limitinteger

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

totalinteger

The total number of token formats matching your search.

Example response

{
  "limit": 50,
  "total": 1,
  "orderBy": [
    {
      "name": "id",
      "order": "ASC"
    }
  ],
  "results": [
    {
      "id": 1000,
      "name": "Example Token Format",
      "safeName": "000001000",
      "details": {
        "format": "########",
        "length": 11,
        "prefix": "NS",
        "suffix": "X"
      }
    }
  ]
}