Google Pay Passes API
  1. flightobject
Google Pay Passes API
  • eventticketclass
    • /walletobjects/v1/eventTicketClass
      GET
    • /walletobjects/v1/eventTicketClass
      POST
    • /walletobjects/v1/eventTicketClass/{resourceId}
      GET
    • /walletobjects/v1/eventTicketClass/{resourceId}
      PATCH
    • /walletobjects/v1/eventTicketClass/{resourceId}
      PUT
    • /walletobjects/v1/eventTicketClass/{resourceId}/addMessage
      POST
  • eventticketobject
    • /walletobjects/v1/eventTicketObject
      GET
    • /walletobjects/v1/eventTicketObject
      POST
    • /walletobjects/v1/eventTicketObject/{resourceId}
      GET
    • /walletobjects/v1/eventTicketObject/{resourceId}
      PATCH
    • /walletobjects/v1/eventTicketObject/{resourceId}
      PUT
    • /walletobjects/v1/eventTicketObject/{resourceId}/addMessage
      POST
    • /walletobjects/v1/eventTicketObject/{resourceId}/modifyLinkedOfferObjects
      POST
  • flightclass
    • /walletobjects/v1/flightClass
      GET
    • /walletobjects/v1/flightClass
      POST
    • /walletobjects/v1/flightClass/{resourceId}
      GET
    • /walletobjects/v1/flightClass/{resourceId}
      PATCH
    • /walletobjects/v1/flightClass/{resourceId}
      PUT
    • /walletobjects/v1/flightClass/{resourceId}/addMessage
      POST
  • flightobject
    • /walletobjects/v1/flightObject
      GET
    • /walletobjects/v1/flightObject
      POST
    • /walletobjects/v1/flightObject/{resourceId}
      GET
    • /walletobjects/v1/flightObject/{resourceId}
      PATCH
    • /walletobjects/v1/flightObject/{resourceId}
      PUT
    • /walletobjects/v1/flightObject/{resourceId}/addMessage
      POST
  • giftcardclass
    • /walletobjects/v1/giftCardClass
    • /walletobjects/v1/giftCardClass
    • /walletobjects/v1/giftCardClass/{resourceId}
    • /walletobjects/v1/giftCardClass/{resourceId}
    • /walletobjects/v1/giftCardClass/{resourceId}
    • /walletobjects/v1/giftCardClass/{resourceId}/addMessage
  • giftcardobject
    • /walletobjects/v1/giftCardObject
    • /walletobjects/v1/giftCardObject
    • /walletobjects/v1/giftCardObject/{resourceId}
    • /walletobjects/v1/giftCardObject/{resourceId}
    • /walletobjects/v1/giftCardObject/{resourceId}
    • /walletobjects/v1/giftCardObject/{resourceId}/addMessage
  • issuer
    • /walletobjects/v1/issuer
    • /walletobjects/v1/issuer
    • /walletobjects/v1/issuer/{resourceId}
    • /walletobjects/v1/issuer/{resourceId}
    • /walletobjects/v1/issuer/{resourceId}
  • jwt
    • /walletobjects/v1/jwt
  • loyaltyclass
    • /walletobjects/v1/loyaltyClass
    • /walletobjects/v1/loyaltyClass
    • /walletobjects/v1/loyaltyClass/{resourceId}
    • /walletobjects/v1/loyaltyClass/{resourceId}
    • /walletobjects/v1/loyaltyClass/{resourceId}
    • /walletobjects/v1/loyaltyClass/{resourceId}/addMessage
  • loyaltyobject
    • /walletobjects/v1/loyaltyObject
    • /walletobjects/v1/loyaltyObject
    • /walletobjects/v1/loyaltyObject/{resourceId}
    • /walletobjects/v1/loyaltyObject/{resourceId}
    • /walletobjects/v1/loyaltyObject/{resourceId}
    • /walletobjects/v1/loyaltyObject/{resourceId}/addMessage
    • /walletobjects/v1/loyaltyObject/{resourceId}/modifyLinkedOfferObjects
  • offerclass
    • /walletobjects/v1/offerClass
    • /walletobjects/v1/offerClass
    • /walletobjects/v1/offerClass/{resourceId}
    • /walletobjects/v1/offerClass/{resourceId}
    • /walletobjects/v1/offerClass/{resourceId}
    • /walletobjects/v1/offerClass/{resourceId}/addMessage
  • offerobject
    • /walletobjects/v1/offerObject
    • /walletobjects/v1/offerObject
    • /walletobjects/v1/offerObject/{resourceId}
    • /walletobjects/v1/offerObject/{resourceId}
    • /walletobjects/v1/offerObject/{resourceId}
    • /walletobjects/v1/offerObject/{resourceId}/addMessage
  • permissions
    • /walletobjects/v1/permissions/{resourceId}
    • /walletobjects/v1/permissions/{resourceId}
  • smarttap
    • /walletobjects/v1/smartTap
  • transitclass
    • /walletobjects/v1/transitClass
    • /walletobjects/v1/transitClass
    • /walletobjects/v1/transitClass/{resourceId}
    • /walletobjects/v1/transitClass/{resourceId}
    • /walletobjects/v1/transitClass/{resourceId}
    • /walletobjects/v1/transitClass/{resourceId}/addMessage
  • transitobject
    • /walletobjects/v1/transitObject
    • /walletobjects/v1/transitObject
    • /walletobjects/v1/transitObject/{resourceId}
    • /walletobjects/v1/transitObject/{resourceId}
    • /walletobjects/v1/transitObject/{resourceId}
    • /walletobjects/v1/transitObject/{resourceId}/addMessage
  • valuablesclasses
    • /walletobjects/v1/valuablesclasses
  • walletobjects
    • /walletobjects/v1/valuablesclassescount
  1. flightobject

