Update redeem points

This API allows you to update points redemption. The fields that can be updated are:

  • bill_id
  • bill_number
  • purpose

👍

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

API specifications

FeatureAvailability
Authentication supportedBasic
PaginationNot supported
Batch supportNot supported
Access GroupYes

API endpoint example

https://eucrm.cc.capillarytech.com/v2/points/updateRedemption

Request body parameters

ParameterData TypeDescription
redemptionId*StringA unique identifier for the redemption process.
externalReferenceNumber*StringUnique reference number associated with the bill.
billNumberStringA string identifier for the bill.
billIdIntegerA numerical identifier for the bill. The maximum number of supported characters is 19.
purposeStringThe purpose or reason for the transaction.
entityObjectAn object containing details about the entity.
entity.typeEnumThe type of entity involved in the transaction.
entity.identifierTypeEnumThe type of identifier used for the entity.
entity.identifierValueStringThe value of the identifier for the entity.

Note: It is mandatory to pass either redemptionId or externalReferenceNumber.

{
    "redemptionId": "8878ru",
    "billNumber": "number7939623972",
    "billId": 12345,
    "purpose": "Testing",   
    "entity": {
        "type": "CUSTOMER",
        "identifierType": "mobile",
        "identifierValue": "917939623972"
    }

}

Response parameters

ParameterData TypeDescription
idIntegerA unique identifier for the transaction.
programIdIntegerIdentifier for the associated program.
pointsRedeemedFloatThe number of points redeemed in the transaction.
billIdIntegerA numerical identifier for the bill.
billNumberStringA string identifier for the bill.
validationCodeStringA code used for validating the transaction.
notesStringAdditional notes or comments about the transaction.
redemptionTimeLong (Epoch time)Timestamp of when the redemption occurred.
pointsRedemptionTimeLong (Epoch time)Timestamp of when the points were redeemed.
tillIdIntegerIdentifier for the till where the transaction occurred.
tillNameStringName of the till where the transaction occurred.
pointDeductionListArrayList of point deductions involved in the transaction.
redemptionIdStringA unique identifier for the redemption process.
customerIdIntegerIdentifier for the customer involved in the transaction.
redemptionPurposeStringThe purpose or reason for the redemption.
redemptionDateString (Date-Time)The date and time of redemption in ISO 8601 format.
warningsArrayList of any warnings related to the transaction.
{
    "id": 396023,
    "programId": 1098,
    "pointsRedeemed": 100.0,
    "billId": 12345,
    "billNumber": "number7939623972",
    "validationCode": "",
    "notes": "Redemption by SMS",
    "redemptionTime": 1721991144000,
    "pointsRedemptionTime": 1721971345000,
    "tillId": 50149495,
    "tillName": "",
    "pointDeductionList": [],
    "externalReferenceNumber": "ACR-5801353177",
    "redemptionId": "8878ru",
    "customerId": 346926900,
    "redemptionPurpose": "Testing",
    "redemptionDate": "2024-07-26T10:52:24Z",
    "warnings": []
}

API-specific error codes

Error codeDescription
748No metadata update requested.
749Exactly one redemption identifier needed to identify redemption.
750Redemption update failed : {0}.
1219Entity details not set/invalid.
1212Entity type passed is not valid.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!