Google Pay · Schema

GiftCardObjectAddMessageResponse

Agentic CommerceCheckoutContactless PaymentsDigital WalletMerchantsMobile PaymentsPaymentsTokenization

Properties

Name Type Description
resource object
View JSON Schema on GitHub

JSON Schema

google-pay-gift-card-object-add-message-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-pay/json-schema/google-pay-gift-card-object-add-message-response-schema.json",
  "title": "GiftCardObjectAddMessageResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-pay-giftcardobject-api-openapi.yml#/components/schemas/GiftCardObjectAddMessageResponse",
  "type": "object",
  "properties": {
    "resource": {
      "$ref": "#/$defs/GiftCardObject"
    }
  },
  "$defs": {
    "AppLinkData": {
      "type": "object",
      "properties": {
        "androidAppLinkInfo": {
          "$ref": "#/$defs/AppLinkDataAppLinkInfo"
        },
        "iosAppLinkInfo": {
          "$ref": "#/$defs/AppLinkDataAppLinkInfo"
        },
        "displayText": {
          "$ref": "#/$defs/LocalizedString"
        },
        "webAppLinkInfo": {
          "$ref": "#/$defs/AppLinkDataAppLinkInfo"
        }
      }
    },
    "AppLinkDataAppLinkInfo": {
      "type": "object",
      "properties": {
        "title": {
          "$ref": "#/$defs/LocalizedString"
        },
        "appTarget": {
          "$ref": "#/$defs/AppLinkDataAppLinkInfoAppTarget"
        },
        "appLogoImage": {
          "$ref": "#/$defs/Image"
        },
        "description": {
          "$ref": "#/$defs/LocalizedString"
        }
      }
    },
    "AppLinkDataAppLinkInfoAppTarget": {
      "type": "object",
      "properties": {
        "packageName": {
          "type": "string",
          "description": "Package name for AppTarget. For example: com.google.android.gm"
        },
        "targetUri": {
          "$ref": "#/$defs/Uri"
        }
      }
    },
    "Barcode": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "description": "The value encoded in the barcode."
        },
        "renderEncoding": {
          "type": "string",
          "description": "The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.",
          "enum": [
            "RENDER_ENCODING_UNSPECIFIED",
            "UTF_8"
          ]
        },
        "alternateText": {
          "type": "string",
          "description": "An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned."
        },
        "kind": {
          "type": "string",
          "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#barcode\"`."
        },
        "type": {
          "type": "string",
          "description": "The type of barcode.",
          "enum": [
            "BARCODE_TYPE_UNSPECIFIED",
            "AZTEC",
            "aztec",
            "CODE_39",
            "code39",
            "CODE_128",
            "code128",
            "CODABAR",
            "codabar",
            "DATA_MATRIX",
            "dataMatrix",
            "EAN_8",
            "ean8",
            "EAN_13",
            "ean13",
            "EAN13",
            "ITF_14",
            "itf14",
            "PDF_417",
            "pdf417",
            "PDF417",
            "QR_CODE",
            "qrCode",
            "qrcode",
            "UPC_A",
            "upcA",
            "TEXT_ONLY",
            "textOnly"
          ]
        },
        "showCodeText": {
          "$ref": "#/$defs/LocalizedString"
        }
      }
    },
    "BarcodeSectionDetail": {
      "type": "object",
      "properties": {
        "fieldSelector": {
          "$ref": "#/$defs/FieldSelector"
        }
      }
    },
    "CallbackOptions": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot."
        },
        "updateRequestUrl": {
          "type": "string",
          "description": "URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated."
        }
      }
    },
    "CardBarcodeSectionDetails": {
      "type": "object",
      "properties": {
        "firstBottomDetail": {
          "$ref": "#/$defs/BarcodeSectionDetail"
        },
        "firstTopDetail": {
          "$ref": "#/$defs/BarcodeSectionDetail"
        },
        "secondTopDetail": {
          "$ref": "#/$defs/BarcodeSectionDetail"
        }
      }
    },
    "CardRowOneItem": {
      "type": "object",
      "properties": {
        "item": {
          "$ref": "#/$defs/TemplateItem"
        }
      }
    },
    "CardRowTemplateInfo": {
      "type": "object",
      "properties": {
        "twoItems": {
          "$ref": "#/$defs/CardRowTwoItems"
        },
        "threeItems": {
          "$ref": "#/$defs/CardRowThreeItems"
        },
        "oneItem": {
          "$ref": "#/$defs/CardRowOneItem"
        }
      }
    },
    "CardRowThreeItems": {
      "type": "object",
      "properties": {
        "endItem": {
          "$ref": "#/$defs/TemplateItem"
        },
        "middleItem": {
          "$ref": "#/$defs/TemplateItem"
        },
        "startItem": {
          "$ref": "#/$defs/TemplateItem"
        }
      }
    },
    "CardRowTwoItems": {
      "type": "object",
      "properties": {
        "endItem": {
          "$ref": "#/$defs/TemplateItem"
        },
        "startItem": {
          "$ref": "#/$defs/TemplateItem"
        }
      }
    },
    "CardTemplateOverride": {
      "type": "object",
      "properties": {
        "cardRowTemplateInfos": {
          "type": "array",
          "description": "Template information for rows in the card view. At most three rows are allowed to be specified.",
          "items": {
            "$ref": "#/$defs/CardRowTemplateInfo"
          }
        }
      }
    },
    "ClassTemplateInfo": {
      "type": "object",
      "properties": {
        "cardTemplateOverride": {
          "$ref": "#/$defs/CardTemplateOverride"
        },
        "listTemplateOverride": {
          "$ref": "#/$defs/ListTemplateOverride"
        },
        "cardBarcodeSectionDetails": {
          "$ref": "#/$defs/CardBarcodeSectionDetails"
        },
        "detailsTemplateOverride": {
          "$ref": "#/$defs/DetailsTemplateOverride"
        }
      }
    },
    "DateTime": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones."
        }
      }
    },
    "DetailsItemInfo": {
      "type": "object",
      "properties": {
        "item": {
          "$ref": "#/$defs/TemplateItem"
        }
      }
    },
    "DetailsTemplateOverride": {
      "type": "object",
      "properties": {
        "detailsItemInfos": {
          "type": "array",
          "description": "Information for the \"nth\" item displayed in the details list.",
          "items": {
            "$ref": "#/$defs/DetailsItemInfo"
          }
        }
      }
    },
    "FieldReference": {
      "type": "object",
      "description": "Reference definition to use with field overrides.",
      "properties": {
        "dateFormat": {
          "type": "string",
          "description": "Only valid if the `fieldPath` references a date field. Chooses how the date field will be formatted and displayed in the UI.",
          "enum": [
            "DATE_FORMAT_UNSPECIFIED",
            "DATE_TIME",
            "dateTime",
            "DATE_ONLY",
            "dateOnly",
            "TIME_ONLY",
            "timeOnly",
            "DATE_TIME_YEAR",
            "dateTimeYear",
            "DATE_YEAR",
            "dateYear",
            "YEAR_MONTH",
            "YEAR_MONTH_DAY"
          ]
        },
        "fieldPath": {
          "type": "string",
          "description": "Path to the field being referenced, prefixed with \"object\" or \"class\" and separated with dots. For example, it may be the string \"object.purchaseDetails.purchasePrice\"."
        }
      }
    },
    "FieldSelector": {
      "type": "object",
      "description": "Custom field selector to use with field overrides.",
      "properties": {
        "fields": {
          "type": "array",
          "description": "If more than one reference is supplied, then the first one that references a non-empty field will be displayed.",
          "items": {
            "$ref": "#/$defs/FieldReference"
          }
        }
      }
    },
    "FirstRowOption": {
      "type": "object",
      "properties": {
        "fieldOption": {
          "$ref": "#/$defs/FieldSelector"
        },
        "transitOption": {
          "type": "string",
          "enum": [
            "TRANSIT_OPTION_UNSPECIFIED",
            "ORIGIN_AND_DESTINATION_NAMES",
            "originAndDestinationNames",
            "ORIGIN_AND_DESTINATION_CODES",
            "originAndDestinationCodes",
            "ORIGIN_NAME",
            "originName"
          ]
        }
      }
    },
    "GiftCardClass": {
      "type": "object",
      "properties": {
        "allowBarcodeRedemption": {
          "type": "boolean",
          "description": "Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed."
        },
        "callbackOptions": {
          "$ref": "#/$defs/CallbackOptions"
        },
        "locations": {
          "type": "array",
          "description": "Note: This field is currently not supported to trigger geo notifications.",
          "items": {
            "$ref": "#/$defs/LatLongPoint"
          }
        },
        "wideProgramLogo": {
          "$ref": "#/$defs/Image"
        },
        "multipleDevicesAndHoldersAllowedStatus": {
          "type": "string",
          "description": "Identifies whether multiple users and devices will save the same object referencing this class.",
          "enum": [
            "STATUS_UNSPECIFIED",
            "MULTIPLE_HOLDERS",
            "ONE_USER_ALL_DEVICES",
            "ONE_USER_ONE_DEVICE",
            "multipleHolders",
            "oneUserAllDevices",
            "oneUserOneDevice"
          ]
        },
        "localizedPinLabel": {
          "$ref": "#/$defs/LocalizedString"
        },
        "localizedCardNumberLabel": {
          "$ref": "#/$defs/LocalizedString"
        },
        "appLinkData": {
          "$ref": "#/$defs/AppLinkData"
        },
        "merchantName": {
          "type": "string",
          "description": "Merchant name, such as \"Adam's Apparel\". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens."
        },
        "merchantLocations": {
          "type": "array",
          "description": "Merchant locations. There is a maximum of ten on the class. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.",
          "items": {
            "$ref": "#/$defs/MerchantLocation"
          }
        },
        "kind": {
          "type": "string",
          "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#giftCardClass\"`."
        },
        "localizedEventNumberLabel": {
          "$ref": "#/$defs/LocalizedString"
        },
        "securityAnimation": {
          "$ref": "#/$defs/SecurityAnimation"
        },
        "linksModuleData": {
          "$ref": "#/$defs/LinksModuleData"
        },
        "viewUnlockRequirement": {
          "type": "string",
          "description": "View Unlock Requirement options for the gift card.",
          "enum": [
            "VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED",
            "UNLOCK_NOT_REQUIRED",
            "UNLOCK_REQUIRED_TO_VIEW"
          ]
        },
        "enableSmartTap": {
          "type": "boolean",
          "description": "Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap."
        },
        "cardNumberLabel": {
          "type": "string",
          "description": "The label to display for the card number, such as \"Card Number\"."
        },
        "version": {
          "type": "string",
          "format": "int64",
          "description": "Deprecated"
        },
        "localizedIssuerName": {
          "$ref": "#/$defs/LocalizedString"
        },
        "pinLabel": {
          "type": "string",
          "description": "The label to display for the PIN, such as \"4-digit PIN\"."
        },
        "issuerName": {
          "type": "string",
          "description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens."
        },
        "review": {
          "$ref": "#/$defs/Review"
        },
        "homepageUri": {
          "$ref": "#/$defs/Uri"
        },
        "heroImage": {
          "$ref": "#/$defs/Image"
        },
        "messages": {
          "type": "array",
          "description": "An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.",
          "items": {
            "$ref": "#/$defs/Message"
          }
        },
        "redemptionIssuers": {
          "type": "array",
          "description": "Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.",
          "items": {
            "type": "string",
            "format": "int64"
          }
        },
        "hexBackgroundColor": {
          "type": "string",
          "description": "The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`."
        },
        "reviewStatus": {
          "type": "string",
          "description": "Required. The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.",
          "enum": [
            "REVIEW_STATUS_UNSPECIFIED",
            "UNDER_REVIEW",
            "underReview",
            "APPROVED",
            "approved",
            "REJECTED",
            "rejected",
            "DRAFT",
            "draft"
          ]
        },
        "notifyPreference": {
          "type": "string",
          "description": "Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.",
          "enum": [
            "NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED",
            "NOTIFY_ON_UPDATE"
          ]
        },
        "countryCode": {
          "type": "string",
          "description": "Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale."
        },
        "programLogo": {
          "$ref": "#/$defs/Image"
        },
        "valueAddedModuleData": {
          "type": "array",
          "description": "Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.",
          "items": {
            "$ref": "#/$defs/ValueAddedModuleData"
          }
        },
        "imageModulesData": {
          "type": "array",
          "description": "Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.",
          "items": {
            "$ref": "#/$defs/ImageModuleData"
          }
        },
        "localizedMerchantName": {
          "$ref": "#/$defs/LocalizedString"
        },
        "wordMark": {
          "$ref": "#/$defs/Image"
        },
        "eventNumberLabel": {
          "type": "string",
          "description": "The label to display for event number, such as \"Target Event #\"."
        },
        "textModulesData": {
          "type": "array",
          "description": "Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.",
          "items": {
            "$ref": "#/$defs/TextModuleData"
          }
        },
        "classTemplateInfo": {
          "$ref": "#/$defs/ClassTemplateInfo"
        },
        "allowMultipleUsersPerObject": {
          "type": "boolean",
          "description": "Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead."
        },
        "infoModuleData": {
          "$ref": "#/$defs/InfoModuleData"
        },
        "id": {
          "type": "string",
          "description": "Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'."
        }
      }
    },
    "GiftCardObject": {
      "type": "object",
      "properties": {
        "version": {
          "type": "string",
          "format": "int64",
          "description": "Deprecated"
        },
        "rotatingBarcode": {
          "$ref": "#/$defs/RotatingBarcode"
        },
        "infoModuleData": {
          "$ref": "#/$defs/InfoModuleData"
        },
        "imageModulesData": {
          "type": "array",
          "description": "Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.",
          "items": {
            "$ref": "#/$defs/ImageModuleData"
          }
        },
        "groupingInfo": {
          "$ref": "#/$defs/GroupingInfo"
        },
        "smartTapRedemptionValue": {
          "type": "string",
          "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported."
        },
        "merchantLocations": {
          "type": "array",
          "description": "Merchant locations. There is a maximum of ten on the object. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.",
          "items": {
            "$ref": "#/$defs/MerchantLocation"
          }
        },
        "heroImage": {
          "$ref": "#/$defs/Image"
        },
        "eventNumber": {
          "type": "string",
          "description": "The card's event number, an optional field used by some gift cards."
        },
        "balanceUpdateTime": {
          "$ref": "#/$defs/DateTime"
        },
        "notifyPreference": {
          "type": "string",
          "description": "Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.",
          "enum": [
            "NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED",
            "NOTIFY_ON_UPDATE"
          ]
        },
        "classId": {
          "type": "string",
          "description": "Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you."
        },
        "barcode": {
          "$ref": "#/$defs/Barcode"
        },
        "linksModuleData": {
          "$ref": "#/$defs/LinksModuleData"
        },
        "state": {
          "type": "string",
          "description": "Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the \"Expired passes\" section.",
          "enum": [
            "STATE_UNSPECIFIED",
            "ACTIVE",
            "active",
            "COMPLETED",
            "completed",
            "EXPIRED",
            "expired",
            "INACTIVE",
            "inactive"
          ]
        },
        "disableExpirationNotification": {
          "type": "boolean",
          "description": "Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers."
        },
        "hasUsers": {
          "type": "boolean",
          "description": "Indicates if the object has users. This field is set by the platform."
        },
        "locations": {
          "type": "array",
          "description": "Note: This field is currently not supported to trigger geo notifications.",
          "items": {
            "$ref": "#/$defs/LatLongPoint"
          }
        },
        "classReference": {
          "$ref": "#/$defs/GiftCardClass"
        },
        "cardNumber": {
          "type": "string",
          "description": "Required. The card's number."
        },
        "validTimeInterval": {
          "$ref": "#/$defs/TimeInterval"
        },
        "id": {
          "type": "string",
          "description": "Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'."
        },
        "linkedObjectIds": {
          "type": "array",
          "description": "linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.",
          "items": {
            "type": "string"
          }
        },
        "saveRestrictions": {
          "$ref": "#/$defs/SaveRestrictions"
        },
        "balance": {
          "$ref": "#/$defs/Money"
        },
        "kind": {
          "type": "string",
          "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#giftCardObject\"`."
        },
        "messages": {
          "type": "array",
          "description": "An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.",
          "items": {
            "$ref": "#/$defs/Message"
          }
        },
        "hasLinkedDevice": {
          "type": "boolean",
          "description": "Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information."
        },
        "passConstraints": {
          "$ref": "#/$defs/PassConstraints"
        },
        "valueAddedModuleData": {
          "type": "array",
          "description": "Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.",
          "items": {
            "$ref": "#/$defs/ValueAddedModuleData"
          }
        },
        "appLinkData": {
          "$ref": "#/$defs/AppLinkData"
        },
        "pin": {
          "type": "string",
          "description": "The card's PIN."
        },
        "textModulesData": {
          "type": "array",
          "description": "Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.",
          "items": {
            "$ref": "#/$defs/TextModuleData"
          }
        }
      }
    },
    "GroupingInfo": {
      "type": "object",
      "properties": {
        "sortIndex": {
          "type": "integer",
          "format": "int32",
          "description": "Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined."
        },
        "groupingId": {
          "type": "string",
          "description": "Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed."
        }
      }
    },
    "Image": {
      "type": "object",
      "description": "Wrapping type for Google hosted images.",
      "properties": {
        "privateImageId": {
          "type": "string",
          "description": "An ID for an already uploaded private image. Either this or source_uri should be set. Requests setting both or neither will be rejected. Please contact support to use private images."
        },
        "sourceUri": {
          "$ref": "#/$defs/ImageUri"
        },
        "kind": {
          "type": "string",
          "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#image\"`."
        },
        "contentDescription": {
          "$ref": "#/$defs/LocalizedString"
        }
      }
    },
    "ImageModuleData": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID associated with an image module. This field is here to enable ease of management of image modules."
        },
        "mainImage": {
          "$ref": "#/$defs/Image"
        }
      }
    },
    "ImageUri": {
      "type": "object",
      "properties": {
        "uri": {
          "type": "string",
          "description": "The location of the image. URIs must have a scheme."
        },
        "localizedDescription": {
          "$ref": "#/$defs/LocalizedString"
        },
        "description": {
          "type": "string",
          "description": "Additional information about the image, which is unused and retained only for backward compatibility."
        }
      }
    },
    "InfoModuleData": {
      "type": "object",
      "properties": {
        "labelValueRows": {
          "type": "array",
          "description": "A list of collections of labels and values. These will be displayed one after the other in a singular column.",
          "items": {
            "$ref": "#/$defs/LabelValueRow"
          }
        },
        "showLastUpdateTime": {
          "type": "boolean"
        }
      }
    },
    "LabelValue": {
      "type": "object",
      "description": "A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.",
      "properties": {
        "label": {
          "type": "string",
          "description": "The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout."
        },
        "localizedLabel": {
          "$ref": "#/$defs/LocalizedString"
        },
        "localizedValue": {
          "$ref": "#/$defs/LocalizedString"
        },
        "value": {
          "type": "string",
          "description": "The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout."
        }
      }
    },
    "LabelValueRow": {
      "type": "object",
      "properties": {
        "columns": {
          "type": "array",
          "description": "A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.",
          "items": {
            "$ref": "#/$defs/LabelValue"
          }
        }
      }
    },
    "LatLongPoint": {
      "type": "object",
      "properties": {
        "longitude": {
          "type": "number",
          "format": "double",
          "description": "The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected."
        },
        "kind": {
          "type": "string",
          "description": "Identifies what kind

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://artifacts.apis.io/google-pay/json-schema/google-pay-gift-card-object-add-message-response-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/google-pay-gift-card-object-add-message-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.