TransactionInformationGetBalance

Information about a gift card transaction in the Toast
platform that requests the currency value of the funds available from the gift card. Gift card providers are expected to handle the transaction.

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"
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.

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