Skip to content

Redeem coupon

This endpoint redeems a unique coupon.

/api/v1.0/Switch/Coupon/Redeem

{
  "barcode": "string",
  "customerReference": "string"
}

Response:

{
  "success": true,
  "redeemId": "string",
  "restrictedToCustomer": true,
  "coupon": {
    "barcode": "string",
    "serialNumber": "string",
    "couponRangeId": "string",
    "createdAt": "2024-12-12T12:44:04.666Z",
    "customerReference": "string",
    "status": "Redeemed",
    "validFrom": "2024-12-12T12:44:04.666Z",
    "validTo": "2024-12-12T12:44:04.666Z"
  }
}

Cancel coupon redemption

Cancels a coupon redemption. This operation is intended for immediate cancellation, e.g. rollback in checkout process.

/api/v1.0/Switch/Coupon/Redeem/Cancel