v1

latestOpenAPI 3.0.02026-07-247251950.2 KB

Loyalty Program

Redeem a guest's loyalty points

Overview

Convert a guest's loyalty points into a discount voucher. Points are converted at a rate of 10 points = $1 USD (or equivalent in the specified currency).

When to Use

Points redemption - Allow guests to convert points to vouchers
Reward fulfillment - Create discount vouchers from points
Loyalty rewards - Enable points-to-cash conversion

What You Get

Voucher code - Unique code the guest can use for discounts
Voucher details - Discount type, value, validity period, and usage limits
Fixed amount voucher - Voucher with a specific discount value
Shareable voucher - Can be used by other guests

Key Features

Conversion rate - 10 points = $1 USD (or equivalent)
Currency support - Specify the currency for the voucher value
Shareable - Vouchers can be shared with other guests
Fixed amount - Creates a fixed discount amount voucher

Quick Start

Provide the guest ID and specify points (amount to redeem) and currency (e.g., "USD"). Returns a voucher code and details.

post/guests/{guestId}/loyalty-points/redeem

Path parameters

guestIdinteger required

Numeric ID of the guest to fetch

Request body

pointsinteger required

Amount of points to redeem. 10 points = $1 USD.

currencystring required

Currency in which the voucher value will be calculated.

Example request

{
  "points": 100,
  "currency": "USD"
}

Response

Example response

{
  "data": {
    "voucherCode": "0193f986",
    "userID": 633,
    "guestID": 1,
    "discountType": "fixed_amount",
    "discountValue": 90.95,
    "minimumSpend": 0,
    "maximumDiscountAmount": 9,
    "currency": "USD",
    "validityStart": "2026-07-24",
    "validityEnd": "2026-12-24",
    "usages": 0,
    "usagesLimit": 1,
    "status": "active",
    "termsAndConditions": "",
    "category": "redemption",
    "createdAt": "2026-07-24T16:36:19.820824Z",
    "updatedAt": "2026-07-24T20:36:20.002+04:00",
    "deletedAt": null
  }
}