Description
Notify Client System regarding redeemed points (Deduct Points). This API is called after a successful order creation to deduct points from the customer's ledger.
Client API: This endpoint is hosted by the Client System. Bigcity Microsite calls this API after an order is successfully placed to deduct points.
Headers
Authorization
required
Basic Authentication header. Format: Basic <base64(username:password)>
Content-Type
application/json
Parameters
order_id
required, type: string
The unique order identifier from Bigcity.
customer_id
required, type: string
The unique Customer ID.
points_consumed
required, type: number
Total points to be deducted for this order.
transaction_date
required, type: datetime
ISO 8601 timestamp of the transaction.
Example Request
{
"order_id": "ORD123456",
"customer_id": "CUST12345",
"points_consumed": 2500,
"transaction_date": "2026-06-03T10:00:00Z"
}
Example Response
{
"status": true,
"message": "Points deducted successfully"
}
Example of Error Response
{
"status": false,
"message": "Insufficient balance"
}
Response Fields
status
type: boolean
Indicates whether points were deducted successfully.
message
type: string
Human-readable message describing the result.
Order Placement Flow
- Customer places order on Bigcity Microsite
- Bigcity validates latest available points
- Order is created
- Bigcity calls this API to deduct points
- Client deducts points from customer ledger
- Order moves for fulfillment