TransactionInformationPayments

A request for the provider to return a list of payments that apply to the check. The Toast POS system will then send a TENDER_REDEEM request with the discounts and payments applied to the check.

object (AccountInfo)

Information related to a given tender user.

amount
number <double>

The amount of the requested tender. Breakdown details can be found in the check object. If not present, the requested amount is the full amount owed on the check.

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.

Array of objects (TenderDiscount)

The list of tender discounts retrieved by the previous TENDER_RETRIEVE_DISCOUNTS call that were applied to the check.

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.

tipAmount
number <double>

The amount of the requested gratuity, in addition to the amount requested for actual payment of the check.

{
  • "tenderIdentifier": "string",
  • "accountInfo": {
    },
  • "amount": 0,
  • "tipAmount": 0,
  • "orderGuid": "string",
  • "check": {
    },
  • "tenderDiscountsApplied": [
    ]
}