Stay organized with collections
Save and categorize content based on your preferences.
Partner Triggered Notifications
Add Message and Notify
Background
After a user adds a pass you may want to send them a message related to the
pass and ensure they are notified about it. Using the Add Message API
request with a message_type equal to
TEXT_AND_NOTIFY the following occurs:
A "Message"
item is added to the "back of pass" (aka Details
Template) and a push notification is sent to users with the pass saved.
Once the user taps the notification it opens Google Wallet to the front of
the pass (a.k.a. Card view) and the user will see a callout at the top of the
screen with a "View Message" button.
Clicking the callout will take users to the back of the pass, where new
unread messages are highlighted.
Some considerations when sending messages with notifications to users
Users must have notifications enabled for their passes to receive the
push notifications related to messages.
Messages may contain URIs to your website or app. Hyperlinks must be a
website or app related to the pass. It is a violation of the
Acceptable Use Policy
to send users to links not related to the pass.
You may send a maximum of 3 messages that trigger a push notification in a
24 hour period. Google may throttle your push notification delivery quota if it
deems you are spamming your users.
The push notification users see on their lock screen is controlled by Google
Wallet.
You can use the UPDATE
or PATCH
methods to edit or remove message data using the regular class or object
endpoint.
Integration Steps
When you want to notify users about a new issuer message added using the
AddMessage API, you will need to update the AddMessageRequest
so that the Message
which contains your new text has the MessageTypeTEXT_AND_NOTIFY instead of TEXT.
Example JSON Request to add message and notify in a Passes Class
Example Response to add message and notify for a Pass Class
// The updated resource…
{"kind":"walletobjects#walletObjectMessage","header":"My Object message header","body":"My Object message body with a <a href="http://play.google.com/store/apps/details?id=com.google.android.apps.maps">Hyperlink<\a>","id":"message_id","messageType":"textAndNotify"},…
Exception handling
Any attempts to notify more than 3 times will yield a
QuotaExceededException response. Any further updates to the
pass can be set using "TEXT" instead of
"TEXT_AND_NOTIFY" as discussed in the Integration
Steps.
Update Field and Notify
Background
After a user adds a pass you may want to trigger a push notification when you update certain
fields. The notification will appear on the user's lock screen and inform them that there is
an update on their pass. This notification will only trigger for a specific subset of fields
defined below using the UPDATE and PATCH
API methods. Once an API call to update the pass is made the following occurs:
A push notification is triggered and displayed on the user's lock screen, informing them of
a pass update.
Once the user taps the notification it opens Google Wallet to the front of
the pass (a.k.a. Card view) and the user will see a callout at the top of the screen with a "Review
update" button.
Clicking the button brings the user to a screen where they can see the
fields that were changed by the update.
Some considerations when sending field update notifications
Users must have notifications enabled for their passes to receive the push notifications
related to updates.
You may send a maximum of 3 updates that trigger a push notification in
a 24 hour period. Google may throttle your push notification delivery quota if it deems you are
spamming your users.
The push notification that users see on their lock screen is
controlled by Google Wallet.
The notifyPreference field is a transient field
that only lives on this request. For future requests when you wish to trigger a notification, you
will have to reset this field on the class or object request.
Integration Steps
In order to trigger these notifications, you will need to use the existing UPDATE or PATCH
calls and specify the notifyPreference. When updating a field on a class or object, you can
add a new field, notifyPreference, to the class or object request to trigger the
notification.
Example JSON Request to update and notify in a Class
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003e\u003cstrong\u003e\u003ccode\u003eTEXT_AND_NOTIFY\u003c/code\u003e\u003c/strong\u003e message type adds a message to the pass details and triggers a push notification, directing users to the new message within Google Wallet.\u003c/p\u003e\n"],["\u003cp\u003eUpdating specific fields like \u003ccode\u003erewardsTier\u003c/code\u003e, \u003ccode\u003eloyaltyPoints.balance\u003c/code\u003e, and others, along with setting \u003ccode\u003enotifyPreference\u003c/code\u003e to \u003ccode\u003enotifyOnUpdate\u003c/code\u003e, triggers update notifications.\u003c/p\u003e\n"],["\u003cp\u003eBoth message and update notifications are limited to 3 per pass within a 24-hour period to prevent spamming.\u003c/p\u003e\n"],["\u003cp\u003eUsers must have Google Wallet notifications enabled to receive these alerts.\u003c/p\u003e\n"]]],["The `AddMessage` API with `message_type` as `TEXT_AND_NOTIFY` sends a push notification and adds a message to the pass's back. Users tapping the notification see a \"View Message\" button that leads to unread messages. The `UPDATE` or `PATCH` API methods, with `notifyPreference: notifyOnUpdate`, trigger notifications for changes in specific `LoyaltyClass` or `LoyaltyObject` fields. There is a maximum limit of 3 push notifications for both cases in a 24-hour period. Notifications are only received by users with enabled notifications.\n"],null,["# Trigger Push Notifications\n\nPartner Triggered Notifications\n-------------------------------\n\n### Add Message and Notify\n\n#### Background\n\nAfter a user adds a pass you may want to send them a message related to the\npass and ensure they are notified about it. Using the [Add Message API](/wallet/retail/loyalty-cards/rest/v1/loyaltyclass/addmessage)\nrequest with a `message_type` equal to\n**`TEXT_AND_NOTIFY`** the following occurs:\n\n1. A \"[Message](https://developers.google.com/wallet/reference/rest/v1/Message)\" item is added to the \"back of pass\" (aka [Details\n Template](/wallet/retail/loyalty-cards/resources/template#details-template)) and a push notification is sent to users with the pass saved.\n2. Once the user taps the notification it opens Google Wallet to the front of the pass (a.k.a. Card view) and the user will see a callout at the top of the screen with a \"View Message\" button.\n3. Clicking the callout will take users to the back of the pass, where new unread messages are highlighted.\n\n#### Some considerations when sending messages with notifications to users\n\n- Users must have notifications enabled for their passes to receive the push notifications related to messages.\n- Messages may contain URIs to your website or app. Hyperlinks must be a website or app related to the pass. It is a violation of the [Acceptable Use Policy](https://payments.developers.google.com/terms/aup) to send users to links not related to the pass.\n- You may send a maximum of 3 messages that trigger a push notification in a 24 hour period. Google may throttle your push notification delivery quota if it deems you are spamming your users.\n- The push notification users see on their lock screen is controlled by Google Wallet.\n- You can use the [UPDATE](/wallet/retail/loyalty-cards/rest/v1/loyaltyclass/update) or [PATCH](/wallet/retail/loyalty-cards/rest/v1/loyaltyclass/patch) methods to edit or remove message data using the regular class or object endpoint.\n\n#### Integration Steps\n\nWhen you want to notify users about a new issuer message added using the\nAddMessage API, you will need to update the [AddMessageRequest](https://developers.google.com/wallet/reference/rest/v1/AddMessageRequest)\nso that the [Message](https://developers.google.com/wallet/reference/rest/v1/Message)\nwhich contains your new text has the [MessageType](https://developers.google.com/wallet/reference/rest/v1/Message#MessageType)\n**TEXT_AND_NOTIFY** instead of **TEXT**.\n\n#### Example JSON Request to add message and notify in a Passes Class\n\n```carbon\n ...\n \"id\": ISSUER_ID.CLASS_ID\",\n \"message\":\n {\n \"header\":\"My Class message header\",\n \"body\": \"My Class message body with a \u003ca href=\"https://wallet.google\"\u003eHyperlink\u003c\\a\u003e\",\n \"id\": \"message_id\",\n \"message_type\": \"TEXT_AND_NOTIFY\"\n },\n ...\n```\n\n#### Example JSON Request to add message and notify in a Passes Object\n\n```carbon\n ...\n \"id\": OBJECT_ID\",\n \"classId\": \"ISSUER_ID.CLASS_ID\",\n \"message\":\n {\n \"header\":\"My Object message header\",\n \"body\": \"My Object message body with a \u003ca href=\"http://play.google.com/store/apps/details?id=com.google.android.apps.maps\"\u003eHyperlink\u003c\\a\u003e\",\n \"id\": \"message_id\",\n \"message_type\": \"TEXT_AND_NOTIFY\"\n },\n ...\n```\n\n#### Example [Response](/wallet/retail/loyalty-cards/rest/v1/loyaltyclass/addmessage#response-body) to add message and notify for a Pass Class\n\n```scilab\n // The updated resource\n …\n {\n \"kind\": \"walletobjects#walletObjectMessage\",\n \"header\": \"My Object message header\",\n \"body\": \"My Object message body with a \u003ca href=\"http://play.google.com/store/apps/details?id=com.google.android.apps.maps\"\u003eHyperlink\u003c\\a\u003e\",\n \"id\": \"message_id\",\n \"messageType\": \"textAndNotify\"\n },\n …\n```\n\n#### Exception handling\n\nAny attempts to notify more than 3 times will yield a\n**QuotaExceededException** response. Any further updates to the\npass can be set using \"**TEXT** \" instead of\n\"**TEXT_AND_NOTIFY** \" as discussed in the [Integration\nSteps](#add-message-and-notify-integration-steps).\n\n### Update Field and Notify\n\n#### Background\n\nAfter a user adds a pass you may want to trigger a push notification when you update certain\nfields. The notification will appear on the user's lock screen and inform them that there is\nan update on their pass. This notification will only trigger for a specific subset of fields\ndefined [below](#update-field-and-notify-supported-fields) using the UPDATE and PATCH\nAPI methods. Once an API call to update the pass is made the following occurs:\n\n1. A push notification is triggered and displayed on the user's lock screen, informing them of a pass update.\n2. Once the user taps the notification it opens Google Wallet to the front of the pass (a.k.a. Card view) and the user will see a callout at the top of the screen with a \"Review update\" button.\n3. Clicking the button brings the user to a screen where they can see the fields that were changed by the update.\n\n#### Some considerations when sending field update notifications\n\n- Users must have notifications enabled for their passes to receive the push notifications related to updates.\n- You may send a maximum of 3 updates that trigger a push notification in a 24 hour period. Google may throttle your push notification delivery quota if it deems you are spamming your users.\n- The push notification that users see on their lock screen is controlled by Google Wallet.\n- The `notifyPreference` field is a transient field that only lives on this request. For future requests when you wish to trigger a notification, you will have to reset this field on the class or object request.\n\n#### Integration Steps\n\nIn order to trigger these notifications, you will need to use the [existing UPDATE or PATCH\ncalls](/wallet/retail/loyalty-cards/use-cases/updates#use_the_google_wallet_api) and specify the notifyPreference. When updating a field on a class or object, you can\nadd a new field, `notifyPreference`, to the class or object request to trigger the\nnotification.\n\n#### Example JSON Request to update and notify in a Class\n\n```text\n …\n \"dateTime\":\n {\n \"kind\": \"walletobjects#eventDateTime\",\n \"doorsOpen\": \"2024-09-23T19:20:50.00\"\n },\n \"multipleDevicesAndHoldersAllowedStatus\": \"multipleHolders\",\n \"notifyPreference\": \"notifyOnUpdate\",\n …\n \n```\n\nSetting the `notifyPreference` to `notifyOnUpdate` will trigger a notification, provided the updated field is currently supported.\n\n#### Supported fields\n\n##### [LoyaltyClass](/wallet/retail/loyalty-cards/rest/v1/loyaltyclass#resource:-loyaltyclass)\n\n- rewardsTier\n- secondaryRewardsTier\n- programName\n\n##### [LoyaltyObject](/wallet/retail/loyalty-cards/rest/v1/loyaltyobject)\n\n- loyaltyPoints.balance\n- secondaryLoyaltyPoints.balance"]]