Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1495145304.5 KB
genericobject

Returns the generic object with the given object ID.

get/walletobjects/v1/genericObject/{resourceId}

Path parameters

resourceIdstring required

The unique identifier for an object. This ID must be unique across all objects from an issuer. This value needs to follow the format issuerID.identifier where issuerID is issued by Google and identifier is chosen by you. The unique identifier can only include alphanumeric characters, ., _, or -.

Response

Successful response

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 issuerID.identifier where issuerID is issued by Google and identifier is chosen by you.

genericType'GENERIC_TYPE_UNSPECIFIED'

Specify which GenericType the card belongs to. Deprecated.

hasUsersboolean

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

hexBackgroundColorstring

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 and if logo is not set, a color would be chosen by Google.

idstring

Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value needs to follow the format issuerID.identifier where issuerID is issued by Google and identifier is chosen by you. The unique identifier can only include alphanumeric characters, ., _, or -.

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.

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

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. If this is not provided, the object would be considered ACTIVE.