TransactionInformationRedeem

Information about a gift card transaction in the Toast
platform that reduces the balance of funds available from the card. For example, when the gift card is used for a purchase. Gift card providers are expected to handle the transaction.

checkIdentifier
string

The unique identifier of the check that this gift card transaction is part of. No action needs to be taken based on this identifier, it is just provided for tracking purposes.

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.

  • 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" "UNKNOWN"
isCashOut
boolean

True if this redeem transaction is a cash out transaction, false otherwise

redeemedValue
number <double>

The currency amount of the funds being redeemed from the gift card.

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.

The feature that includes the verificationCode value is in limited release. Your Toast gift cards API integration may not have access to verification code information.

{
  • "giftCardIdentifier": "string",
  • "identifierSource": "KEYED",
  • "verificationCode": {
    },
  • "redeemedValue": 0,
  • "checkIdentifier": "string",
  • "isCashOut": true
}