Transitclass: patch

Requires authorization

Updates the transit class referenced by the given class ID. This method supports patch semantics.

Note about arrays: Patch requests that contain arrays replace the existing array with the one you provide. You cannot modify, add, or delete items in an array in a piecemeal fashion.

Request

HTTP request

PATCH https://www.googleapis.com/walletobjects/v1/transitClass/resourceId

Parameters

Parameter name Value Description
Path parameters
resourceId string 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 '-'.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/wallet_object.issuer

Request body

In the request body, supply the relevant portions of a Transitclass resource, according to the rules of patch semantics, with the following properties:

Property name Value Description Notes
Optional Properties
callbackOptions nested object 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. writable
callbackOptions.url string URL for the merchant endpoint that would be called for all user saves and deletes. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. writable
classTemplateInfo nested object Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display. writable
classTemplateInfo.cardBarcodeSectionDetails nested object Specifies extra information to be displayed above and below the barcode. writable
classTemplateInfo.cardBarcodeSectionDetails.firstBottomDetail nested object Optional information to display below the barcode. writable
classTemplateInfo.cardBarcodeSectionDetails.firstBottomDetail.fieldSelector.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardBarcodeSectionDetails.firstBottomDetail.fieldSelector.fields[].fieldPath string 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". writable
classTemplateInfo.cardBarcodeSectionDetails.firstTopDetail nested object Optional information to display above the barcode. If secondTopDetail is defined, this will be displayed to the start side of this detail section. writable
classTemplateInfo.cardBarcodeSectionDetails.firstTopDetail.fieldSelector.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardBarcodeSectionDetails.firstTopDetail.fieldSelector.fields[].fieldPath string 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". writable
classTemplateInfo.cardBarcodeSectionDetails.secondTopDetail nested object Optional second piece of information to display above the barcode. If firstTopDetail is defined, this will be displayed to the end side of this detail section. writable
classTemplateInfo.cardBarcodeSectionDetails.secondTopDetail.fieldSelector.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardBarcodeSectionDetails.secondTopDetail.fieldSelector.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride nested object Override for the card view. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[] list Template information for rows in the card view. At most two rows are allowed to be specified. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem nested object Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item nested object The item to be displayed in the row. This item will be automatically centered. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.firstValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].oneItem.item.secondValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems nested object Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem nested object The item to be displayed at the end of the row. This item will be aligned to the right. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.firstValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.endItem.secondValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem nested object The item to be displayed in the middle of the row. This item will be centered between the start and end items. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.firstValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.middleItem.secondValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem nested object The item to be displayed at the start of the row. This item will be aligned to the left. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.firstValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].threeItems.startItem.secondValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems nested object Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem nested object The item to be displayed at the end of the row. This item will be aligned to the right. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.firstValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.endItem.secondValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem nested object The item to be displayed at the start of the row. This item will be aligned to the left. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.firstValue.fields[].fieldPath string 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". writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[].twoItems.startItem.secondValue.fields[].fieldPath string 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". writable
classTemplateInfo.detailsTemplateOverride nested object Override for the details view (beneath the card view). writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[] list Information for the "nth" item displayed in the details list. writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item nested object The item to be displayed in the details list. writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.firstValue nested object A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B". writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.firstValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.firstValue.fields[].fieldPath string 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". writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.predefinedItem string A predefined item to display. Only one of firstValue or predefinedItem may be set.

Acceptable values are:
  • "flightNumberAndOperatingFlightNumber"
  • "frequentFlyerProgramNameAndNumber"
writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.secondValue nested object A reference to a field to display. This may only be populated if the firstValue field is populated. writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.secondValue.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.detailsTemplateOverride.detailsItemInfos[].item.secondValue.fields[].fieldPath string 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". writable
classTemplateInfo.listTemplateOverride nested object Override for the passes list view. writable
classTemplateInfo.listTemplateOverride.firstRowOption nested object Specifies from a predefined set of options what the will be displayed in the first row. writable
classTemplateInfo.listTemplateOverride.secondRowOption nested object A reference to the field to be displayed in the second row.

This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display the departure date shared by all objects.

writable
classTemplateInfo.listTemplateOverride.secondRowOption.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.listTemplateOverride.secondRowOption.fields[].fieldPath string 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". writable
classTemplateInfo.listTemplateOverride.thirdRowOption nested object A reference to the field to be displayed in the third row.

This option is only displayed if there are not multiple user objects in a group. If there is a group, the third row will always display the number of objects in the group. Eg: "3 passes"
writable
classTemplateInfo.listTemplateOverride.thirdRowOption.fields[].dateFormat string Only valid if the fieldPath references a date field. Chooses how the date field will be formatted and displayed in the UI.

Acceptable values are:
  • "dateOnly"
  • "dateTime"
  • "dateTimeYear"
  • "dateYear"
  • "timeOnly"
