Update a tip amount

Updates the tip amount in an existing payment for a check in an order. Include the new tipAmount value in a Payment object in the message body.

This endpoint does not allow any other Payment object value for a PATCH request.

Specify the Toast platform GUID of the order, check, and payment in REST path parameters.

For more information, see the Toast Developer Guide.

Securityoauth2
Request
path Parameters
checkGuid
required
string

The Toast platform identifier of the check that you are updating a tip in.

orderGuid
required
string

The Toast platform identifier of the order that you are updating a tip in.

paymentGuid
required
string

The Toast platform identifier of the payment that you are updating a tip in.

Request Body schema: application/json

A JSON Payment object containing the tipAmount value that will replace any existing tip amount for the payment.

Do not include any value other than tipAmount.

tipAmount
number <double>

The amount tipped on a payment.

Responses
200

A JSON Order object that includes the tip amount that you updated.

400

The API cannot process the request.

patch/orders/{orderGuid}/checks/{checkGuid}/payments/{paymentGuid}
Request samples
application/json
{
  • "tipAmount": 3.25
}
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "openedDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "promisedDate": "2019-08-24T14:15:22Z",
  • "channelGuid": "3c66b5cf-1850-49e6-aef3-40576e6de979",
  • "diningOption": {
    },
  • "checks": [
    ],
  • "table": {
    },
  • "serviceArea": {
    },
  • "restaurantService": {
    },
  • "revenueCenter": {
    },
  • "source": "string",
  • "duration": 0,
  • "deliveryInfo": {
    },
  • "requiredPrepTime": "string",
  • "estimatedFulfillmentDate": "2019-08-24T14:15:22Z",
  • "numberOfGuests": 0,
  • "voided": true,
  • "voidDate": "2019-08-24T14:15:22Z",
  • "voidBusinessDate": 0,
  • "paidDate": "2019-08-24T14:15:22Z",
  • "closedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "businessDate": 0,
  • "server": {
    },
  • "pricingFeatures": [
    ],
  • "approvalStatus": "NEEDS_APPROVAL",
  • "guestOrderStatus": "string",
  • "createdDevice": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "initialDate": 0,
  • "lastModifiedDevice": {
    },
  • "curbsidePickupInfo": {
    },
  • "deliveryServiceInfo": {
    },
  • "marketplaceFacilitatorTaxInfo": {
    },
  • "createdInTestMode": true,
  • "appliedPackagingInfo": {
    },
  • "excessFood": true,
  • "displayNumber": "string"
}