TransactionInformationReverse

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

object (AccountInfo)

Information related to a given tender user.

object (CheckInfo)

Information about a check associated with a transaction

discountsToRemove
Array of strings

A list of reference IDs for discounts that are to be reversed. These discounts have been removed from the check and must be added back to the users account, if applicable.

orderGuid
string <uuid>

Unique Toast order identifier associated with the refunded transaction.

originalTransactionStatus
string (TenderTransactionStatus)

Indicates the result of a tender transaction, reported by the tender service provider. This property must be present on all responses. Possible values are:

  • `ACCEPT` - The tender service provider processed the transaction successfully.
  • `ERROR_INVALID_TOAST_TRANSACTION_TYPE` - The requested Toast-Transaction-Type is not valid.
  • `ERROR_INVALID_INPUT_PROPERTIES` - The specified JSON properties in the request body are not valid.
  • `ERROR_INVALID_TOKEN` - The token supplied in the `Authorization` header field is invalid.
  • `ERROR_INVALID_RESTAURANT` - The restaurant specified by the `Toast-Restaurant-External-ID` is invalid.
  • `ERROR_ACCOUNT_INVALID` - The tender identifier provided did not correspond to an account, or the account is not valid at the current restaurant.
  • `ERROR_ACCOUNT_NO_POST` - The tender identifier provided corresponded to an account which has no card on file or has been marked as "no post".
  • `ERROR_FOLIO_IN_USE` - Some property management systems limit guest folio access to one source at a time. If the front desk agent is using the property management system to access a guest folio, it may be locked and therefore unavailable for room charge posting during that time.
  • `ERROR_INSUFFICIENT_FUNDS` - The payment or tip, specified in TENDER_RETRIEVE_PAYMENTS or TENDER_RETRIEVE_GRATUITY, cannot be retrieved because the tender account does not have sufficient balance.
  • `ERROR_UNABLE_TO_PROCESS` - The transaction cannot be processed by the partner.
  • `ERROR_TRANSACTION_DOES_NOT_EXIST` - The transaction that is being requested to be reversed or updated does not exist. Only occurs on a `TENDER_REVERSE` or `TENDER_GRATUITY` response.
  • `ERROR_TRANSACTION_CANNOT_BE_REVERSED` - The specified transaction cannot be reversed. Only `TENDER_REDEEM` and `TENDER_GRATUITY` transactions can be reversed.
Enum: "ACCEPT" "ERROR_INVALID_TOAST_TRANSACTION_TYPE" "ERROR_INVALID_INPUT_PROPERTIES" "ERROR_INVALID_TOKEN" "ERROR_INVALID_RESTAURANT" "ERROR_TRANSACTION_DOES_NOT_EXIST" "ERROR_TRANSACTION_CANNOT_BE_REVERSED" "ERROR_ACCOUNT_INVALID" "ERROR_ACCOUNT_NO_POST" "ERROR_FOLIO_IN_USE" "ERROR_INSUFFICIENT_FUNDS" "ERROR_UNABLE_TO_PROCESS"
paymentsToRemove
Array of strings

A list of reference IDs for payments that are to be reversed. These payments have been removed from the check and the funds used must be added back to the users account, if applicable.

object (TenderDiscount)

A discount to be applied to a check. In response to a TENDER_RETRIEVE_DISCOUNTS request, the Toast POS system attempts to apply the discount to the check. In the TENDER_RETRIEVE_PAYMENTS and TENDER_REDEEM request, the successfully applied discounts are included.

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.

object (TenderPayment)

Payment returned by the tender provider to be applied to the check.

transactionToUpdate
string <guid>

The identifier of an earlier tender transaction. This identifier is provided in the Toast-Transaction-GUID header parameter. The discounts and/or payments to reverse must have been added as part of this transaction. The only transactions that can be reversed are the TENDER_REDEEM and TENDER_GRATUITY transactions.

{
  • "tenderIdentifier": "string",
  • "accountInfo": {
    },
  • "transactionToUpdate": "string",
  • "discountsToRemove": [
    ],
  • "paymentsToRemove": [
    ],
  • "tenderDiscountsToRemove": {
    },
  • "tenderPaymentsToRemove": {
    },
  • "checkInfo": {
    },
  • "originalTransactionStatus": "ACCEPT",
  • "orderGuid": "c97d701b-064e-4c4d-9a3a-8063baec086f"
}