writable
classTemplateInfo.listTemplateOverride.thirdRowOption.fields[].fieldPath string 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". writable
countryCode string 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. writable
customCarriageLabel nested object A custom label to use for the carriage value (transitObject.ticketLeg.carriage). writable
customCarriageLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customCarriageLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customCarriageLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customCarriageLabel.translatedValues[] list Contains the translations for the string. writable
customCarriageLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customCarriageLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customCoachLabel nested object A custom label to use for the coach value (transitObject.ticketLeg.ticketSeat.coach). writable
customCoachLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customCoachLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customCoachLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customCoachLabel.translatedValues[] list Contains the translations for the string. writable
customCoachLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customCoachLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customConcessionCategoryLabel nested object A custom label to use for the transit concession category value (transitObject.concessionCategory). writable
customConcessionCategoryLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customConcessionCategoryLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customConcessionCategoryLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customConcessionCategoryLabel.translatedValues[] list Contains the translations for the string. writable
customConcessionCategoryLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customConcessionCategoryLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customConfirmationCodeLabel nested object A custom label to use for the confirmation code value (transitObject.purchaseDetails.confirmationCode). writable
customConfirmationCodeLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customConfirmationCodeLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customConfirmationCodeLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customConfirmationCodeLabel.translatedValues[] list Contains the translations for the string. writable
customConfirmationCodeLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customConfirmationCodeLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customDiscountMessageLabel nested object A custom label to use for the transit discount message value (transitObject.purchaseDetails.ticketCost.discountMessage). writable
customDiscountMessageLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customDiscountMessageLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customDiscountMessageLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customDiscountMessageLabel.translatedValues[] list Contains the translations for the string. writable
customDiscountMessageLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customDiscountMessageLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customFareClassLabel nested object A custom label to use for the fare class value (transitObject.ticketLeg.ticketSeat.fareClass). writable
customFareClassLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customFareClassLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customFareClassLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customFareClassLabel.translatedValues[] list Contains the translations for the string. writable
customFareClassLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customFareClassLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customFareNameLabel nested object A custom label to use for the transit fare name value (transitObject.ticketLeg.fareName). writable
customFareNameLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customFareNameLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customFareNameLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customFareNameLabel.translatedValues[] list Contains the translations for the string. writable
customFareNameLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customFareNameLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customOtherRestrictionsLabel nested object A custom label to use for the other restrictions value (transitObject.ticketRestrictions.otherRestrictions). writable
customOtherRestrictionsLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customOtherRestrictionsLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customOtherRestrictionsLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customOtherRestrictionsLabel.translatedValues[] list Contains the translations for the string. writable
customOtherRestrictionsLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customOtherRestrictionsLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customPlatformLabel nested object A custom label to use for the boarding platform value (transitObject.ticketLeg.platform). writable
customPlatformLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customPlatformLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customPlatformLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customPlatformLabel.translatedValues[] list Contains the translations for the string. writable
customPlatformLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customPlatformLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchaseFaceValueLabel nested object A custom label to use for the purchase face value (transitObject.purchaseDetails.ticketCost.faceValue). writable
customPurchaseFaceValueLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customPurchaseFaceValueLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchaseFaceValueLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchaseFaceValueLabel.translatedValues[] list Contains the translations for the string. writable
customPurchaseFaceValueLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchaseFaceValueLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchasePriceLabel nested object A custom label to use for the purchase price value (transitObject.purchaseDetails.ticketCost.purchasePrice). writable
customPurchasePriceLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customPurchasePriceLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchasePriceLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchasePriceLabel.translatedValues[] list Contains the translations for the string. writable
customPurchasePriceLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchasePriceLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchaseReceiptNumberLabel nested object A custom label to use for the purchase receipt number value (transitObject.purchaseDetails.purchaseReceiptNumber). writable
customPurchaseReceiptNumberLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customPurchaseReceiptNumberLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchaseReceiptNumberLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchaseReceiptNumberLabel.translatedValues[] list Contains the translations for the string. writable
customPurchaseReceiptNumberLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customPurchaseReceiptNumberLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customRouteRestrictionsDetailsLabel nested object A custom label to use for the route restrictions details value (transitObject.ticketRestrictions.routeRestrictionsDetails). writable
customRouteRestrictionsDetailsLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customRouteRestrictionsDetailsLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customRouteRestrictionsDetailsLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customRouteRestrictionsDetailsLabel.translatedValues[] list Contains the translations for the string. writable
customRouteRestrictionsDetailsLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customRouteRestrictionsDetailsLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customRouteRestrictionsLabel nested object A custom label to use for the route restrictions value (transitObject.ticketRestrictions.routeRestrictions). writable
customRouteRestrictionsLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customRouteRestrictionsLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customRouteRestrictionsLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customRouteRestrictionsLabel.translatedValues[] list Contains the translations for the string. writable
customRouteRestrictionsLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customRouteRestrictionsLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customSeatLabel nested object A custom label to use for the seat location value (transitObject.ticketLeg.ticketSeat.seat). writable
customSeatLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customSeatLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customSeatLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customSeatLabel.translatedValues[] list Contains the translations for the string. writable
customSeatLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customSeatLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customTicketNumberLabel nested object A custom label to use for the ticket number value (transitObject.ticketNumber). writable
customTicketNumberLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customTicketNumberLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customTicketNumberLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customTicketNumberLabel.translatedValues[] list Contains the translations for the string. writable
customTicketNumberLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customTicketNumberLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customTimeRestrictionsLabel nested object A custom label to use for the time restrictions details value (transitObject.ticketRestrictions.timeRestrictions). writable
customTimeRestrictionsLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customTimeRestrictionsLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customTimeRestrictionsLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customTimeRestrictionsLabel.translatedValues[] list Contains the translations for the string. writable
customTimeRestrictionsLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customTimeRestrictionsLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customTransitTerminusNameLabel nested object A custom label to use for the transit terminus name value (transitObject.ticketLeg.transitTerminusName). writable
customTransitTerminusNameLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customTransitTerminusNameLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customTransitTerminusNameLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customTransitTerminusNameLabel.translatedValues[] list Contains the translations for the string. writable
customTransitTerminusNameLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customTransitTerminusNameLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customZoneLabel nested object A custom label to use for the boarding zone value (transitObject.ticketLeg.zone). writable
customZoneLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customZoneLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customZoneLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customZoneLabel.translatedValues[] list Contains the translations for the string. writable
customZoneLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customZoneLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
enableSingleLegItinerary boolean Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips. writable
enableSmartTap boolean Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
heroImage.sourceUri nested object The URI for the image. writable
heroImage.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
heroImage.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
heroImage.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
heroImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
heroImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
heroImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
hexBackgroundColor string 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. writable
homepageUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
homepageUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
homepageUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
homepageUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
homepageUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
homepageUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
imageModulesData[] list Image module data. If image modules data is also defined on the object, those will be merged with the image data defined on the class. The maximum number of these fields (combined with the object) is 1. writable
imageModulesData[].mainImage nested object A 100% width image. writable
imageModulesData[].mainImage.sourceUri nested object The URI for the image. writable
imageModulesData[].mainImage.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
imageModulesData[].mainImage.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
imageModulesData[].mainImage.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
infoModuleData.labelValueRows[].columns[].label string 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. writable
infoModuleData.labelValueRows[].columns[].localizedLabel nested object Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.

writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue nested object Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].value string 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. writable
issuerName string The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
languageOverride string 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". writable
linksModuleData nested object Links module data. If links module data is also defined on the object, both will be displayed. The maximum number of these fields (combined with the object) is 10. writable
linksModuleData.uris[] list The list of URIs. writable
linksModuleData.uris[].description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
linksModuleData.uris[].id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
linksModuleData.uris[].localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
linksModuleData.uris[].localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[] list Contains the translations for the string. writable
linksModuleData.uris[].localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
localizedIssuerName nested object Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
localizedIssuerName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedIssuerName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.translatedValues[] list Contains the translations for the string. writable
localizedIssuerName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri nested object The URI for the image. writable
logo.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
logo.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
logo.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
logo.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
logo.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
logo.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
messages[] list 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. writable
messages[].body string The message body. writable
messages[].displayInterval nested object 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. writable
messages[].displayInterval.end nested object End time of the interval.

Offset is not required. If an offset is provided and start time is set, start must also include an offset.
writable
messages[].displayInterval.end.date string 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.
writable
messages[].displayInterval.start nested object Start time of the interval.

Offset is not required. If an offset is provided and end time is set, end must also include an offset.
writable
messages[].displayInterval.start.date string 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.
writable
messages[].header string The message header. writable
messages[].id string 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. writable
messages[].localizedBody nested object Translated strings for the message body. writable
messages[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[] list Contains the translations for the string. writable
messages[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader nested object Translated strings for the message header. writable
messages[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
messages[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
multipleDevicesAndHoldersAllowedStatus string Identifies whether multiple users and devices will save the same object referencing this class.

Acceptable values are:
  • "multipleHolders"
  • "oneUserAllDevices"
  • "oneUserOneDevice"
writable
redemptionIssuers[] list Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
reviewStatus string 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.

Acceptable values are:
  • "approved"
  • "draft"
  • "rejected"
  • "underReview"
writable
textModulesData[] list Text module data. If text modules data is also defined on the object, both will be displayed. The maximum number of these fields (combined with the object) is 10. writable
textModulesData[].body string 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. writable
textModulesData[].header string The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody nested object Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader nested object Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
transitOperatorName nested object The name of the transit operator. writable
transitOperatorName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
transitOperatorName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
transitOperatorName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
transitOperatorName.translatedValues[] list Contains the translations for the string. writable
transitOperatorName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
transitOperatorName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
transitType string The type of transit this class represents, such as "bus".

Acceptable values are:
  • "bus"
  • "ferry"
  • "other"
  • "rail"
  • "tram"
writable
watermark nested object Watermark image to display on the user's device. writable
watermark.sourceUri nested object The URI for the image. writable
watermark.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
watermark.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
watermark.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
watermark.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
watermark.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
watermark.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
watermark.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
watermark.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
watermark.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
watermark.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
wordMark.sourceUri nested object The URI for the image. writable
wordMark.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
wordMark.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
wordMark.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
wordMark.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
wordMark.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
wordMark.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable

Response

If successful, this method returns a Transitclass resource in the response body.

Envoyer des commentaires concernant…

Google Pay for Passes