v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

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.

post/v1/invoices/{invoice_id}/online_payments

Path parameters

invoice_idstring required

Mandatory Unique 32-character ID of the specific invoice. This is a mandatory parameter.

Response

200

invoice_transaction_idstring
token_idstring
successboolean

Example response

{
  "invoice_transaction_id": "b0b61718-77c8-4b70-889f-eda59cbf3811",
  "token_id": "55482148",
  "success": true
}