--- title: "Redeem the loyalty points of a guest" method: POST path: "/v1/invoices/{InvoiceId}/payments/loyalty_points" --- # Redeem the loyalty points of a guest `POST /v1/invoices/{InvoiceId}/payments/loyalty_points` 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. ## Path parameters - `InvoiceId` string, required ## Query parameters - `expand` string ## Response `200` 200 - object - `payment` object - `PaymentOption` object - `Id` string - `PaymentMode` integer - `PaymentName` string - `CardNumber` string - `TotalAmountPaid` number - `AmountPaid` number - `TipAmount` unknown - `SSGAmount` unknown - `FeeAmount` unknown - `CashBackAmount` unknown - `TransactionId` string - `PaymentDate` string - `CashRegisterId` unknown - `redemptions` unknown - `invoice` object - `Id` string - `InvoiceNumber` string - `GroupInvoiceId` unknown - `group_name` unknown - `ReceiptNumber` unknown - `AppointmentGroupId` unknown - `ReservationId` unknown - `IsRebooking` boolean - `Notes` unknown - `GuestId` unknown - `Guest` object - `Id` string - `Code` unknown - `FirstName` string - `MiddleName` unknown - `LastName` string - `Email` string - `MobileNumber` string - `MobilePhoneModel` object - `CountryId` integer - `Number` string - `DisplayNumber` string - `HomePhone` unknown - `HomePhoneModel` unknown - `WorkPhone` unknown - `WorkPhoneModel` unknown - `Gender` integer - `DateOfBirth` unknown - `AnniversaryDate` unknown - `Address1` string - `Address2` unknown - `City` unknown - `PostalCode` unknown - `State` object - `Id` integer - `Code` string - `Name` string - `ShortName` string - `Country` object - `Id` integer - `Code` string - `Name` string - `PhoneCode` integer - `Nationality` string - `Nationality` unknown - `ReferralSource` unknown - `ReferredGuestId` unknown - `ReceiveTransactionalSms` unknown - `ReceiveMarketingEmail` unknown - `ReceiveTransactionalEmail` unknown - `ReceiveMarketingSms` boolean - `CreationDate` unknown - `LastUpdated` unknown - `MergeIntoCode` unknown - `MergeIntoGuestId` unknown - `CenterId` string - `CenterCode` unknown - `CenterName` unknown - `GuestIndicator` string - `IsMember` integer - `DOB_IncompleteYear` unknown - `Password` unknown - `UserName` unknown - `FacebookUserId` unknown - `SocialFaceBookUserId` unknown - `SocialGoogleUserId` unknown - `hasZenotiCreds` boolean - `OldPassword` unknown - `OptInForLoyaltyProgram` unknown - `FormDetails` object[] - `AppointmentId` string - `FormId` string - `ServiceName` unknown - `ServiceDisplayName` unknown - `ServiceId` unknown - `Name` unknown - `Filled` boolean - `Submitted` boolean - `LastFilledDate` string - `FormType` integer - `LastFilledBy` unknown - `LatestVersion` unknown - `FormHistory` object[] - `Viewonly` boolean - `IsFormLocked` unknown - `ExpiryDate` unknown - `IsEditable` boolean - `IsExpired` boolean - `OwnerId` unknown - `DisplayOrder` unknown - `IsServiceForm` boolean - `SourceAppointmentDate` unknown - `Permissions` unknown - `FormFilledStatus` integer - `IsActive` boolean - `SendLinkInNotifications` boolean - `IsMinors` boolean - `LpTierInfo` string - `GuestIndicatorValue` object - `HighSpender` unknown - `Member` integer - `LowFeedback` unknown - `RegularGuest` unknown - `FirstTimer` boolean - `ReturningCustomer` unknown - `NoShow` unknown - `HasActivePackages` boolean - `HasProfileAlerts` boolean - `OtherCenterGuest` boolean - `HasCTA` boolean - `Dues` boolean - `CardOnFile` unknown - `AutoPayEnabled` boolean - `IsMemberbershipAddOnUser` integer - `HasActiveMems` integer - `ReceiveLpStmt` boolean - `GenderEnumType` unknown - `ReferralCode` unknown - `EnableAutoPay` boolean - `GuestCustomDataFilled` unknown - `Price` object - `CurrencyId` integer - `Sales` integer - `Tax` integer - `Final` integer - `Final1` integer - `Discount` integer - `Tip` integer - `SSG` integer - `RoundingCorrection` integer - `DiscountedPrice` unknown - `environmental_fee` unknown - `environmental_fee_label` unknown - `can_be_waived` boolean - `SaleDate` string - `FutureRecurringBillDate` unknown - `guest_checkin_time` unknown - `LinkedInvoiceId` unknown - `Status` integer - `InvoiceServices` object[] - `InvoiceProducts` object[] - `AppointmentProduct` object - `Product` object - `Id` string - `Name` string - `Price` object - `CurrencyId` integer - `Sales` integer - `Tax` integer - `Final` integer - `Final1` integer - `Discount` integer - `Tip` integer - `SSG` unknown - `RoundingCorrection` integer - `DiscountedPrice` unknown - `environmental_fee` unknown - `environmental_fee_label` unknown - `can_be_waived` boolean - `CategoryId` unknown - `IsRetail` boolean - `IsConsumable` boolean - `Url` unknown - `Description` unknown - `InvoiceItemId` string - `InvoiceItemAddedTime` string - `Quantity` integer - `Price` object - `CurrencyId` integer - `Sales` integer - `Tax` integer - `Final` integer - `Final1` integer - `Discount` integer - `Tip` integer - `SSG` unknown - `RoundingCorrection` integer - `DiscountedPrice` unknown - `environmental_fee` unknown - `environmental_fee_label` unknown - `can_be_waived` boolean - `Employee` object - `Id` string - `ShortName` unknown - `NickName` unknown - `FullName` string - `Email` string - `PhoneNumber` string - `MobilePhoneModel` unknown - `Gender` integer - `FirstName` string - `LastName` string - `IsAvailable` boolean - `WaiveBiometricFlag` unknown - `VanityImageUrl` unknown - `ScalingFactor` integer - `ScaledPrice` integer - `ServiceTime` integer - `DisplayName` unknown - `IdleTime` unknown - `OriginalPrice` integer - `OriginalTax` integer - `Job` unknown - `BookingInterval` integer - `schedule` unknown - `unavailable_times` unknown - `LastDate` unknown - `IsMembershipApplied` unknown - `IsPackageApplied` unknown - `IsDiscountApplied` unknown - `AppliedMembership` unknown - `AppliedPackage` unknown - `AppliedDiscount` unknown - `InvoiceMemberships` object[] - `InvoiceDayPackages` object[] - `InvoiceSeriesPackages` object[] - `InvoiceGiftCards` object[] - `InvoicePrepaidCards` object[] - `Payments` object[] - `PaymentOption` object - `Id` string - `PaymentMode` integer - `PaymentName` string - `CardNumber` string - `TotalAmountPaid` number - `AmountPaid` number - `TipAmount` integer - `SSGAmount` integer - `FeeAmount` integer - `CashBackAmount` integer - `TransactionId` string - `PaymentDate` string - `CashRegisterId` unknown - `Redemptions` object[] - `RefundItems` unknown - `Lock` boolean - `CanChangeGuest` boolean - `CenterId` string - `Center` object - `Id` string - `Country` object - `Id` integer - `Code` string - `Name` string - `PhoneCode` integer - `Nationality` string - `State` object - `Id` integer - `Code` string - `Name` string - `ShortName` string - `Name` string - `GeoLatitude` integer - `GeoLongitude` integer - `Address1` string - `Address2` string - `City` string - `ZipCode` string - `Phone1` object - `CountryId` integer - `Number` string - `DisplayNumber` string - `Phone2` object - `CountryId` integer - `Number` string - `DisplayNumber` string - `Email` string - `CenterInfo` unknown - `ServiceTaxNo` string - `TIN` string - `VAT` string - `CST` string - `CanBook` boolean - `CenterCode` string - `TimeZone` object - `Id` integer - `Name` string - `StandardName` string - `Symbol` string - `CollectFeedback` boolean - `working_hours` unknown - `AreServicesAvailableInCenter` boolean - `FeedBackLink` unknown - `FeedBackLabelText` unknown - `isPaymentEnabled` boolean - `isCenterVoided` boolean - `isServiceSaleEnabled` boolean - `isMembershipSaleEnabled` boolean - `isGiftCardSaleEnabled` boolean - `isSeriesPackageSaleEnabled` boolean - `isDealsEnabled` boolean - `EnableSelfPay` boolean - `EnableSelfCheckIn` boolean - `EnableAutoPay` boolean - `AllowSelfCheckinBefore` integer - `AllowCheckWithinRadius` integer - `Zone` object - `id` string - `name` unknown - `CollectFeedback` boolean - `IsFeedbackExpired` boolean - `BookingWizardAdvancedMode` boolean - `BookingWizardBottomPanelMode` boolean - `Refunded` boolean - `InvoiceAuthStatus` integer - `InvoiceAuthorizationStatus` integer - `InvTransactionStatusForAutoPay` integer - `InvoiceSource` integer - `is_created_from_booking_wizard` boolean - `RemoveBuddyServiceFinishSegment` unknown - `host_id` unknown - `payment_made_by` unknown - `entity_name` unknown - `email_link` unknown - `sms_link` unknown - `appointment_category_id` string - `error` unknown ## Other responses - `400` — 400 --- [API](https://skmtc.net/zenoti/apis/zenoti-authentication.md) · [All operations](https://skmtc.net/zenoti/apis/zenoti-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenoti/zenoti-authentication/revisions/e628f892391a/schema)