TransactionInformationDiscounts

A request for the provider to return a list of discounts (if any) that apply to the given check. The Toast POS system will then send a TENDER_RETRIEVE_PAYMENTS request with the discounts applied to the check.

object (AccountInfo)

Information related to a given tender user.

object (Check)

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

orderGuid
string <guid>

The GUID 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.

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 partner.

totalDiscountable
number <double>

Total amount that can be discounted on the check.

{
  • "tenderIdentifier": "string",
  • "accountInfo": {
    },
  • "orderGuid": "string",
  • "check": {
    },
  • "totalDiscountable": 0
}