Reverse Redeemed Points

Lets you reverse a set of points that are redeemed in a transaction. For example, you can use this API to reverse points redeemed for a transaction if the transaction is returned.

Prerequisites:

The following configurations are required for points/reverse API

  • Enable Allow_points_redemption_reversal config on EMF settings. Only the back-end team has access to this page. Please raise a ticket to enable the config. For more information on this feature, click here.
  • Enable V2 API as points reversal is supported only V2.0.

Request Body Parameters

ParameterTypeDescription
redemptionId*StringUnique identifier for the original redemption transaction.
pointsToBeReversedNumberNumber of points to be reversed. If not provided, all points may be reversed by default.
identifier*ObjectObject containing customer identification details.
-type*StringType of customer identifier (e.g., ID, PHONE, EMAIL).
-value*StringUnique value of the customer identifier.

Response Body Parameters

ParameterTypeDescription
orgIdNumberUnique identifier for the organization.
identifierObjectObject containing customer identification details.
-typeStringType of customer identifier.
-valueStringUnique value of the customer identifier.
customerIdNumberUnique internal identifier for the customer.
redemptionIdStringUnique identifier for the original redemption transaction.
reversalIdStringUnique identifier for the reversal transaction.
pointsToBeReversedNumberNumber of points requested to be reversed.
pointsReversedNumberNumber of points actually reversed.
pointsReversedDetailsObjectBreakdown of points reversed by type.
-availableNumberPoints reversed from the active or available balance.
-expiredNumberPoints reversed from the expired balance.
warningsArrayList of warnings, if any.
errorsArrayList of errors, if any.

API Specific Error Code

Error CodeDescriptionReason
804Unable to process points reversal requestGeneral failure while processing the reversal request. Check parameters and try again.
817Points reversal failed due to insufficient pointsThe customer does not have enough points available for reversal.
818Points reversal not allowed for this programReversal is not permitted for the given program configuration.
827Unable to reverse points; reversal is enabledReversal conditions were not met despite being enabled for the organization.
878Points decimal precision not supportedPoints value has more than 3 decimal places; maximum supported precision exceeded.
885Invalid program IDThe specified program ID is invalid or not applicable for reversal.
886Points reversal failed due to a temporary system errorInternal system issue. Retry the request later.
887Points reversal failed due to validation errorProvided parameters are invalid or failed server-side validation checks.
888Invalid configuration detectedSystem configuration error; please report to Capillary Support.
896Points reversal could not be processedTemporary failure; retry after some time.
898Points reversal currently unavailableThe reversal service is temporarily unavailable; retry later.
899Misconfigured program setupProgram setup issue; contact Capillary Support.
901Customer not eligible for points reversalCustomer does not meet eligibility criteria for reversal.
902Duplicate reversal requestA duplicate reversal request has been detected.
903Reversal limit exceededCustomer has reached the allowed reversal limit.
904Points reversal locked for this customerPoints reversal operations are temporarily locked for this customer account.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!