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 payments and discounts

A transaction is reversed in the following situations:

  • If the restaurant employee voids the payment, the Toast POS system sends a TENDER_REVERSE request to the PMS provider to reverse the payment and any applied discounts.

  • If the restaurant employee voids the order, then the Toast POS system sends a TENDER_REVERSE request to the PMS provider.

  • If a discount times out during redemption, then the Toast POS system sends a TENDER_REVERSE request to the PMS provider.

Reverse requests can be one or more of the following:

  • Payments

  • Discounts

  • Gratuity

    Note

    A gratuity can be reversed on its own if there is a network error when the gratuity request is sent. Additionally, if a gratuity is added to a payment after TENDER_REDEEM and that payment is reversed, then the gratuity is also reversed.

In the request body, the value of transactionToUpdate is the Toast-Transaction-GUID of the TENDER_REDEEM request. The discountsToRemove and paymentsToRemove contain the discounts and payment identifiers, respectively.

Reverse request body

{
  discountsTransactionInformation: null,
  paymentsTransactionInformation: null,
  redeemTransactionInformation: null,
  gratuityTransactionInformation: null,
  reverseTransactionInformation: {
    transactionToUpdate: '9eeafc3c-fde9-425c-b617-a336e4aeb98e',
    discountsToRemove: [ '7509f8f8-2d15-4c79-bb76-eb1d3b73351a' ],
    paymentsToRemove: [ 'f4a3e9f0-bc3b-4d7f-ad40-a071d2217861' ]
  },
  searchTransactionInformation: null
}

Successful reverse response body

{
  "transactionStatus": "ACCEPT"
}