--- title: "Get Household Points Balances" method: GET path: "/composite/wallet/{walletId}/householdBalances" tags: ["Accounts"] --- # Get Household Points Balances `GET /composite/wallet/{walletId}/householdBalances` 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. ## Path parameters - `walletId` string, string, required ## Response `200` Success - object[] - `schemeId` string - `accounts` WalletAccountEntity[] - `accountId` string, required — EES AIR Wallet Account ID - `relationships` object — Wallet Accounts Relations - `ENTITLEMENT` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `ENTITLEMENT_OF` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `walletId` string, required — EES AIR Wallet ID - `campaignId` string, required — The campaignId (Campaign or Programme) this account belongs to. - `type` 'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC', required — EES AIR Account Type. - `clientType` string, required — Account client type. - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED', required — Account status - `state` string, required — Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process. - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `balances` AccountBalancesEntity, required — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `dateCreated` string, date-time, required — Date this Account was created - `lastUpdated` string, date-time, required — Date this Account was last updated - `tokens` TokenEntity[] — Array of token entities, present only if include=tokens is passed in the query string. - `tokenId` string — The Token ID. - `accountId` string — The Account ID. - `token` string — The Token. - `validFrom` string, date-time — The date this token is valid from. - `validTo` string, date-time — The date this token is valid to. - `dateCreated` string, date-time — The date this token was created. - `lastUpdated` string, date-time — The date this token was last updated. - `status` string — The status of the Token. - `tokenLock` object — Token lock information. All values can be null if no token lock exists. - `validFrom` string, date-time — The date the token lock is valid from. - `validTo` string, date-time — The date the token lock is valid to. - `household` object - `balances` object - `current` integer - `usable` integer - `locked` integer - `lifetime` integer - `lifetimeSpend` integer - `lifetimeSpendValue` integer - `pending` integer - `tierMembership` TierMembershipEntity - `tierMembershipId` string, required — The unique ID for this Tier Membership. This will be a numeric string value of variable length. - `tierId` string, required — The ID for the Tier Membership to which the customer belongs. This will be a numeric string value of variable length. - `status` 'ACTIVE', required — The status of this Tier Membership. - `accountIds` string[], required - `balances` TierMembershipBalancesEntity, required - `transactions` integer — The value representing the Tier Membership Balance for a customer's Tier Membership relating to the number of Tier Membership Transactions completed. - `spend` integer — The value representing the Tier Membership Balance for a customer's Tier Membership relating to the Tier Membership Spend amount completed. - `points` integer — The value representing the Tier Membership Balance for a customer's Tier Membership showing the Tier Membership Points earned. - `expiryDate` string, required — DateTime in ATOM format. - `tierBalancesResetDate` string, required — DateTime in ATOM format. - `dateCreated` string, required — DateTime in ATOM format. - `lastUpdated` string, required — DateTime in ATOM format. --- [API](https://skmtc.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/versions/90a122bb14cc/schema)