API Reference
Start typing to search…

Redeem for the AccountCoupon or Promo-codes depending on id-type value.

patch https://staging.convercus.io/v3/accountcoupons/

Redeem the specified AccountCoupon/Promo-code. List of possible error codes:

  • INTERNAL_SERVER_ERROR: Uncontrolled error during coupon redemption.
  • CONDITION_NOT_FULFILLED:One or more conditions are not meet. An additional detail field contains invalid conditions.
  • CONDITION_NOT_DEFINED:Coupon has no valid conditions and cannot redeem.
  • ACCOUNT_LOCKED:The account trying to redeem the coupon is not ACTIVE.
  • COUPON_NOT_FOUND:The coupon does not exist.
  • PROMOCODE_NOT_FOUND:The promo code does not exist.
  • COUPON_NOT_PROMOCODE:The coupon assignation type is not PROMOCODE.
  • COUPON_NOT_ACTIVATABLE:The coupon has not been activated by the account.
  • COUPON_PREVIEW_NOT_AVAILABLE:The coupon does not allow redemption preview. Only applies if coupon usage is REWARD.
  • COUPON_NOT_ASSIGNED_ACCOUNT:The coupon has not been assigned to the account.
  • COUPON_NOT_MANUAL_REDEEMABLE:The coupon cannot be redeemed manually.
  • COUPON_NOT_ACTIVATED:The coupon status is not ACTIVE.
  • COUPON_REDEMPTION_IN_PROGRESS:There is another redemption in progress for the account.
When the error code is CONDITION_NOT_FULFILLED, the detail field will contain one or more codes indicating which conditions are not fulfilled:
  • NOT_YET_REDEEMABLE (Time range): The current date is before the defined time range. Redemption will be possible in the future.
  • NO_LONGER_REDEEMABLE (Time range): The current date is after the defined time range. Coupon redemption will be no longer possible.
  • NO_MORE_REDEEM_BY_PROGRAM (Redeem limit by program condition):The coupon has reached the maximum allowed redemptions.
  • NO_MORE_REDEEM_BY_ACCOUNT (Redemption per account condition):The account has reached the maximum allowed redemptions.
  • NO_MORE_REDEEM_BY_PROMOCODE:The promo code has reached the maximum allowed redemptions.
  • WRONG_INTERACTION_POINT (Partner, Store & Program Interaction Points condition):The interaction from where the redemption takes place does not belong to the selected ones.
  • ACCOUNT_NOT_HAVE_ENOUGH_POINTS (Points balance condition):The account balance is lower than required.
  • ACCOUNT_NOT_HAVE_MEMBERSHIP (Only registered accounts condition):The account is not linked to an user.
  • ACCOUNT_NOT_HAVE_STATUS_LEVEL (Status level condition):The account does not have the required status level.
  • ACCOUNT_NOT_HAVE_RATING_LEVELS (Rating level condition): The account does not have any of the required rating level.

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!