v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Android Wallet Templates API

Create the Google Wallet template

Create the Google Wallet (Android) pass template for a wallet campaign. Field semantics follow Google Wallet generic passes (https://developers.google.com/wallet/generic). Many text fields accept Liquid personalization tags that are replaced per recipient.

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

Path parameters

company_keystring required

tokenstring required

The token is the SmartLink token (wallet_id) for the campaign.<br><div style="color:#dd1e2e; background:url(https://d2xs7zaan7w9gl.cloudfront.net/data/pages/64014/widgets/48027d01-e827-45e0-b96d-227c1099eedc/image/1680214872.png?icon-24x24-warning.png) no-repeat 10px center; background-color:#FCEAEC; padding:10px; font-size:13px;"><div style="padding-left:35px"><b>Important:</b> If you are entering a real wallet token, please note that using the <b>"Try It"</b> feature on the righthand console will send an actual API call to our system. This may result in a wallet template being created.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Request body

Example request

{
  "wallet_template": {
    "title": "Spring Sale",
    "issuer": "Example Co",
    "provider": "Example Store",
    "background_color": "#1a73e8",
    "logo": {
      "url": "https://cdn.example.com/logo.png"
    },
    "barcode": {
      "type": "QR_CODE",
      "value": "{{ token }}",
      "alternate_text": "12345"
    }
  }
}

Response

The Google Wallet template was created.

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.