Accounts

Get Wallet Accounts by Identity Value

Changed on

This API method allows the calling application to retrieve a list of Wallet Accounts, for a Wallet identified by Wallet Identity Value.

get/wallet/accounts

Request

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

Query parameters

includestring[]

A list of entities that should be included in the Account response

identity-valuestring string required

Wallet Identity value

state[]string string

Query string for Result filtering by Account State(s). For single value square brackets could be omitted.

status[]string string

Query string for Result filtering by Account Status(es). For single value square brackets could be omitted.

type[]'ECOUPON' | 'VOUCHER' | 'STAMP_CARD' | 'PAPER' | 'DEBIT' | 'PLASTIC' | 'POINTS' | 'STANDARD_SUBSCRIPTION' | 'CONTINUITY'

Query string for Result filtering by Account Type(s). For single value square brackets could be omitted.

clientType[]string string

Query string for Result filtering by Account clientType(s). For single value square brackets could be omitted.

accountId[]string string

Query string for Result filtering by Wallet Account Id(s). For single value square square brackets could be omitted.

unitId[]string string

Query string for Result filtering by returning only child Accounts of supplied Unit.

issuerId[]string string

Query string for Result filtering by returning only child Accounts of supplied Issuer.

campaignIdstring string

Query string allowing to filter out returned results by Campaign Id.

validTostring date-time

Query string for Result Filtering by Account Valid To explicit date-time value or date-time range, for range named key attributes needs to be provided (validTo[to]=... and/or validTo[from]=...)

validFromstring date-time

Query string for Result Filtering by Account Valid From explicit date-time value or date-time range, for range named key attributes needs to be provided (validFrom[to]=... and/or validFrom[from]=...)

dateCreatedstring date-time

Query string for Result Filtering by Account Created explicit date-time value or date-time range, for range named key attributes needs to be provided (dateCreated[to]=... and/or dateCreated[from]=...)

lastUpdatedstring date-time

Query string for Result Filtering by Account Last Updated explicit date-time value or date-time range, for range named key attributes needs to be provided (lastUpdated[to]=... and/or lastUpdated[from]=...)

campaign-status'ACTIVE' | 'INACTIVE' | 'PENDING' | 'EXPIRED' | 'DELETED' | 'DRAFT' | 'REJECTED' | 'READY'

Query string for Result Filtering by Campaign Status. Please note enum below contains all possible Campaign statuses

tokens'true' boolean

Show up to 100 active Tokens associated with each account.

limitinteger

Query string Pagination Limit

offsetinteger

Query string Pagination Offset

orderBy[]string string

Query string for controlling Paginated Results Sorting Order. Please note this query string needs to be constructed from field name + comma sign and sorting order (ASC/DESC). Currently AIR supports sorting by keys: accountId, validFrom, validTo, dateCreated, lastUpdated

Response

OK

limitinteger

Results per page

totalinteger

Total Results

offsetinteger

Pagination Offset

Example response

{
  "results": [
    {
      "dates": {
        "start": "2017-01-17T13:20:48+00:00",
        "end": "2017-01-17T13:20:48+00:00"
      },
      "relationships": {
        "ENTITLEMENT": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "ENTITLEMENT_OF": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "OBJECTIVE": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "OBJECTIVE_OF": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "PROMOTION": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "PROMOTION_OF": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "BOUNCE_BACK_REWARD": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "BOUNCE_BACK_REWARD_OF": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "COUPON_STAMP_REWARD": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "COUPON_STAMP_REWARD_OF": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        },
        "LOYALTY_POINTS_REWARD_OF": {
          "accountType": [
            {
              "dateCreated": "2017-01-17T13:20:48+00:00"
            }
          ]
        }
      },
      "dateCreated": "2017-01-17T13:20:48+00:00",
      "lastUpdated": "2017-01-17T13:20:48+00:00"
    }
  ]
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response property ////// became optional for the status

    • breaking

      the ////// response's property format changed from date-time to no format for status

    • breaking

      the /////// response's property format changed from date-time to no format for status

    • breaking

      the /////// response's property format changed from date-time to no format for status

    • breaking

      the ////// response's property format changed from date-time to no format for status

    • breaking

      the //////// response's property type changed from object to array for status

    • breaking

      the //////// response's property type changed from object to array for status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CONTINUITY enum value to the ////// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new POINTS enum value to the ////// response property for the response status

    • warning

      added the new QUEST enum value to the ////// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new STAMP_CARD enum value to the ////// response property for the response status

    • warning

      added the new STANDARD_SUBSCRIPTION enum value to the ////// response property for the response status

    • warning

      added the new SUSPENDED enum value to the ////// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • info

      added to the response body allOf list for the response status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response's property default value ACTIVE was added for the status

    • info

      the ////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the /////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the /////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the ////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property ////// to the response with the status

    This list may be incomplete.