Get points balance

POST 
/openapi/2026-01/loyalty/members/points

Return the points balance for a specific member

Request

application/json

Body

Bodyrequired

search_typestringrequired

Member locator type: member_id or email

search_valuestringrequired

Single member locator value

Example

{
  "search_type": "string",
  "search_value": "string"
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

member_idstring

Member ID

points_balanceint64

Total balance = active_points + frozen_points

active_pointsint64

Active points. May be negative after deduction

frozen_pointsint64

Frozen points

expiring_pointsint64

Points expiring in the next 30 days

earned_pointsint64

Cumulative earned points

spent_pointsint64

Cumulative spent points

expired_pointsint64

Cumulative expired points

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "member_id": "string",
    "points_balance": 0,
    "active_points": 0,
    "frozen_points": 0,
    "expiring_points": 0,
    "earned_points": 0,
    "spent_points": 0,
    "expired_points": 0
  }
}