Redeem the loyalty points of a guest

Use this API to redeem a guest’s applicable loyalty points while taking payment for an invoice.

You must specify appropriate details for the InvoiceId parameter in the API request. Optionally, you can provide the required value for the expand parameter.

In addition, you can specify the necessary details for the body parameters.

Request Body Details

NameTypeDescription
pointsdecimalNumber of loyalty points that can be redeemed for the payment of this invoice.
center_idguidUnique 32-character identifier of the center at which the loyalty points redemption is applicable.
program_idguidUnique 32-character identifier of the guest's loyalty program by using which loyalty points can be redeemed.
cash_register_idguidUnique 32-character identifier of the cash register that is used to receive payment for the invoice.
redeem_across_programsintIndicates 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.
otpstringOTP that the guest receives to redeem the applicable loyalty points.

Response Details

NameTypeDescription
paymentobjectObject that contains the invoice payment-related details.
redemptionsobjectObject that contains the loyalty points redemption-related details.
invoiceobjectObject that contains the invoice details-related elements.
errorobjectObject that contains error message and error code details. For more information, refer to the error Object table.

error Object

codemessage
502Points to redeem can not be more than the Points Balance. Current balance: 6430.
502Invalid points.
502InvoiceId is not passed.
502Invalid CenterId.
502Please enter a valid OTP.
502Balance Insufficient.
502Redemptions cannot be applied once a payment is made using a pre-paid instrument such as membership, gift card, pre-paid card or loyalty points. To continue with redemption, you must first remove these payments.
502ProgramId is not valid.
502Points to redeem can not be more than the Maximum points allowed for redemption. Max points to redeem: 9.00.
502Can not redeem points to purchase any items as per the organization settings.
502Loyalty points can not be used to redeem any item in the invoice.
502Points to redeem should be in the multiples of 3.
502Can't redeem points as the guest is in non redeemable tier.
Language
Authorization
Header
Click Try It! to start a request and see the response here!