Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Loyalty Points

Update loyalty points balance

Update loyalty points for the specified business id

post/api/business/{businessId}/loyaltypoints

Path parameters

businessIdstring required

Request body

clientIdstring required

The unique identifier of the client for which this loyalty points applies.

branchIdstring required
descriptionstring required
pointsChangeinteger required

This represent the amount to either be added or deducted from the loyalty point

datestring date-time
operationType'DEDUCT' | 'ADD' required

Represents the type of action to be performed. Both add and deduct from loyalty point are supported

Example request

{
  "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
  "branchId": "SE-J0emUgQnya14mOGdQS",
  "description": "Paid into client account",
  "pointsChange": 10,
  "date": "2025-04-30T17:15:38Z",
  "operationType": "DEDUCT"
}

Response

Loyalty points updated successfully

clientIdstring required

The unique identifier of the client for which this loyalty points applies.

branchIdstring required
descriptionstring required
pointsChangeinteger required

This represent the amount to either be added or deducted from the loyalty point

datestring date-time

Example response

{
  "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
  "branchId": "SE-J0emUgQnya14mOGdQS",
  "description": "Paid into client account",
  "pointsChange": 10,
  "date": "2025-04-30T17:15:38Z"
}