GET /api/v1/customer/points

CLIENT API

Description

Retrieve latest customer points information. The Client System maintains the master points ledger, and this API is used to fetch the current balance.

Client API: This endpoint is hosted by the Client System. Bigcity Microsite calls this API to fetch the latest points balance.

Headers

Authorization required

Bearer token received after successful OTP verification. Format: Bearer <jwt-token>

Query Parameters

customer_id required, type: string

The unique Customer ID.

Example Request

GET /api/v1/customer/points?customer_id=CUST12345
Authorization: Bearer <jwt-token>

Example Response

{
  "status": true,
  "customer_id": "CUST12345",
  "points_earned": 5000,
  "balance_points": 3500
}

Response Fields

status type: boolean

Indicates whether the request was successful.

customer_id type: string

The unique Customer ID.

points_earned type: number

Total points earned by the customer.

balance_points type: number

Available balance points for redemption.

When This API is Called

  • On Successful Login: After OTP verification
  • Dashboard Load: When dashboard is opened
  • Before Checkout: To validate sufficient balance
  • After Order Placement: To refresh balance
  • After Reversal Processing: When order fails and points are reversed