Google Parameters
Parameters grouped by pass type for Google Loyalty, Coupon, Access Control, and Ticket passes.
Coupon
For discounts, offers, and promotional passes.
Appearance
brand.logo
file image (png)
Logo image for the coupon. Must be PNG format and 660x660 pixels in size.
hero.image
file image (png)
Hero image displayed at the top of the pass. Must be PNG format and 1032x336 pixels in size.
background.color
string
default: #F9FAFB
Background color for the full Google pass. Accepts hex color codes or rgb() values.
Header
brand.text
string
default: Brand Text
Displays on right side of logo. Optional localized issuer name.
Coupon Settings
coupon.details
string
default: Coupon Details
Main offer title displayed prominently on the pass.
NFC
nfc.message
string
NFC payload (max 64 bytes). If empty, the pass defaults to Barcode if set to anything other than none.
Barcode
barcode.message
string
Text displayed below the barcode for manual entry.
barcode.value
string
default: 123456789
The data encoded in the barcode.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
QR_CODE(2D square barcode, high data capacity)AZTEC(2D barcode, commonly used for tickets and boarding passes)PDF_417(2D stacked barcode, used for IDs and transport)CODE_128(1D barcode for alphanumeric data)CODE_39(1D barcode for alphanumeric data, widely supported)CODABAR(1D barcode for libraries and blood banks)EAN_8(8-digit product barcode)EAN_13(13-digit product barcode)ITF_14(14-digit barcode for packaging)UPC_A(12-digit product barcode)
Back Fields
provider
string
required
default: Provider Name
The offer provider (merchant or aggregator name). Required by Google.
details
string
Additional details about the offer. Visible on pass back.
fine.print
string
Fine print or terms and conditions. Visible on pass back.
Locations
location.latitude
string
Latitude in degrees where pass should be highlighted.
location.longitude
string
Longitude in degrees where pass should be highlighted.
Misc
expiration.date
datetime
End time when offer stops being valid. ISO 8601 format.
Loyalty
For membership cards, rewards programs, and store cards.
Appearance
brand.logo
file image (png)
Logo image for the loyalty program. Must be PNG format and 660x660 pixels in size.
hero.image
file image (png)
Hero image displayed at the top of the pass. Must be PNG format and 1032x336 pixels in size.
background.color
string
default: #F9FAFB
Background color for the full Google pass. Accepts hex color codes or rgb() values.
Header
brand.text
string
default: Brand Text
Displays on right side of logo. Optional localized issuer name.
program.name
string
default: Program Name
Displays in large font at top of pass. Optional localized program name.
Loyalty
points.label
string
default: Reward Points
Label for primary loyalty points.
points.value
integer
Primary loyalty points balance.
secondary.label
string
default: Points until reward
Label for secondary loyalty points.
secondary.value
integer
Secondary loyalty points balance.
NFC
nfc.message
string
NFC payload (max 64 bytes). If empty, the pass defaults to Barcode if set to anything other than none.
Barcode
barcode.message
string
Text displayed below the barcode for manual entry.
barcode.value
string
default: 123456789
The data encoded in the barcode.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
QR_CODE(2D square barcode, high data capacity)AZTEC(2D barcode, commonly used for tickets and boarding passes)PDF_417(2D stacked barcode, used for IDs and transport)CODE_128(1D barcode for alphanumeric data)CODE_39(1D barcode for alphanumeric data, widely supported)CODABAR(1D barcode for libraries and blood banks)EAN_8(8-digit product barcode)EAN_13(13-digit product barcode)ITF_14(14-digit barcode for packaging)UPC_A(12-digit product barcode)
Back Fields
account.name.label
string
default: Account Name Label
Label for member name. Visible on pass back.
account.name
string
Member name value. Visible on pass back.
account.id.label
string
default: Account ID Label
Label for member ID. Visible on pass back.
account.id
string
Member ID value. Visible on pass back.
rewards.tier.label
string
default: Tier Label
Label for rewards tier. Visible on pass back.
rewards.tier
string
default: Tier Value
Rewards tier value (e.g., "Gold", "Platinum"). Visible on pass back.
Locations
location.latitude
string
Latitude in degrees where pass should be highlighted.
location.longitude
string
Longitude in degrees where pass should be highlighted.
Misc
expiration.date
datetime
End time when pass stops being relevant. ISO 8601 format.
Event Ticket
For concerts, sports events, movies, and flights.
Appearance
brand.logo
file image (png)
Logo image for the pass. Must be PNG format and 660x660 pixels in size.
hero.image
file image (png)
Hero image displayed at the top of the pass. Must be PNG format and 1032x336 pixels in size.
background.color
string
default: #F9FAFB
Background color for the full Google pass. Accepts hex color codes or rgb() values.
Header
brand.text
string
default: Brand Text
Displays on right side of logo. Optional localized issuer name.
Event Info
event.name
string
required
default: Event Name
Displays in large font at top of pass. Required by Google.
venue.name
string
default: Venue Name
Venue name displayed on the pass.
event.start.label
string
Custom label for date/time (e.g., "Doors Open").
event.start.time
datetime
Event start date and time. ISO 8601 format.
Seat Info
venue.gate
string
Gate number.
gate.label
string
default: Gate
Custom label instead of "Gate".
venue.section
string
Section number.
section.label
string
default: Section
Custom label instead of "Section".
venue.row
string
Row number.
row.label
string
default: Row
Custom label instead of "Row".
venue.seat
string
Seat number.
seat.label
string
default: Seat
Custom label instead of "Seat".
NFC
nfc.message
string
NFC payload (max 64 bytes). If empty, the pass defaults to Barcode if set to anything other than none.
Barcode
barcode.message
string
Text displayed below the barcode for manual entry.
barcode.value
string
default: 123456789
The data encoded in the barcode.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
QR_CODE(2D square barcode, high data capacity)AZTEC(2D barcode, commonly used for tickets and boarding passes)PDF_417(2D stacked barcode, used for IDs and transport)CODE_128(1D barcode for alphanumeric data)CODE_39(1D barcode for alphanumeric data, widely supported)CODABAR(1D barcode for libraries and blood banks)EAN_8(8-digit product barcode)EAN_13(13-digit product barcode)ITF_14(14-digit barcode for packaging)UPC_A(12-digit product barcode)
Back Fields
venue.address
string
default: 123 Venue Address
Venue address. Visible on pass back.
relevant-end-date
datetime
Event end date and time. ISO 8601 format.
Locations
location.latitude
string
Latitude in degrees where pass should be highlighted.
location.longitude
string
Longitude in degrees where pass should be highlighted.
Access Control
For employee badges, visitor passes, and ID cards.
Appearance
brand.logo
file image (png)
Logo image for the pass. Must be PNG format and 660x660 pixels in size.
hero.image
file image (png)
Hero image displayed at the top of the pass. Must be PNG format and 1032x336 pixels in size.
background.color
string
default: #F9FAFB
Background color for the full Google pass. Accepts hex color codes or rgb() values.
Header
card.title
string
required
default: Brand Text
Displays on right side of logo. Required by Google.
subheader
string
default: Header Label
Label displayed above the header (e.g., "Employee ID").
header
string
required
default: Header Value
Main header text (e.g., person's name). Required by Google.
Secondary Fields
secondary.1.label
string
First label in the second row of fields.
secondary.1.value
string
First value in the second row of fields.
secondary.2.label
string
Second label in the second row of fields.
secondary.2.value
string
Second value in the second row of fields.
Auxiliary Fields
auxiliary.1.label
string
First label in the third row of fields.
auxiliary.1.value
string
First value in the third row of fields.
auxiliary.2.label
string
Second label in the third row of fields.
auxiliary.2.value
string
Second value in the third row of fields.
auxiliary.3.label
string
Third label in the third row of fields.
auxiliary.3.value
string
Third value in the third row of fields.
NFC
nfc.message
string
NFC payload (max 64 bytes). If empty, the pass defaults to Barcode if set to anything other than none.
Barcode
barcode.message
string
Text displayed below the barcode for manual entry.
barcode.value
string
default: 123456789
The data encoded in the barcode.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
QR_CODE(2D square barcode, high data capacity)AZTEC(2D barcode, commonly used for tickets and boarding passes)PDF_417(2D stacked barcode, used for IDs and transport)CODE_128(1D barcode for alphanumeric data)CODE_39(1D barcode for alphanumeric data, widely supported)CODABAR(1D barcode for libraries and blood banks)EAN_8(8-digit product barcode)EAN_13(13-digit product barcode)ITF_14(14-digit barcode for packaging)UPC_A(12-digit product barcode)
Locations
location.latitude
string
Latitude in degrees where pass should be highlighted.
location.longitude
string
Longitude in degrees where pass should be highlighted.
Misc
relevant.date
datetime
End time when pass stops being relevant. ISO 8601 format.