TransactionInformationGratuity

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

• accountInfo:
  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.

• checkInfo:
  object (CheckInfo)

  Information about a check associated with a transaction

• tenderCouponsApplied:
  Array of objects (TenderCoupon)

  Reserved for future use.

• transactionToUpdate:
  string <guid>

  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.

{
  "accountInfo": {
    "tenderIdentifier": "string",
    "properties": {
      "key": "string",
      "value": "string",
      "tenderPropertyType": "FOLIO",
      "maxLength": "string"
    },
    "tenderCoupons": [
      {
        "name": "string",
        "identifier": "string",
        "status": "AVAILABLE",
        "value": 0,
        "consumedTime": "2019-08-24T14:15:22Z",
        "info": "string"
      }
    ]
  },
  "transactionToUpdate": "string",
  "additionalGratuity": 0,
  "checkInfo": {
    "guid": "string",
    "displayNumber": "string"
  },
  "tenderCouponsApplied": [
    {
      "name": "string",
      "identifier": "string",
      "status": "AVAILABLE",
      "value": 0,
      "consumedTime": "2019-08-24T14:15:22Z",
      "info": "string"
    }
  ]
}