Toast · Schema

GiftCardInfo

Reserved for future use.

RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations
View JSON Schema on GitHub

JSON Schema

orders-gift-card-info-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/orders-gift-card-info-schema.json",
  "title": "GiftCardInfo",
  "description": "Reserved for future use.",
  "type": "object",
  "required": [
    "cardNumberIdentifier",
    "last4CardDigits"
  ],
  "allOf": [
    {
      "$ref": "#/$defs/ToastReference"
    },
    {
      "type": "object",
      "properties": {
        "last4CardDigits": {
          "type": "string",
          "description": "The last 4 digits of the gift card that was used."
        },
        "first5CardDigits": {
          "x-toast-read-only": true,
          "type": "string",
          "description": "The first 5 digits of the gift card that was used. Response only."
        }
      }
    }
  ],
  "$defs": {
    "ToastReference": {
      "type": "object",
      "description": "A wrapper object with fields that allow reference to a Toast entity by Toast GUID.",
      "required": [
        "guid",
        "entityType"
      ],
      "properties": {
        "guid": {
          "description": "The GUID maintained by the Toast platform.",
          "type": "string",
          "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1"
        },
        "entityType": {
          "x-toast-read-only": true,
          "description": "The type of object this is. Response only.",
          "type": "string",
          "example": "string"
        }
      }
    }
  }
}