v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Android Wallet Templates API

Get the Google Wallet template

Retrieve the Google Wallet (Android) pass template for a wallet campaign. Each campaign has a single Google Wallet template.

get/companies/{company_key}/campaigns/wallet/{token}/wallet_template

company_keystring required

tokenstring required

The token is the SmartLink token (wallet_id) for the campaign.

X-API-Versionstring

Successful response

idstring

Unique identifier of the Google Wallet template.

activeboolean

Whether the template is active.

created_atstring

When the template was created, in ISO-8601 format.

updated_atstring

When the template was last updated, in ISO-8601 format.

titlestring

The pass headline.

issuerstring

Organization that issues the pass.

providerstring

Merchant shown on the card. Required for offer passes.

descriptionstring

Free-text offer description shown on the pass. Offer passes only.

background_colorstring

Color that fills the card, as a hex value (for example #1a73e8).

nfc_messagestring

Payload delivered when the pass is tapped on an NFC terminal (smart tap).

enable_expiration_notificationboolean

When true, sends the pass holder a push notification before the offer expires. Offer passes only.

event_idstring

Identifier that groups tickets for the same event (max 64 characters). Event ticket passes only.

ticket_holder_namestring

Name of the ticket holder. Event ticket passes only.

ticket_numberstring

Ticket number. Event ticket passes only.

ticket_typestring

Ticket type. Event ticket passes only.