/walletobjects/v1/flightObject/{resourceId}

PUT
/walletobjects/v1/flightObject/{resourceId}
flightobject
Updates the flight object referenced by the given object ID.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://walletobjects.googleapis.com//walletobjects/v1/flightObject/' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example

Request

Path Params
resourceId
string 
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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
Body Params application/json
appLinkData
object (AppLinkData) 
optional
Optional information about the partner app link.
androidAppLinkInfo
object (AppLinkDataAppLinkInfo) 
optional
Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
iosAppLinkInfo
object (AppLinkDataAppLinkInfo) 
optional
Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the ios client.
webAppLinkInfo
object (AppLinkDataAppLinkInfo) 
optional
Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
barcode
object (Barcode) 
optional
The barcode type and value.
alternateText
string 
optional
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
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#barcode".
renderEncoding
enum<string> 
optional
The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
Allowed values:
RENDER_ENCODING_UNSPECIFIEDUTF_8
showCodeText
object (LocalizedString) 
optional
Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
type
enum<string> 
optional
The type of barcode.
Allowed values:
BARCODE_TYPE_UNSPECIFIEDAZTECaztecCODE_39code39CODE_128code128CODABARcodabarDATA_MATRIXdataMatrixEAN_8ean8EAN_13ean13EAN13ITF_14itf14PDF_417pdf417PDF417QR_CODEqrCodeqrcodeUPC_AupcATEXT_ONLYtextOnly
value
string 
optional
The value encoded in the barcode.
boardingAndSeatingInfo
object (BoardingAndSeatingInfo) 
optional
Passenger specific information about boarding and seating.
boardingDoor
enum<string> 
optional
Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the seatClass. In those cases boardingDoor should not be set.
Allowed values:
BOARDING_DOOR_UNSPECIFIEDFRONTfrontBACKback
boardingGroup
string 
optional
The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the boardingPolicy field in the flightClass referenced by this object.
boardingPosition
string 
optional
The value of boarding position. eg: "76"
boardingPrivilegeImage
object (Image) 
optional
A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#boardingAndSeatingInfo".
seatAssignment
object (LocalizedString) 
optional
The passenger's seat assignment. To be used when there is no specific identifier to use in seatNumber. eg: "assigned at gate"
seatClass
string 
optional
The value of the seat class. eg: "Economy" or "Economy Plus"
seatNumber
string 
optional
The value of passenger seat. If there is no specific identifier, use seatAssignment instead. eg: "25A"
sequenceNumber
string 
optional
The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
classId
string 
optional
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.
classReference
object (FlightClass) 
optional
A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
allowMultipleUsersPerObject
boolean 
optional
Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
boardingAndSeatingPolicy
object (BoardingAndSeatingPolicy) 
optional
Policies for boarding and seating. These will inform which labels will be shown to users.
callbackOptions
object (CallbackOptions) 
optional
Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
classTemplateInfo
object (ClassTemplateInfo) 
optional
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
countryCode
string 
optional
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.
destination
object (AirportInfo) 
optional
Required. Destination airport.
enableSmartTap
boolean 
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
flightHeader
object (FlightHeader) 
optional
Required. Information about the flight carrier and number.
flightStatus
enum<string> 
optional
Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
Allowed values:
FLIGHT_STATUS_UNSPECIFIEDSCHEDULEDscheduledACTIVEactiveLANDEDlandedCANCELLEDcancelledREDIRECTEDredirectedDIVERTEDdiverted
heroImage
object (Image) 
optional
Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
hexBackgroundColor
string 
optional
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.
homepageUri
object (Uri) 
optional
The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
id
string 
optional
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 '-'.
imageModulesData
array[object (ImageModuleData) {2}] 
optional
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
infoModuleData
object (InfoModuleData) 
optional
Deprecated. Use textModulesData instead.
issuerName
string 
optional
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightClass".
languageOverride
string 
optional
If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
linksModuleData
object (LinksModuleData) 
optional
Links module data. If links module data is also defined on the object, both will be displayed.
localBoardingDateTime
string 
optional
The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
localEstimatedOrActualArrivalDateTime
string 
optional
The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
localEstimatedOrActualDepartureDateTime
string 
optional
The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
localGateClosingDateTime
string 
optional
The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
localScheduledArrivalDateTime
string 
optional
The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set localEstimatedOrActualArrivalDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
localScheduledDepartureDateTime
string 
optional
Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set localEstimatedOrActualDepartureDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
localizedIssuerName
object (LocalizedString) 
optional
Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
locations
array[object (LatLongPoint) {3}] 
optional
messages
array[object (Message) {8}] 
optional
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.
multipleDevicesAndHoldersAllowedStatus
enum<string> 
optional
Identifies whether multiple users and devices will save the same object referencing this class.
Allowed values:
STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice
origin
object (AirportInfo) 
optional
Required. Origin airport.
redemptionIssuers
array[string <int64>]
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
review
object (Review) 
optional
The review comments set by the platform when a class is marked approved or rejected.
reviewStatus
enum<string> 
optional
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.
Allowed values:
REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft
textModulesData
array[object (TextModuleData) {5}] 
optional
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.
version
string <int64>
optional
Deprecated
wordMark
object (Image) 
optional
Deprecated.
disableExpirationNotification
boolean 
optional
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 Flights.
hasLinkedDevice
boolean 
optional
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.
hasUsers
boolean 
optional
Indicates if the object has users. This field is set by the platform.
heroImage
object (Image) 
optional
Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
hexBackgroundColor
string 
optional
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.
id
string 
optional
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 '-'.
imageModulesData
array[object (ImageModuleData) {2}] 
optional
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
id
string 
optional
The ID associated with an image module. This field is here to enable ease of management of image modules.
mainImage
object (Image) 
optional
A 100% width image.
infoModuleData
object (InfoModuleData) 
optional
Deprecated. Use textModulesData instead.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightObject".
linksModuleData
object (LinksModuleData) 
optional
Links module data. If links module data is also defined on the class, both will be displayed.
locations
array[object (LatLongPoint) {3}] 
optional
The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".
latitude
number <double>
optional
The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
longitude
number <double>
optional
The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
messages
array[object (Message) {8}] 
optional
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.
body
string 
optional
The message body.
displayInterval
object (TimeInterval) 
optional
The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided.
header
string 
optional
The message header.
id
string 
optional
The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
localizedBody
object (LocalizedString) 
optional
Translated strings for the message body.
localizedHeader
object (LocalizedString) 
optional
Translated strings for the message header.
messageType
enum<string> 
optional
The type of the message. Currently, this can only be set for offers.
Allowed values:
MESSAGE_TYPE_UNSPECIFIEDTEXTtextEXPIRATION_NOTIFICATIONexpirationNotification
passengerName
string 
optional
Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
reservationInfo
object (ReservationInfo) 
optional
Required. Information about flight reservation.
confirmationCode
string 
optional
Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
eticketNumber
string 
optional
E-ticket number.
frequentFlyerInfo
object (FrequentFlyerInfo) 
optional
Frequent flyer membership information.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#reservationInfo".
securityProgramLogo
object (Image) 
optional
An image for the security program that applies to the passenger.
smartTapRedemptionValue
string 
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
state
enum<string> 
optional
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.
Allowed values:
STATE_UNSPECIFIEDACTIVEactiveCOMPLETEDcompletedEXPIREDexpiredINACTIVEinactive
textModulesData
array[object (TextModuleData) {5}] 
optional
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.
body
string 
optional
The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
header
string 
optional
The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
id
string 
optional
The ID associated with a text module. This field is here to enable ease of management of text modules.
localizedBody
object (LocalizedString) 
optional
Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
localizedHeader
object (LocalizedString) 
optional
Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
validTimeInterval
object (TimeInterval) 
optional
The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.
version
string <int64>
optional
Deprecated
Examples

