Collect tip amount by using a guest's credit/debit card

This API helps you to charge a tip amount for the specified invoice from a guest's saved credit/debit card.

You can add the tip while taking payment for the invoice amount. You can also charge only the tip amount for an invoice, after the invoice payment has been completed.

For example, if the amount of an invoice is $100 and the tip amount is $15, you can charge a total of $115 from the guest's card at one go. Alternatively, you can first complete the invoice payment of $100 and then add the $15 tip amount.

After you have taken payment for the invoice amount and tip amount, you can close the invoice.

You must provide appropriate data for the invoice_id parameter.

Request Body Details

NameTypeDescription
account_idguidUnique 32-character ID of the guest's saved card, if the tip amount is to be charged from a saved card. This is an optional parameter.
center_idguidUnique 32-character ID of the center.
tip_amountdecimalTip amount charged from the guest's card.

Reponse Details

NameTypeDescription
invoice_transaction_idguidUnique 32-character ID of the invoice payment.
token_idstringToken to initialize the charging of the tip amount as part of the invoice payment.
successbooleanIf true, it indicates that the tip amount was successfully charged by using the guest's card.

Error Message Details

Error MessageError CodeDescription
InvalidInput502If the request is not valid.
MissingInput503If the invoice_id is not specified.
InvoiceNotFound418If the invoice_id could not be found.
ApiPaymentCannotBeAddedForClosedInvoice728If the invoice has already been closed. Tips cannot be added for a closed invoice.
MissingInput503If the center_id is not valid.
UserNotFound405If the guest could not be found.
UserNotAuthorized438If the Zenoti user does not have the permissions to charge tips from the guest's card.
PaymentIsAlreadyMade460If the guest has already paid the invoice amount.
InvoiceinGroup928If the invoice is associated to a group. Payment cannot be added for an invoice that is associated to a group.
CardReaderNotFound900If the payment configuration of the card reader has not been done.
PaymentAccountNotFound421If the payment account with ID as PaymentaccountID was not found.
InvoiceDeteleted912If the invoice has already been deleted.
PaymentAmountMoreThanDue913If the payment amount is more than the due amount. You must reload the invoice and then proceed.
ScheduleAlreadyCollected914If the payment for this schedule of the employee has already been processed.
SomethingWentWrong4023If it was not possible to initiate the credit card payment for the guest.
Language
Authorization
Header
Click Try It! to start a request and see the response here!