v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Verify the payable loyalty points of a guest

Use this API to check how many loyalty points and the loyalty amount (in $) that a guest can redeem while paying for an invoice. You must specify appropriate details for the InvoiceId parameter. Optionally, you can provide the required values for the lp_program_id and redeem_across_programs parameters.

get/v1/guests/{InvoiceId}/payments/loyalty_points/redeemable

Path parameters

InvoiceIdstring required

Mandatory Unique 32-character identifier of the invoice for which this API will return the guest's applicable loyalty points.

Query parameters

lp_program_idstring

Optional Unique 32-character identifier of the loyalty program by using which the guest can redeem loyalty points. Default value: null.

redeem_across_programsinteger

Optional Indicates whether the guest's loyalty points can be redeemed for all loyalty programs or for a particular loyalty program. 0 - Guest's loyalty points can be redeemed for a particular loyalty program. 1 - Guest's loyalty points can be redeemed for all loyalty programs. Default value: 0. Note: If you specify the value of this parameter as 1, the API does not prioritize the value of the lp_program_id parameter.

Response

200

{"stackTrail":"paths:/v1/guests/{InvoiceId}/payments/loyalty_points/redeemable:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "lp_redeemable": {
    "points": 2131.1,
    "amount": 152.22,
    "loyalty_programs": [
      {
        "id": "e3c06c4c-9d70-482b-bc8f-585af65433c2",
        "name": "20000 Tier",
        "points": {
          "earned": 300,
          "available": 300
        }
      }
    ],
    "total_available_points": 1242.8472000000002,
    "total_available_amount": 17400,
    "exchange_rate": 0.071428
  }
}