Points (v1.1)

Points represent loyalty points of an organization that are issued to the loyalty customers through different sources such as Loyalty Manager, Data Import (import profiles) and Member Care (GoodWill points). Customers can redeem their points against transactions.

📘

Points cannot be issued through APIs. It can be issued only through modules such as Loyalty Manager, Data Import and Member Care.

The APIs of points entity are interdependent. For example, to redeem points, first you need to check whether a customer can redeem those points (isredeemable), validate customer’s registered mobile number by issuing validation code, and then redeem points using the validation code received by the customer.

The points entity allows you to perform the following tasks -

  • Check whether a specific number of points can be redeemed by a customer
  • Issue validation code to the registered mobile number/email id to validate customer
  • Redeem points using the validation code received by the customer

Status Codes

Success Codes

CodeDescription
800Points redeemed successfully

Error Codes

CodeDescription
686User is from campaign and has not enrolled in the loyalty program. Points redemption is not applicable for the user.
801Points you are trying to redeem are invalid
802Mobile number/email id/external id you have entered is invalid
803Unable to redeem. The points you are trying to redeem is more than the available points
804Insufficient current points.
805Insufficient lifetime points.
806Insufficient lifetime purchases amount.
807Redemptions points not divisible.
809Customer is marked as fraud.
818Current points are less than points requested for redemption.
819Points to redeem exceeds the threshold limit (maximum points that can be redeemed in a transaction).
821Points you are trying to redeem are less than the minimum points allowed.
886Unable to process points. Please try again later.
887Unable to process points. Please try again later.
888Invalid configuration. Please report to capillary support.
801Points you are trying to redeem are invalid
802Mobile number/email id/external id you have entered is invalid
803Unable to redeem. The points you are trying to redeem is more than the available points
804Insufficient current points.
805Insufficient lifetime points.
806Insufficient lifetime purchases amount.
807Unable to redeem. Make sure that the points you are trying to redeem is a multiple of . Check the points redemption configuration of your organization.
808Unable to redeem. Validation code is invalid
809Unable to process. Customer is marked as fraud
810Mismatch in points for revert API call
811The transaction number entered to redeem/revert points is invalid
812The points have been reverted already for this transaction number
813Insufficient current points available for redemption
814No points were redeemed on this transaction number
815Unable to process points at this moment. Please try again later
816Unable to find customer in this organization
817Points redemption failed.
818Points you are trying to redeem are more than the available points
819Points you are trying to redeem are more than the maximum allowed redemption limit.
Unable to send message to customer
820Unable to process. Customer is marked as fraud
821Points you are trying to redeem are less than the minimum redemption limit
822Unable to find missed call from the registered mobile number
823Missed call redemption is disabled for your organization
824Mobile number validation is mandatory for redeeming points
825Client signature is required
826Invalid points category or invalid configuration
827Unable to redeem points. Points redemption is enabled for your organization
859The redemption time you have passed is invalid
860Unable to issue OTP
881Customer is not registered into the loyalty program
888Configuration is invalid. Please report to Capillary Support
889Points processing failed. Please try again later.
894Unable to process points at this moment. Please try again later
895Loyalty program is not configured for your organization
898Unable to process points at this moment. Please try again later
899Configuration is invalid. Please report to Capillary Support
901Invalid points or points redemption Id passed.
902Redemption ID does not exist.
903Unable to redeem points.
904Invalid customer details passed.
3045Points Redemption is not allowed for the customer with id {x} as the status is fraud.
3802Points reversal redeemed points already reversed.