v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

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

Path parameters

walletIdstring string required

EES AIR Wallet ID

Response

Success

schemeIdstring

Example response

[
  {
    "household": {
      "tierMembership": {
        "expiryDate": "2024-03-11T16:33:00+00:00",
        "tierBalancesResetDate": "2024-03-11T16:33:00+00:00",
        "dateCreated": "2024-03-11T16:33:00+00:00",
        "lastUpdated": "2024-03-11T16:33:00+00:00"
      }
    }
  }
]