get https://{tenant}.getomneo.com/api/v3/profiles//balances
A GET to the /profiles/{profileId}/balances endpoint allows your application to retrieve a Profiles Balances.
Balances represent the current status of reward value, points and converted points value against a profile. Use this to quickly get balance information about a profile, or get the total dollar value the profile has available to redeem.
Balances Properties
| Attribute | Description |
|---|---|
reward_balanceFLOAT | The current balance of all available rewards against the profile. A reward is considered available if it active and not expired. Details: Rewards |
point_balanceFLOAT | The current point balance on the profile. the points_balance is the raw total of points before a conversion is made based on the configured exchange rate |
point_balance_dollarsFLOAT | The converted dollar value of point_balance based on the configured exchange rate. For example, a 10% exchange rate would mean 100 points equals $10 of redeemable value. |
combined_balance_dollarsFLOAT | The total dollar value amount that can be used as a discount. This is a calculation of rewards_balance and point_balance_dollars |
currencySTRING | A valid currency configured in your Omneo system. Used in the calculation of point_balance_dollars and combined_balance_dollars |