Returns the loyalty object with the given object ID.
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request GET 'https://walletobjects.googleapis.com//walletobjects/v1/loyaltyObject/'
Response Response Example
Request
Path Params
resourceId
string
required
The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
Responses
🟢200Successful response
application/json
Body
accountId
string
optional
The loyalty account identifier. Recommended maximum length is 20 characters.
accountName
string
optional
The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
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.
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(LoyaltyClass)
optional
A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
accountIdLabel
string
optional
The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
accountNameLabel
string
optional
The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
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.
discoverableProgram
object(DiscoverableProgram)
optional
Information about how the class may be discovered and instantiated from within the Google Pay app.
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).
id
string
optional
Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
imageModulesData
array[object (ImageModuleData) {2}]
optional
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
infoModuleData
object(InfoModuleData)
optional
Deprecated. Use textModulesData instead.
issuerName
string
optional
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
kind
string
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyClass".
linksModuleData
object(LinksModuleData)
optional
Links module data. If links module data is also defined on the object, both will be displayed.
localizedAccountIdLabel
object(LocalizedString)
optional
Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
localizedAccountNameLabel
object(LocalizedString)
optional
Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
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.
localizedProgramName
object(LocalizedString)
optional
Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
localizedRewardsTier
object(LocalizedString)
optional
Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
localizedRewardsTierLabel
object(LocalizedString)
optional
Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
localizedSecondaryRewardsTier
object(LocalizedString)
optional
Translated strings for the secondary_rewards_tier.
localizedSecondaryRewardsTierLabel
object(LocalizedString)
optional
Translated strings for the secondary_rewards_tier_label.
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.
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.
Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
programName
string
optional
Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
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.
The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
rewardsTierLabel
string
optional
The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
secondaryRewardsTier
string
optional
The secondary rewards tier, such as "Gold" or "Platinum."
secondaryRewardsTierLabel
string
optional
The secondary rewards tier label, such as "Rewards Tier."
textModulesData
array[object (TextModuleData) {5}]
optional
Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
version
string<int64>
optional
Deprecated
wordMark
object(Image)
optional
Deprecated.
disableExpirationNotification
boolean
optional
Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the messages field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for 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.
id
string
optional
Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
imageModulesData
array[object (ImageModuleData) {2}]
optional
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
id
string
optional
The ID associated with an image module. This field is here to enable ease of management of image modules.
mainImage
object(Image)
optional
A 100% width image.
infoModuleData
object(InfoModuleData)
optional
Deprecated. Use textModulesData instead.
kind
string
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyObject".
linkedOfferIds
array[string]
optional
A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
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.
loyaltyPoints
object(LoyaltyPoints)
optional
The loyalty reward points label, balance, and type.
balance
object(LoyaltyPointsBalance)
optional
The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of loyaltyPoints and secondaryLoyaltyPoints.
label
string
optional
The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
localizedLabel
object(LocalizedString)
optional
Translated strings for the label. Recommended maximum length is 9 characters.
messages
array[object (Message) {8}]
optional
An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
body
string
optional
The message body.
displayInterval
object(TimeInterval)
optional
The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided.
header
string
optional
The message header.
id
string
optional
The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
kind
string
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
localizedBody
object(LocalizedString)
optional
Translated strings for the message body.
localizedHeader
object(LocalizedString)
optional
Translated strings for the message header.
messageType
enum<string>
optional
The type of the message. Currently, this can only be set for offers.
The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
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.
Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
body
string
optional
The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
header
string
optional
The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
id
string
optional
The ID associated with a text module. This field is here to enable ease of management of text modules.
localizedBody
object(LocalizedString)
optional
Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
localizedHeader
object(LocalizedString)
optional
Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
validTimeInterval
object(TimeInterval)
optional
The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.
