Redeem a wallet pass
Record that a wallet pass installation was scanned or redeemed. This issues an installation_scanned event that can trigger automations and update contact segments (for example to track store visits, event attendance or loyalty check-ins). The request body is optional; any details supplied (location, amount spent, event tag, custom data) are carried on the event.
Authentication
The API key should be passed in the request headers as api-key for authentication.
OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.
Path parameters
Installation ID. The unique identifier of the pass installation being redeemed (as issued when the contact added the pass to their wallet).
Request
Optional details about the scan/redemption.
Amount spent during the visit or transaction. Useful for point-of-sale integrations and purchase tracking.
Arbitrary key/value pairs to attach to the scan event. Forwarded as-is to automations and segmentation (e.g. register id, cashier, department).
Free-form tag identifying the event or context of the scan (e.g. an event name a contact attended). Useful to segment or route automations.
Response
Human-readable confirmation message.
Indicates whether the scan/redemption was recorded.