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.

How to update the tip amount

To update a tip amount, you send a PATCH request to the /orders/{orderGuid}/checks/{checkGuid}/payments/{paymentGuid} endpoint of the Toast orders API. You include a Payment JSON object with an updated tipAmount value. The paymentStatus on the updated payment must be AUTHORIZED, and the type must be CREDIT.

For more information, see Update a tip amount in the API reference.

To update the tip amount for an existing payment

  1. Find the Toast platform GUIDs of the order, the check, and the payment you are updating. For more information on locating order and check GUIDs, see Finding an order or check guid.

    • The response from the POST request to create an order contains the order, check, and payment GUIDs.

    • If you know the order GUID, you can send a GET request to get the order details, which include the check and payment GUIDs. See Getting detailed information about one order.

    • If you do not know the order GUID, you can send a GET request to get the details for orders that were updated during a specific time interval. See Getting detailed information about multiple orders. The order details include the order, check, and payment GUIDs.

  2. Create a JSON Payment object that includes a tipAmount value. Set the tipAmount value to the updated tip amount. For an example, see Example Payment object that updates the tip amount for an existing payment.

    For this type of request, you can only include the tipAmount value. The provided tipAmount value completely replaces any previous tip amount on the payment.

  3. Send a PATCH request to the /orders/{orderGuid}/checks/{checkGuid}/payments/{paymentGuid} endpoint of the orders API.

    In the REST request path parameters, include the Toast platform GUID of the order, the check, and the payment.

    In the request message body, include the Payment object that contains the updated tipAmount value.

  4. Examine the response that you receive from the orders API. Verify that your request is processed successfully. For an example, see Example response when you update a tip in an existing payment.