LoyaltyTransaction

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

The set of information in this object depends on the loyalty transaction type. The transaction type is specified in the Toast-Transaction-Type header parameter for the request, and within the body of the request.

The LoyaltyTransaction object includes the the toastTransactionType value, which will be the same as the value in the header. It will also include one of the following values depending on the transaction type:

  • LOYALTY_INQUIRE - checkTransactionInformation
  • LOYALTY_SEARCH - searchTransactionInformation
  • LOYALTY_REDEEM - checkTransactionInformation
  • LOYALTY_ACCRUE - checkTransactionInformation
  • LOYALTY_REVERSE - reverseTransactionInformation
  • LOYALTY_TRANSFER - transferTransactionInformation
object (TransactionInformationCheck)

Information needed to complete an inquire, redeem, or accrue transaction. Included if the toastTransactionType is one of LOYALTY_INQUIRE, LOYALTY_REDEEM, or LOYALTY_ACCRUE, absent otherwise.

object (TransactionInformationReverse)

Information needed to complete a reverse transaction. Included if the toastTransactionType is LOYALTY_REVERSE, absent otherwise.

object (TransactionInformationSearch)

Information needed to complete a search transaction. Included if the toastTransactionType is LOYALTY_SEARCH, absent otherwise.

toastTransactionType
string

The transaction type that is included in the header is duplicated here in the body of the request.

Enum: "LOYALTY_INQUIRE" "LOYALTY_SEARCH" "LOYALTY_REDEEM" "LOYALTY_ACCRUE" "LOYALTY_REVERSE" "LOYALTY_TRANSFER"
object (TransactionInformationTransfer)

Information needed to complete a transfer transaction. Included if the toastTransactionType is LOYALTY_TRANSFER, absent otherwise.

{
  • "toastTransactionType": "LOYALTY_INQUIRE",
  • "searchTransactionInformation": {
    },
  • "checkTransactionInformation": {
    },
  • "reverseTransactionInformation": {
    },
  • "transferTransactionInformation": {
    }
}