/walletobjects/v1/transitObject/{resourceId}

GET

transitobject

Returns the transit object with the given object ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://walletobjects.googleapis.com//walletobjects/v1/transitObject/'

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

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.

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 (TransitClass)

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.

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.

customCarriageLabel

object (LocalizedString)

optional

A custom label to use for the carriage value (transitObject.ticketLeg.carriage).

customCoachLabel

object (LocalizedString)

optional

A custom label to use for the coach value (transitObject.ticketLeg.ticketSeat.coach).

customConcessionCategoryLabel

object (LocalizedString)

optional

A custom label to use for the transit concession category value (transitObject.concessionCategory).

customConfirmationCodeLabel

object (LocalizedString)

optional

A custom label to use for the confirmation code value (transitObject.purchaseDetails.confirmationCode).

customDiscountMessageLabel

object (LocalizedString)

optional

A custom label to use for the transit discount message value (transitObject.purchaseDetails.ticketCost.discountMessage).

customFareClassLabel

object (LocalizedString)

optional

A custom label to use for the fare class value (transitObject.ticketLeg.ticketSeat.fareClass).

customFareNameLabel

object (LocalizedString)

optional

A custom label to use for the transit fare name value (transitObject.ticketLeg.fareName).

customOtherRestrictionsLabel

object (LocalizedString)

optional

A custom label to use for the other restrictions value (transitObject.ticketRestrictions.otherRestrictions).

customPlatformLabel

object (LocalizedString)

optional

A custom label to use for the boarding platform value (transitObject.ticketLeg.platform).

customPurchaseFaceValueLabel

object (LocalizedString)

optional

A custom label to use for the purchase face value (transitObject.purchaseDetails.ticketCost.faceValue).

customPurchasePriceLabel

object (LocalizedString)

optional

A custom label to use for the purchase price value (transitObject.purchaseDetails.ticketCost.purchasePrice).

customPurchaseReceiptNumberLabel

object (LocalizedString)

optional

A custom label to use for the purchase receipt number value (transitObject.purchaseDetails.purchaseReceiptNumber).

customRouteRestrictionsDetailsLabel

object (LocalizedString)

optional

A custom label to use for the route restrictions details value (transitObject.ticketRestrictions.routeRestrictionsDetails).

customRouteRestrictionsLabel

object (LocalizedString)

optional

A custom label to use for the route restrictions value (transitObject.ticketRestrictions.routeRestrictions).

customSeatLabel

object (LocalizedString)

optional

A custom label to use for the seat location value (transitObject.ticketLeg.ticketSeat.seat).

customTicketNumberLabel

object (LocalizedString)

optional

A custom label to use for the ticket number value (transitObject.ticketNumber).

customTimeRestrictionsLabel

object (LocalizedString)

optional

A custom label to use for the time restrictions details value (transitObject.ticketRestrictions.timeRestrictions).

customTransitTerminusNameLabel

object (LocalizedString)

optional

A custom label to use for the transit terminus name value (transitObject.ticketLeg.transitTerminusName).

customZoneLabel

object (LocalizedString)

optional

A custom label to use for the boarding zone value (transitObject.ticketLeg.zone).

enableSingleLegItinerary

boolean

optional

Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.

enableSmartTap

boolean

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

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

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.

languageOverride

string

optional

If this field is present, transit tickets 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.

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

logo

object (Image)

optional

Required. The logo image of the ticket. This image is displayed in the card detail view of the app.

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

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.

transitOperatorName

object (LocalizedString)

optional

The name of the transit operator.

transitType

enum<string>

optional

Required. The type of transit this class represents, such as "bus".

Allowed values:

TRANSIT_TYPE_UNSPECIFIEDBUSbusRAILrailTRAMtramFERRYferryOTHERother

version

string <int64>

optional

Deprecated

watermark

object (Image)

optional

Watermark image to display on the user's device.

wordMark

object (Image)

optional

Deprecated.

concessionCategory

enum<string>

optional

The concession category for the ticket.

Allowed values:

CONCESSION_CATEGORY_UNSPECIFIEDADULTadultCHILDchildSENIORsenior

customConcessionCategory

object (LocalizedString)

optional

A custom concession category to use when concessionCategory does not provide the right option. Both concessionCategory and customConcessionCategory may not be set.

customTicketStatus

object (LocalizedString)

optional

A custom status to use for the ticket status value when ticketStatus does not provide the right option. Both ticketStatus and customTicketStatus may not be set.

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

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

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.

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.

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.

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

passengerNames

string

optional

The name(s) of the passengers the ticket is assigned to. The above passengerType field is meant to give Google context on this field.

passengerType

enum<string>

optional

The number of passengers.

Allowed values:

PASSENGER_TYPE_UNSPECIFIEDSINGLE_PASSENGERsinglePassengerMULTIPLE_PASSENGERSmultiplePassengers

purchaseDetails

object (PurchaseDetails)

optional

Purchase details for this ticket.

accountId

