This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Updating the tip amount for a payment

Important

To use the /orders endpoint to update a tip, you need access to the orders.payments:write scope. For more information about API client scopes, and how to get access to them, see Scopes.

You can use the orders API to update a tip, or gratuity, amount in an existing credit card payment for an order.

You can only update the tip on credit card payments that are not yet captured. The paymentStatus for the payment must be AUTHORIZED. Capturing a payment begins the process of settling that payment with credit card providers. Credit card payments are usually captured at the end of the business day for a restaurant.