circle-exclamation
This documentation is currently under development. Certain sections are not yet complete and will be added shortly.

GooglePass

Handle Google Wallet pass state changes

post
/api/{tenantId}/passes/google

Webhook endpoint called by Google when a pass is saved to or deleted from a device.

Supported Event Types

  • save: Pass added to Google Wallet on a user's device

  • del: Pass removed from Google Wallet on a user's device

Security & Verification

Google signs all webhook messages using JWT. The system verifies the signature before processing any events. Ensures only authentic messages from Google are acted upon.

Deduplication

Uses the nonce field to prevent duplicate processing of the same event. Already-processed messages are ignored and return 204 No Content.

Registration Tracking

  • Increments/decrements installation count for the pass

  • Tracks first installation date when count reaches 1

  • Updates aggregate active and total registration statistics

Path parameters
tenantIdstringRequired
Body
anyOptional
Responses
chevron-right
200

Pass state change processed successfully

No content

post
/api/{tenantId}/passes/google

No content

Handle DiscoverableProgramMerchantSignupInfo flow redirect

get
/api/{tenantId}/passes/google/signup

Webhook endpoint used in Google Wallet's DiscoverableProgramMerchantSignupInfo flow. When users tap "Sign up for more" in Google Wallet, they are redirected to this endpoint.

User Profile Data

Google provides optional user information in Base64-encoded JSON format:

  • First and last name

  • Address (street, city, zipcode, country)

  • Email address

  • Phone number

Parameter Mapping

Google's field names (FIRST_NAME, LAST_NAME, etc.) are automatically mapped to camelCase tenant-relative parameters (firstName, lastName, etc.) for the signup page.

Redirect Behavior

Combines the provided relative URL with the public tenant URI and redirects the user to the signup page with mapped parameters as query string.

Path parameters
tenantIdstringRequired
Query parameters
urlstringOptional

Tenant-relative layout path to redirect to.

Body
userProfilestringOptional

Base64-encoded JSON user profile provided by Google.

Responses
get
/api/{tenantId}/passes/google/signup

No content

Handle DiscoverableProgramMerchantSignupInfo flow redirect

post
/api/{tenantId}/passes/google/signup

Webhook endpoint used in Google Wallet's DiscoverableProgramMerchantSignupInfo flow. When users tap "Sign up for more" in Google Wallet, they are redirected to this endpoint.

User Profile Data

Google provides optional user information in Base64-encoded JSON format:

  • First and last name

  • Address (street, city, zipcode, country)

  • Email address

  • Phone number

Parameter Mapping

Google's field names (FIRST_NAME, LAST_NAME, etc.) are automatically mapped to camelCase tenant-relative parameters (firstName, lastName, etc.) for the signup page.

Redirect Behavior

Combines the provided relative URL with the public tenant URI and redirects the user to the signup page with mapped parameters as query string.

Path parameters
tenantIdstringRequired
Query parameters
urlstringOptional

Tenant-relative layout path to redirect to.

Body
userProfilestringOptional

Base64-encoded JSON user profile provided by Google.

Responses
post
/api/{tenantId}/passes/google/signup

No content

Last updated