Balance (Object)
Contains information about the account balance of the user
- bankedType: string
_rewards Banked rewards of the user account. This value is set only if the program type is banked rewards based; else it will be 0.
- expiredType: string
_membership _level Expired membership level
- initialType: integer
_visits Captures all of the visits that the guest made up to the time of migration
- membershipType: string
_level Membership level of the user
- membershipType: integer
_level _id Membership level ID of the user
- netType: number
_balance Net available balance of the current account. This value always shows the available balance of the user, whether visits, banked rewards, or points.
- netType: number
_debits Net debits of the user
- pendingType: integer
_points Pending points of the user
- pointsType: integer
_balance Returns the points balance of the user account. This value gets reset based on the point conversion value once reached, as configured in the Punchh platform.
Note: It will increase only as per points earned, and it resets once the threshold value is reached to convert points to currency or reward.
- signupType: string
_anniversary _day Sign-up anniversary day and month of the current account
- totalType: integer
_credits Total credits of the current account
- totalType: string
_debits Total debits of the current account
- totalType: integer
_point _credits Total points credits of the user
- totalType: integer
_redeemable _visits Total redeemable visits of the user
- totalType: integer
_visits Total number of loyalty visits
- unredeemedType: integer
_cards Number of unredeemed cards of the user. This value is set only if the program type is visit-based; else it will be 0.
{
"banked_rewards": "2.00",
"membership_level": "Bronze",
"membership_level_id": 109,
"net_balance": 2,
"net_debits": 0,
"pending_points": 0,
"points_balance": 0,
"signup_anniversary_day": "04/04",
"total_credits": 15,
"total_debits": "0.0",
"total_point_credits": 15,
"total_redeemable_visits": 1,
"expired_membership_level": "Bronze",
"total_visits": 0,
"initial_visits": 1,
"unredeemed_cards": 0
}
