GiftCardTransaction

Information about a gift card transaction in the Toast
platform. Gift card providers are expected to handle that transaction.

The set of information in this object depends on the gift card transaction type. The transaction type is specified in the Toast-Transaction-Type header parameter for the request.

The GiftCardTransaction object includes the following values for specific transaction types:

• GIFTCARD_ACTIVATE - includes an activateTransactionInformation value.
• GIFTCARD_ADD_VALUE - includes an addValueTransactionInformation value.
• GIFTCARD_GET_BALANCE - includes a getBalanceTransactionInformation value.
• GIFTCARD_REDEEM - includes a redeemTransactionInformation value.
• GIFTCARD_REVERSE - includes a reverseTransactionInformation value.

• activateTransactionInformation:
  object (TransactionInformationActivate)

  Information about a gift card transaction in the Toast; platform that activates a new card. Gift card providers are expected to handle the transaction.

• addValueTransactionInformation:
  object (TransactionInformationAddValue)

  Information about a gift card transaction in the Toast POS system that adds to the funds that are available on the card. Gift card providers are expected to handle the transaction.

• getBalanceTransactionInformation:
  object (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.

• redeemTransactionInformation:
  object (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.

• reverseTransactionInformation:
  object (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.

{
  "activateTransactionInformation": {
    "giftCardIdentifier": "string",
    "identifierSource": "KEYED",
    "verificationCode": {
      "value": "string",
      "source": "KEYED"
    },
    "initialBalance": 0,
    "checkIdentifier": "string"
  },
  "addValueTransactionInformation": {
    "giftCardIdentifier": "string",
    "identifierSource": "KEYED",
    "verificationCode": {
      "value": "string",
      "source": "KEYED"
    },
    "additionalValue": 0,
    "checkIdentifier": "string"
  },
  "getBalanceTransactionInformation": {
    "giftCardIdentifier": "string",
    "identifierSource": "KEYED",
    "verificationCode": {
      "value": "string",
      "source": "KEYED"
    }
  },
  "redeemTransactionInformation": {
    "giftCardIdentifier": "string",
    "identifierSource": "KEYED",
    "verificationCode": {
      "value": "string",
      "source": "KEYED"
    },
    "redeemedValue": 0,
    "checkIdentifier": "string",
    "isCashOut": true
  },
  "reverseTransactionInformation": {
    "previousTransaction": "string",
    "giftCardIdentifier": "string",
    "identifierSource": "KEYED",
    "verificationCode": {
      "value": "string",
      "source": "KEYED"
    }
  }
}