v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update redeem points

put/points/updateRedemption

Request body

redemptionIdstring required

A unique identifier for the redemption process.

externalReferenceNumberstring required

Unique reference number associated with the bill.

billNumberstring

A string identifier for the bill.

billIdinteger

A numerical identifier for the bill. The maximum number of supported characters is 19.

purposestring

The purpose or reason for the redemption update.

type'CUSTOMER' | 'USER GROUP'

The type of entity involved in the transaction.

identifierValuestring

The value of the identifier for the entity.

customFieldsobject

Object containing details of custom fields for the point redemption.

keystring

Key-value pairs of the custom field and its respective value.

Response

200

idinteger

programIdinteger

pointsRedeemedinteger

billIdinteger

billNumberstring

validationCodestring

notesstring

redemptionTimeinteger

pointsRedemptionTimeinteger

tillIdinteger

tillNamestring

redemptionIdstring

customerIdinteger

redemptionPurposestring

redemptionDatestring

Example response

{
  "id": 994485,
  "programId": 2649,
  "pointsRedeemed": 1,
  "billId": 2152315011,
  "billNumber": "txn-75",
  "notes": "Sample notes",
  "redemptionTime": 1749414724000,
  "pointsRedemptionTime": 1749414725000,
  "tillId": 50671937,
  "redemptionId": "X3k8GI",
  "customFields": [
    {
      "name": "gender",
      "value": "female"
    }
  ],
  "customerId": 387952506,
  "redemptionPurpose": "Redeemed for purchase",
  "redemptionDate": "2025-06-09T02:02:04+05:30"
}