Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
balance
Get Customer Balance
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/balance \
  --header 'apikey: <api-key>'
{
  "totalPointsBalance": 123,
  "totalPointsValue": 123,
  "availablePointsBalance": 123,
  "availablePointsValue": 123,
  "pendingPoints": 123,
  "pendingPointsValue": 123,
  "currency": "<string>",
  "pointsName": "<string>",
  "nextExpiringPointsAmount": 123,
  "nextExpiringPointsValue": 123,
  "nextExpiringPointsDate": "<string>",
  "totalEarnedPoints": 123
}
This API retrieves a customer’s current points balance within Gameball, including redeemable points and their monetary equivalent. It provides detailed balance information, such as total, available, and pending points, along with upcoming expirations.
Security: Provide both apikey and secretkey headers.

Authorizations

​
apikey
string
header
required

Path Parameters

​
customerId
string
required

Unique identifier for the customer

Query Parameters

​
expand
string

Comma-separated expansions: tier,referrals

Response

200 - application/json

Customer progress

​
totalPointsBalance
number

The total number of points the customer has, including pending points.

​
totalPointsValue
number

The total monetary value of the customer's points, including pending points.

​
availablePointsBalance
number

Points currently active and available for use (excludes pending).

​
availablePointsValue
number

Monetary value of currently available points (excludes pending).

​
pendingPoints
number

Points earned but on hold during the return window.

​
pendingPointsValue
number

Monetary value of the pending points.

​
currency
string

Currency code used for point value calculations.

​
pointsName
string

Display name of points in the loyalty program (e.g., 'Stars').

​
nextExpiringPointsAmount
number

Amount of points that will expire next.

​
nextExpiringPointsValue
number

Monetary value of the points that will expire next.

​
nextExpiringPointsDate
string

Date when the next set of points will expire.

​
totalEarnedPoints
number

Total number of points earned over the customer's lifetime.