TenderTransaction

Information about a tender transaction in the Toast POS system. Tender providers are expected to handle that transaction.

The set of information in this object depends on the tender transaction type. The transaction type is specified in the Toast-Transaction-Type header parameter for the request.

The TenderTransaction object includes the following values for specific transaction types:

  • TENDER_RETRIEVE_DISCOUNTS - includes a discountsTransactionInformation value.
  • TENDER_RETRIEVE_PAYMENTS - includes a paymentsTransactionInformation value.
  • TENDER_REDEEM - includes a redeemTransactionInformation value.
  • TENDER_GRATUITY - includes a gratuityTransactionInformation value.
  • TENDER_REVERSE - includes a reverseTransactionInformation value.
  • TENDER_SEARCH_CONFIG - no additional values.
  • TENDER_SEARCH - includes an searchTransactionInformation value.
object (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 (TransactionInformationGratuity)

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

object (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 (TransactionInformationRedeem)

A request for the provider to mark as consumed the discounts and payments included in this message, that were previously retrieved with TENDER_RETRIEVE_DISCOUNTS and TENDER_RETRIEVE_PAYMENTS calls.

object (TransactionInformationReverse)

A request to reverse discounts and/or payments made as part of a previous transaction.

object (TransactionInformationSearch)

A request to search for all tender accounts that match the given search terms.

{
  • "searchTransactionInformation": {
    },
  • "discountsTransactionInformation": {
    },
  • "paymentsTransactionInformation": {
    },
  • "redeemTransactionInformation": {
    },
  • "gratuityTransactionInformation": {
    },
  • "reverseTransactionInformation": {
    }
}