This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Reverse

The reverse workflow occurs when a restaurant employee voids (undoes) a guest's check or voids items that were affected by a loyalty program offer.

Reverse workflow

  1. The POS sends a reverse request. The request body includes a TransactionInformationReverse object holding the following information:

    • The loyalty program account information that identifies the guest.

    • The identifier of the previous loyalty program transaction that needs to be reversed. The identifier of a transaction is in the Toast-Transaction-GUID header parameter of the transaction request.

  2. Your loyalty program integration responds to the response request. The request body indicates the success or failure of the reverse transaction.

Loyalty reverse request

{
  "toastTransactionType":"LOYALTY_REVERSE",
  "searchTransactionInformation":null,
  "checkTransactionInformation":null,
  "reverseTransactionInformation":{
    "loyaltyIdentifier":"1",
    "transactionId":"ab11d469-5ed5-4daa-b9d6-addefdb1c1f7",
    "redemptions":[
      {
        "identifier":"5",
        "appliedDiscountGuid":"64456691-c34e-4784-9c6e-fc514a0f4b7b",
        "selectionGuid":null,
        "amount":0.01,
        "quantity":1
      },
      {
        "identifier":"5",
        "appliedDiscountGuid":"64456691-c34e-4784-9c6e-fc514a0f4b7b",
        "selectionGuid":null,
        "amount":0.01,
        "quantity":1
      }
    ]
  }
}

Successful loyalty reverse

{
  "transactionStatus":"ACCEPT"
}