Skip to main content
GET
/
v3
/
profiles
/
{profile}
/
balances
Read Profile Balances
curl --request GET \
  --url http://localhost/api/v3/profiles/{profile}/balances
{
  "data": {
    "reward_balance": "<string>",
    "credit_balance": "<string>",
    "point_balance": "<string>",
    "point_balance_dollars": "<string>",
    "benefit_balance": "<string>",
    "combined_balance_dollars": "<string>",
    "localised": {
      "reward_balance": "<string>",
      "point_balance_dollars": "<string>",
      "combined_balance_dollars": "<string>"
    },
    "currency": {
      "id": 123,
      "from": "<string>",
      "to": "<string>",
      "rate": 123,
      "is_system": true,
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

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

AttributeDescription
reward_balance FLOATThe current balance of all available rewards against the profile. A reward is considered available if it active and not expired. Details: Rewards
point_balance FLOATThe 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_dollars FLOATThe 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_dollars FLOATThe total dollar value amount that can be used as a discount. This is a calculation of rewards_balance and point_balance_dollars
currency STRINGA valid currency configured in your Omneo system. Used in the calculation of point_balance_dollars and combined_balance_dollars

Path Parameters

​
profile
string<uuid>
required

The profile ID

Query Parameters

​
currency
string

Response

Return the balance.

Balance

​
data
Balance · object
required