Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1398152302.3 KB
giftcardobject

Updates the gift card object referenced by the given object ID. This method supports patch semantics.

patch/walletobjects/v1/giftCardObject/{resourceId}

Path parameters

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

Request body

hasUsersboolean

Indicates if the object has users. This field is set by the platform.

pinstring

The card's PIN.

eventNumberstring

The card's event number, an optional field used by some gift cards.

cardNumberstring

Required. The card's number.

versionstring int64

Deprecated

hasLinkedDeviceboolean

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.

idstring

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

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'active' | 'COMPLETED' | 'completed' | 'EXPIRED' | 'expired' | 'INACTIVE' | 'inactive'

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.

disableExpirationNotificationboolean

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.

classIdstring

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.

smartTapRedemptionValuestring

The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields enableSmartTap and redemptionIssuers must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.

notifyPreference'NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED' | 'NOTIFY_ON_UPDATE'

Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.

kindstring

Identifies what kind of resource this is. Value: the fixed string "walletobjects#giftCardObject".

linkedObjectIdsstring[]

linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.

Response

Successful response