Accounts

Get Household Points Balances

Changed on Nov 3, 2026

This API method allows the calling application to retrieve the household balances from points accounts across a household of Wallets. If enabled, and set to HOUSEHOLD mode, the Tier Membership and Tier Membership Balances are also returned in the response.

get/composite/wallet/{walletId}/householdBalances

Request

Base URL
https://wallet.uk.eagleeye.com/2.0
URL
https://wallet.uk.eagleeye.com/2.0/composite/wallet/{walletId}/householdBalances
Auth
API key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH

Path parameters

walletIdstring string required

EES AIR Wallet ID

Response

Success

schemeIdstring

Example response

[
  {
    "accounts": [
      {
        "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"
      }
    ],
    "household": {
      "tierMembership": {
        "expiryDate": "2024-03-11T16:33:00+00:00",
        "tierBalanceResetDate": "2024-03-11T16:33:00+00:00",
        "dateCreated": "2024-03-11T16:33:00+00:00",
        "lastUpdated": "2024-03-11T16:33:00+00:00"
      }
    }
  }
]

Changes

Nov 3, 20267bc73e06813c Revision changes
- 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
- 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
- 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
- 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 CONTINUITY 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 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
- 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
  added subschema #2 to the // response property allOf list for the response 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
This list may be incomplete.

Operation history