Redeem voucher

POST /v1/public/vouchers/{id}/redeem

Redeems an issued customer voucher. Omit amount to redeem the full remaining value. Supply a positive amount smaller than the remaining value for a partial redemption; the voucher must allow partial redemption.

Authorization

X-API-Key required

Parameters

Name	Location	Type	Required	Description
id	path	string	Yes	The issued voucher's MongoDB _id.

Request body

Field	Type	Required	Description
amount	number	No	Amount to redeem. Omit to redeem the full remaining value.

Request example

curl -X POST "https://api.remyrewards.co.uk/v1/public/vouchers/66c735e253f2836fbe941234/redeem" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "amount": 10
}'

Responses

Status	Description
200	Voucher redeemed in full or in part.
400	The request is missing a required value or contains invalid data.
401	The API key is missing or invalid.
404	The requested integration resource was not found.

Success response example

{
  "success": true,
  "redeemedAmount": 10,
  "data": {
    "id": "66c735e253f2836fbe941234",
    "code": "GIFT-8HD42K",
    "title": "£25 Gift Voucher",
    "value": 25,
    "remainingValue": 15,
    "currency": "GBP",
    "status": "partial",
    "allowPartialRedemption": true,
    "expiry": "2027-08-23T23:59:59.000Z",
    "recipient": {
      "name": "Alex Morgan",
      "email": "alex@example.com"
    },
    "redemptions": [
      {
        "amount": 10,
        "type": "partial",
        "date": "2026-08-23T11:00:00.000Z"
      }
    ],
    "createdAt": "2026-08-01T09:00:00.000Z",
    "updatedAt": "2026-08-23T11:00:00.000Z"
  }
}