Responses

🟢200Successful response
application/json
Body
appLinkData
object (AppLinkData) 
optional
Optional information about the partner app link.
androidAppLinkInfo
object (AppLinkDataAppLinkInfo) 
optional
Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.
iosAppLinkInfo
object (AppLinkDataAppLinkInfo) 
optional
Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the ios client.
webAppLinkInfo
object (AppLinkDataAppLinkInfo) 
optional
Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.
barcode
object (Barcode) 
optional
The barcode type and value.
alternateText
string 
optional
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
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#barcode".
renderEncoding
enum<string> 
optional
The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
Allowed values:
RENDER_ENCODING_UNSPECIFIEDUTF_8
showCodeText
object (LocalizedString) 
optional
Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
type
enum<string> 
optional
The type of barcode.
Allowed values:
BARCODE_TYPE_UNSPECIFIEDAZTECaztecCODE_39code39CODE_128code128CODABARcodabarDATA_MATRIXdataMatrixEAN_8ean8EAN_13ean13EAN13ITF_14itf14PDF_417pdf417PDF417QR_CODEqrCodeqrcodeUPC_AupcATEXT_ONLYtextOnly
value
string 
optional
The value encoded in the barcode.
boardingAndSeatingInfo
object (BoardingAndSeatingInfo) 
optional
Passenger specific information about boarding and seating.
boardingDoor
enum<string> 
optional
Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the seatClass. In those cases boardingDoor should not be set.
Allowed values:
BOARDING_DOOR_UNSPECIFIEDFRONTfrontBACKback
boardingGroup
string 
optional
The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the boardingPolicy field in the flightClass referenced by this object.
boardingPosition
string 
optional
The value of boarding position. eg: "76"
boardingPrivilegeImage
object (Image) 
optional
A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#boardingAndSeatingInfo".
seatAssignment
object (LocalizedString) 
optional
The passenger's seat assignment. To be used when there is no specific identifier to use in seatNumber. eg: "assigned at gate"
seatClass
string 
optional
The value of the seat class. eg: "Economy" or "Economy Plus"
seatNumber
string 
optional
The value of passenger seat. If there is no specific identifier, use seatAssignment instead. eg: "25A"
sequenceNumber
string 
optional
The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"
classId
string 
optional
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.
classReference
object (FlightClass) 
optional
A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
allowMultipleUsersPerObject
boolean 
optional
Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
boardingAndSeatingPolicy
object (BoardingAndSeatingPolicy) 
optional
Policies for boarding and seating. These will inform which labels will be shown to users.
callbackOptions
object (CallbackOptions) 
optional
Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
classTemplateInfo
object (ClassTemplateInfo) 
optional
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
countryCode
string 
optional
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.
destination
object (AirportInfo) 
optional
Required. Destination airport.
enableSmartTap
boolean 
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
flightHeader
object (FlightHeader) 
optional
Required. Information about the flight carrier and number.
flightStatus
enum<string> 
optional
Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
Allowed values:
FLIGHT_STATUS_UNSPECIFIEDSCHEDULEDscheduledACTIVEactiveLANDEDlandedCANCELLEDcancelledREDIRECTEDredirectedDIVERTEDdiverted
heroImage
object (Image) 
optional
Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
hexBackgroundColor
string 
optional
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.
homepageUri
object (Uri) 
optional
The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
id
string 
optional
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 '-'.
imageModulesData
array[object (ImageModuleData) {2}] 
optional
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
infoModuleData
object (InfoModuleData) 
optional
Deprecated. Use textModulesData instead.
issuerName
string 
optional
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightClass".
languageOverride
string 
optional
If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
linksModuleData
object (LinksModuleData) 
optional
Links module data. If links module data is also defined on the object, both will be displayed.
localBoardingDateTime
string 
optional
The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
localEstimatedOrActualArrivalDateTime
string 
optional
The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
localEstimatedOrActualDepartureDateTime
string 
optional
The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.
localGateClosingDateTime
string 
optional
The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
localScheduledArrivalDateTime
string 
optional
The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set localEstimatedOrActualArrivalDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.
localScheduledDepartureDateTime
string 
optional
Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set localEstimatedOrActualDepartureDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
localizedIssuerName
object (LocalizedString) 
optional
Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
locations
array[object (LatLongPoint) {3}] 
optional
messages
array[object (Message) {8}] 
optional
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.
multipleDevicesAndHoldersAllowedStatus
enum<string> 
optional
Identifies whether multiple users and devices will save the same object referencing this class.
Allowed values:
STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice
origin
object (AirportInfo) 
optional
Required. Origin airport.
redemptionIssuers
array[string <int64>]
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
review
object (Review) 
optional
The review comments set by the platform when a class is marked approved or rejected.
reviewStatus
enum<string> 
optional
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.
Allowed values:
REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft
textModulesData
array[object (TextModuleData) {5}] 
optional
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.
version
string <int64>
optional
Deprecated
wordMark
object (Image) 
optional
Deprecated.
disableExpirationNotification
boolean 
optional
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 Flights.
hasLinkedDevice
boolean 
optional
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.
hasUsers
boolean 
optional
Indicates if the object has users. This field is set by the platform.
heroImage
object (Image) 
optional
Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
hexBackgroundColor
string 
optional
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.
id
string 
optional
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 '-'.
imageModulesData
array[object (ImageModuleData) {2}] 
optional
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
id
string 
optional
The ID associated with an image module. This field is here to enable ease of management of image modules.
mainImage
object (Image) 
optional
A 100% width image.
infoModuleData
object (InfoModuleData) 
optional
Deprecated. Use textModulesData instead.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightObject".
linksModuleData
object (LinksModuleData) 
optional
Links module data. If links module data is also defined on the class, both will be displayed.
locations
array[object (LatLongPoint) {3}] 
optional
The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".
latitude
number <double>
optional
The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
longitude
number <double>
optional
The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
messages
array[object (Message) {8}] 
optional
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.
body
string 
optional
The message body.
displayInterval
object (TimeInterval) 
optional
The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided.
header
string 
optional
The message header.
id
string 
optional
The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
localizedBody
object (LocalizedString) 
optional
Translated strings for the message body.
localizedHeader
object (LocalizedString) 
optional
Translated strings for the message header.
messageType
enum<string> 
optional
The type of the message. Currently, this can only be set for offers.
Allowed values:
MESSAGE_TYPE_UNSPECIFIEDTEXTtextEXPIRATION_NOTIFICATIONexpirationNotification
passengerName
string 
optional
Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
reservationInfo
object (ReservationInfo) 
optional
Required. Information about flight reservation.
confirmationCode
string 
optional
Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
eticketNumber
string 
optional
E-ticket number.
frequentFlyerInfo
object (FrequentFlyerInfo) 
optional
Frequent flyer membership information.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#reservationInfo".
securityProgramLogo
object (Image) 
optional
An image for the security program that applies to the passenger.
smartTapRedemptionValue
string 
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
state
enum<string> 
optional
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.
Allowed values:
STATE_UNSPECIFIEDACTIVEactiveCOMPLETEDcompletedEXPIREDexpiredINACTIVEinactive
textModulesData
array[object (TextModuleData) {5}] 
optional
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.
body
string 
optional
The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
header
string 
optional
The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
id
string 
optional
The ID associated with a text module. This field is here to enable ease of management of text modules.
localizedBody
object (LocalizedString) 
optional
Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
localizedHeader
object (LocalizedString) 
optional
Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
validTimeInterval
object (TimeInterval) 
optional
The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.
version
string <int64>
optional
Deprecated
Modified at 2022-09-10 16:56:46
Previous
/walletobjects/v1/flightObject/{resourceId}
Next
/walletobjects/v1/flightObject/{resourceId}/addMessage
Built with