TransactionInformationReverse

Information about a gift card transaction in the Toast
platform that undoes a previous transaction. Gift card providers are expected to handle the transaction. The only types of transactions that can be reversed are GIFTCARD_ADD_VALUE, GIFTCARD_REDEEM, and GIFTCARD_ACTIVATE. If a GIFTCARD_ADD_VALUE is reversed then the amount of the original transaction should be deducted from the card's balance. If a GIFTCARD_REDEEM is reversed then the amount of the original transaction should be added to the card's balance. If a GIFTCARD_ACTIVATE is reversed then the card should be set to inactive and its balance set to 0.00. GIFTCARD_GET_BALANCE and GIFTCARD_REVERSE cannot be reversed.

giftCardIdentifier
string

The unique identifier of the gift card.

identifierSource
string

Indicates how the Toast platform received the gift card identifier string. Values are:

  • KEYED - A restaurant employee or guest manually entered the identifier string.

  • SCANNED - A restaurant employee or guest used a barcode scanner or other scanning device to enter the identifier string.

  • SWIPED - A restaurant employee or guest used a magnetic card strip reader to enter the identifier string.

  • KEYED_ONLINE - The source of this transaction is Toast Online Ordering, The provider can reject the transaction regardless of the restaurant's verification code settings.

  • UNKNOWN - The Toast platform received the identifier string using a method other than KEYED, SCANNED, or SWIPED, or the method is not known.

Enum: "KEYED" "SCANNED" "SWIPED" "KEYED_ONLINE" "UNKNOWN"
previousTransaction
string <guid>

The identifier of an earlier gift card transaction. This identifier is provided in the Toast-Transaction-GUID header parameter.

object

The verification code, also often referred to as a PIN code, for the gift card account. A verification code is an additional layer of security that some gift card providers include.

{
  • "previousTransaction": "string",
  • "giftCardIdentifier": "string",
  • "identifierSource": "KEYED",
  • "verificationCode": {
    }
}