Description
Reverse points for failed or cancelled orders. Points are restored to the customer's ledger when an order cannot be fulfilled.
Client API: This endpoint is hosted by the Client System. Bigcity Microsite calls this API when an order fails and points need to be reversed.
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_reversed
required, type: number
Total points to be reversed/restored.
reason
required, type: string
Reason for the reversal.
Example Request
{
"order_id": "ORD123456",
"customer_id": "CUST12345",
"points_reversed": 2500,
"reason": "Fulfillment Failure"
}
Example Response
{
"status": true,
"message": "Points reversed successfully"
}
Response Fields
status
type: boolean
Indicates whether points were reversed successfully.
message
type: string
Human-readable message describing the result.
Reversal Scenarios
- Fulfillment failure
- Vendor rejection
- Order cancellation
- Inventory unavailability