EAeagleeye
Accounts

Get Household Points Balances

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