TransactionInformationGratuity

A request to add an additional gratuity to a existing tender transaction.

object (AccountInfo)

Information related to a given tender user.

additionalGratuity
number <double>

The total gratuity amount for the tender payment. If multiple gratuity requests are sent for the same transaction, the tender provider should use the most recent value as the final gratuity.

object (Check)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

object (CheckInfo)

Information about a check associated with a transaction

orderGuid
string <uuid>

The identifier of the order this check belongs to. Orders can have multiple checks, but only one check will be relevant for the transaction. The order GUID can be used to later retrieve information about the order and check from the Toast Orders API.

paymentGuid
string <uuid>

The identifier of the Toast POS payment object that the additional gratuity applies to.

Array of objects (TenderCoupon)

Reserved for future use.

tenderIdentifier
string

The unique identifier of a tender guest. This is obtained by entering a name or an email address, or anything else accepted by both the customer and the integration.

Array of objects (TenderPayment)

The tender payments from the transaction identified by transactionToUpdate that the additional gratuity applies to.

transactionToUpdate
string <uuid>

The identifier of an earlier tender transaction. This identifier is provided in the Toast-Transaction-GUID header parameter. This is the transaction for which an additional gratuity is being requested.

{
  • "tenderIdentifier": "string",
  • "accountInfo": {
    },
  • "transactionToUpdate": "95c5604d-51ac-412a-b518-2d9cd434a33f",
  • "additionalGratuity": 0,
  • "paymentGuid": "5036d706-598e-4af3-b252-a310580ddeb5",
  • "tenderPayments": [
    ],
  • "checkInfo": {
    },
  • "orderGuid": "c97d701b-064e-4c4d-9a3a-8063baec086f",
  • "check": {
    },
  • "tenderCouponsApplied": [
    ]
}