Index
AddMessageRequest
(message)AppLinkData
(message)AppLinkData.AppLinkInfo
(message)AppLinkData.AppLinkInfo.AppTarget
(message)Barcode
(message)BarcodeRenderEncoding
(enum)BarcodeType
(enum)CallbackOptions
(message)DateTime
(message)DiscoverableProgram
(message)DiscoverableProgram.State
(enum)DiscoverableProgramMerchantSigninInfo
(message)DiscoverableProgramMerchantSignupInfo
(message)DiscoverableProgramMerchantSignupInfo.SharedDataType
(enum)GroupingInfo
(message)Image
(message)ImageModuleData
(message)ImageUri
(message)InfoModuleData
(message)LabelValue
(message)LabelValueRow
(message)LatLongPoint
(message)LinksModuleData
(message)LocalizedString
(message)Message
(message)Message.MessageType
(enum)ModifyLinkedOfferObjects
(message)ModifyLinkedOfferObjectsRequest
(message)Money
(message)MultipleDevicesAndHoldersAllowedStatus
(enum)Pagination
(message)Review
(message)ReviewStatus
(enum)SecurityAnimation
(message)SecurityAnimation.AnimationType
(enum)State
(enum)TextModuleData
(message)TimeInterval
(message)TranslatedString
(message)Uri
(message)ViewUnlockRequirement
(enum)
AddMessageRequest
Resource used when the AddMessage endpoints are called.
Fields | |
---|---|
message |
AppLinkData
Fields | |
---|---|
android_app_link_info |
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. |
ios_app_link_info |
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. |
web_app_link_info |
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. |
AppLinkInfo
Fields | |
---|---|
app_logo_image |
Optional image to be displayed in the App Link Module |
title |
String to be displayed in the title of the App Link Module Required |
description |
String to be displayed in the description of the App Link Module Required |
app_target |
Url to follow when opening the App Link Module on clients. It will be used by partners to open their webpage or deeplink into their app. |
AppTarget
Fields | |
---|---|
target_uri |
Barcode
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
type |
The type of barcode. |
render_encoding |
The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google. |
value |
The value encoded in the barcode. |
alternate_text |
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. |
show_code_text |
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. |
BarcodeRenderEncoding
Enums | |
---|---|
RENDER_ENCODING_UNSPECIFIED |
|
UTF_8 |
UTF_8 encoding for barcodes. This is only supported for barcode type qrCode. |
BarcodeType
Enums | |
---|---|
BARCODE_TYPE_UNSPECIFIED |
|
AZTEC |
|
aztec |
Legacy alias for |
CODE_39 |
|
code39 |
Legacy alias for |
CODE_128 |
|
code128 |
Legacy alias for |
CODABAR |
|
codabar |
Legacy alias for |
DATA_MATRIX |
A 2D matrix barcode consisting of black and white. Cells or modules are arranged in either a square or rectangle. |
dataMatrix |
Legacy alias for |
EAN_8 |
|
ean8 |
Legacy alias for |
EAN_13 |
|
ean13 |
Legacy alias for |
EAN13 |
Legacy alias for |
ITF_14 |
14 digit ITF code |
itf14 |
Legacy alias for |
PDF_417 |
|
pdf417 |
Legacy alias for |
PDF417 |
Legacy alias for |
QR_CODE |
|
qrCode |
Legacy alias for |
qrcode |
Legacy alias for |
UPC_A |
11 or 12 digit codes |
upcA |
Legacy alias for |
TEXT_ONLY |
Renders the field as a text field. The alternateText field may not be used with a barcode of type textOnly . |
textOnly |
Legacy alias for |
CallbackOptions
Fields | |
---|---|
url |
The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. |
DateTime
Fields | |
---|---|
date |
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:
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 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 |
DiscoverableProgram
Information about how a class may be discovered and instantiated from within the Android Pay app. This is done by searching for a loyalty or gift card program and scanning or manually entering.
Fields | |
---|---|
merchant_signup_info |
Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled. |
merchant_signin_info |
Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled. |
state |
Visibility state of the discoverable program. |
State
Enums | |
---|---|
STATE_UNSPECIFIED |
|
TRUSTED_TESTERS |
Visible only to testers that have access to issuer account. |
trustedTesters |
Legacy alias for |
LIVE |
Visible to all. |
live |
Legacy alias for |
DISABLED |
Not visible. |
disabled |
Legacy alias for |
DiscoverableProgramMerchantSigninInfo
Information about the merchant hosted signin flow for a program.
Fields | |
---|---|
signin_website |
The URL to direct the user to for the merchant's signin site. |
DiscoverableProgramMerchantSignupInfo
Information about the merchant hosted signup flow for a program.
Fields | |
---|---|
signup_website |
The URL to direct the user to for the merchant's signup site. |
signup_shared_datas[] |
User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program. |
GroupingInfo
Fields | |
---|---|
sort_index |
Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined. |
Image
Wrapping type for Google hosted images.
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
source_uri |
The URI for the image. |
content_description |
Description of the image used for accessibility. |
ImageModuleData
Fields | |
---|---|
main_image |
A 100% width image. |
id |
The ID associated with an image module. This field is here to enable ease of management of image modules. |
ImageUri
Fields | |
---|---|
uri |
The location of the image. URIs must have a scheme. |
description |
Additional information about the image, which is unused and retained only for backward compatibility. |
localized_description |
Translated strings for the description, which are unused and retained only for backward compatibility. |
InfoModuleData
Fields | |
---|---|
label_value_rows[] |
A list of collections of labels and values. These will be displayed one after the other in a singular column. |
show_last_update_time |
|
LabelValue
A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.
Fields | |
---|---|
label |
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. |
value |
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. |
localized_label |
Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. |
localized_value |
Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. |
LabelValueRow
Fields | |
---|---|
columns[] |
A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name. |
LatLongPoint
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
latitude |
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 |
The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected. |
LinksModuleData
Fields | |
---|---|
uris[] |
The list of URIs. |
LocalizedString
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
translated_values[] |
Contains the translations for the string. |
default_value |
Contains the string to be displayed if no appropriate translation is available. |
Message
A message that will be displayed with a Valuable
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
header |
The message header. |
body |
The message body. |
display_interval |
The period of time that the message will be displayed to users. You can define both a |
id |
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. |
message_type |
The type of the message. Currently, this can only be set for offers. |
localized_header |
Translated strings for the message header. |
localized_body |
Translated strings for the message body. |
MessageType
Enums | |
---|---|
MESSAGE_TYPE_UNSPECIFIED |
|
TEXT |
Renders the message as text on the card details screen. This is the default message type. |
text |
Legacy alias for |
EXPIRATION_NOTIFICATION |
Notification to display for an offer expiration. The displayInterval.start.date sets the time the notification will appear. It can be set up to 30 days prior to the expiration date. If a time span greater than this is specified, then the notification will trigger at the 30 day mark. |
expirationNotification |
Legacy alias for |
ModifyLinkedOfferObjects
Fields | |
---|---|
add_linked_offer_object_ids[] |
The linked offer object ids to add to the object. |
remove_linked_offer_object_ids[] |
The linked offer object ids to remove from the object. |
ModifyLinkedOfferObjectsRequest
Fields | |
---|---|
linked_offer_object_ids |
The linked offer object ids to add or remove from the object. |
Money
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
micros |
The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros. |
currency_code |
The currency code, such as "USD" or "EUR." |
MultipleDevicesAndHoldersAllowedStatus
Enums | |
---|---|
STATUS_UNSPECIFIED |
|
MULTIPLE_HOLDERS |
Multiple users on multiple devices are allowed. |
multipleHolders |
Legacy alias for |
ONE_USER_ALL_DEVICES |
One user on multiple devices is allowed. |
oneUserAllDevices |
Legacy alias for |
ONE_USER_ONE_DEVICE |
Intended for use by select partners in limited circumstances. Contact support for additional information. |
oneUserOneDevice |
Legacy alias for |
Pagination
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
results_per_page |
Number of results returned in this page. |
next_page_token |
Page token to send to fetch the next page. |
Review
Fields | |
---|---|
comments |
|
ReviewStatus
Enums | |
---|---|
REVIEW_STATUS_UNSPECIFIED |
|
UNDER_REVIEW |
|
underReview |
Legacy alias for |
APPROVED |
|
approved |
Legacy alias for |
REJECTED |
|
rejected |
Legacy alias for |
DRAFT |
|
draft |
Legacy alias for |
SecurityAnimation
Fields | |
---|---|
animation_type |
Type of animation. |
AnimationType
Enums | |
---|---|
ANIMATION_UNSPECIFIED |
|
FOIL_SHIMMER |
Default Foil & Shimmer animation |
foilShimmer |
Legacy alias for |
State
Enums | |
---|---|
STATE_UNSPECIFIED |
|
ACTIVE |
Object is active and displayed to with other active objects. |
active |
Legacy alias for |
COMPLETED |
|
completed |
Legacy alias for |
EXPIRED |
Object is no longer valid (validTimeInterval passed). |
expired |
Legacy alias for |
INACTIVE |
|
inactive |
Legacy alias for |
TextModuleData
Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
Fields | |
---|---|
header |
The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. |
body |
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. |
localized_header |
Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. |
localized_body |
Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. |
id |
The ID associated with a text module. This field is here to enable ease of management of text modules. |
TimeInterval
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
start |
Start time of the interval. Offset is not required. If an offset is provided and |
end |
End time of the interval. Offset is not required. If an offset is provided and |
TranslatedString
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
language |
Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". |
value |
The UTF-8 encoded translated string. |
Uri
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
uri |
The location of a web page, image, or other resource. URIs in the |
description |
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 |
localized_description |
Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. |
id |
The ID associated with a uri. This field is here to enable ease of management of uris. |
ViewUnlockRequirement
Defines what unlock mechanism, if any, is required to view the card.
Enums | |
---|---|
VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED |
Default value, same as UNLOCK_NOT_REQUIRED. |
UNLOCK_NOT_REQUIRED |
Default behavior for all the existing Passes if ViewUnlockRequirement is not set. |
UNLOCK_REQUIRED_TO_VIEW |
Requires the user to unlock their device each time the pass is viewed. If the user removes their device lock after saving the pass, then they will be prompted to create a device lock before the pass can be viewed. |