string

optional

ID of the account used to purchase the ticket.

confirmationCode

string

optional

The confirmation code for the purchase. This may be the same for multiple different tickets and is used to group tickets together.

purchaseDateTime

string

optional

The purchase date/time of the ticket. This is an ISO 8601 extended format date/time, with or without an offset. 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 event were 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. Without offset information, some rich features may not be available.

purchaseReceiptNumber

string

optional

Receipt number/identifier for tracking the ticket purchase via the body that sold the ticket.

ticketCost

object (TicketCost)

optional

The cost of the ticket.

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.

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.

ticketLeg

object (TicketLeg)

optional

A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the ticketLegs field instead. Both ticketLeg and ticketLegs may not be set.

arrivalDateTime

string

optional

The date/time of arrival. This is an ISO 8601 extended format date/time, with or without an offset. 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 event were 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. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the destination station is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.

carriage

string

optional

The train or ship name/number that the passsenger needs to board.

departureDateTime

string

optional

The date/time of departure. This is required if there is no validity time interval set on the transit object. This is an ISO 8601 extended format date/time, with or without an offset. 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 event were 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. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the origin station is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.

destinationName

object (LocalizedString)

optional

The destination name.

destinationStationCode

string

optional

The destination station code.

fareName

object (LocalizedString)

optional

Short description/name of the fare for this leg of travel. Eg "Anytime Single Use".

originName

object (LocalizedString)

optional

The name of the origin station. This is required if desinationName is present or if originStationCode is not present.

originStationCode

string

optional

The origin station code. This is required if destinationStationCode is present or if originName is not present.

platform

string

optional

The platform or gate where the passenger can board the carriage.

ticketSeat

object (TicketSeat)

optional

The reserved seat for the passenger(s). If more than one seat is to be specified then use the ticketSeats field instead. Both ticketSeat and ticketSeats may not be set.

ticketSeats

array[object (TicketSeat) {5}]

optional

The reserved seat for the passenger(s). If only one seat is to be specified then use the ticketSeat field instead. Both ticketSeat and ticketSeats may not be set.

transitOperatorName

object (LocalizedString)

optional

The name of the transit operator that is operating this leg of a trip.

transitTerminusName

object (LocalizedString)

optional

Terminus station or destination of the train/bus/etc.

zone

string

optional

The zone of boarding within the platform.

ticketLegs

array[object (TicketLeg) {14}]

optional

Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the ticketLeg field instead. Both ticketLeg and ticketLegs may not be set.

arrivalDateTime

string

optional

carriage

string

optional

The train or ship name/number that the passsenger needs to board.

departureDateTime

string

optional

destinationName

object (LocalizedString)

optional

The destination name.

destinationStationCode

string

optional

The destination station code.

fareName

object (LocalizedString)

optional

Short description/name of the fare for this leg of travel. Eg "Anytime Single Use".

originName

object (LocalizedString)

optional

The name of the origin station. This is required if desinationName is present or if originStationCode is not present.

originStationCode

string

optional

The origin station code. This is required if destinationStationCode is present or if originName is not present.

platform

string

optional

The platform or gate where the passenger can board the carriage.

ticketSeat

object (TicketSeat)

optional

The reserved seat for the passenger(s). If more than one seat is to be specified then use the ticketSeats field instead. Both ticketSeat and ticketSeats may not be set.

ticketSeats

array[object (TicketSeat) {5}]

optional

The reserved seat for the passenger(s). If only one seat is to be specified then use the ticketSeat field instead. Both ticketSeat and ticketSeats may not be set.

transitOperatorName

object (LocalizedString)

optional

The name of the transit operator that is operating this leg of a trip.

transitTerminusName

object (LocalizedString)

optional

Terminus station or destination of the train/bus/etc.

zone

string

optional

The zone of boarding within the platform.

ticketNumber

string

optional

The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.

ticketRestrictions

object (TicketRestrictions)

optional

Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken.

otherRestrictions

object (LocalizedString)

optional

Extra restrictions that don't fall under the "route" or "time" categories.

routeRestrictions

object (LocalizedString)

optional

Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only".

routeRestrictionsDetails

object (LocalizedString)

optional

More details about the above routeRestrictions.

timeRestrictions

object (LocalizedString)

optional

Restrictions about times this ticket may be used.

ticketStatus

enum<string>

optional

The status of the ticket. For states which affect display, use the state field instead.

Allowed values:

TICKET_STATUS_UNSPECIFIEDUSEDusedREFUNDEDrefundedEXCHANGEDexchanged

tripId

string

optional

This id is used to group tickets together if the user has saved multiple tickets for the same trip.

tripType

enum<string>

optional

Required. The type of trip this transit object represents. Used to determine which symbol to use between the origin and destination.

Allowed values:

TRIP_TYPE_UNSPECIFIEDROUND_TRIProundTripONE_WAYoneWay

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

/walletobjects/v1/transitObject

/walletobjects/v1/transitObject/{resourceId}