Show loyalty balance
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pass UUID or External ID
Query Parameters
If true, includes the pass design in the response
If true, includes the locations in the response if any are present
If true, includes the beacons in the response if any are present
Response
When pass has been added to wallet by the user. In ISO8601 format, UTC
Beacons, present if 'includeBeacons' query param is set to true
Major Value, provides additional identification for a beacon
Message to display on lock screen when the user is in range of the beacon
Minor Value, provides additional identification for a beacon
Name of the beacon, used for display purposes only
Unique identifier of the beacon
In ISO8601 format, UTC
When pass has been deactivated. In ISO8601 format, UTC
android, iphone Unique download URL of the pass
Pass will expire at this time. In ISO8601 format, UTC
Pass External ID
Tag used for grouping passes
If present, the last push message sent to the pass
Locations, present if 'includeLocations' query param is set to true
Latitude of the location
Longitude of the location
Name of the location, used for display purposes only
Geocoded address of the location. Used for display purposes only. This is calculated automatically from the latitude and longitude values
Message to display when user enters geofence
Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types
10 < x < 1000If present, the NFC message to be conveyed when the pass is tapped
The templateKey identifies an individual pass field in the pass template, using the template field ID. The value is the assigned value for a specific field and is displayed on the pass. For example, {'fullName': 'Jane Smith'} corresponds to the 'fullName' template field ID.
Pass design values, present if pass template has been overridden for this pass, or if 'includePassDesign' query param is set to true
Pass background color in hex format
URL of pass banner image
Pass label color in hex format. Only valid for iphone passes
URL of pass logo image
Pass text color in hex format. Only valid for iphone passes
Pass source, present if 'includePassDesign' query param is present, one of Apple/Google and current pass status is not 'active'.
Apple Wallet Pass Base64 string, to generate the pass, decode the string and save as a .pkpass file. Will prompt the user to download the pass to their Apple Wallet when opened on an iPhone.
Google Wallet Pass download URL. Will prompt the user to download the pass to their Google Wallet when opened on an Android device.
Name of corresponding pass template
UUID of corresponding pass template
Pass Type
generic, eventTicket, storeCard When pass has been removed from wallet by the user. In ISO8601 format, UTC
Pass Status
issued, active, removed, deactivated Auto-generated UUID of the pass
Was this page helpful?