Email and web
To effectively distribute wallet passes to your members display Add to Apple/Google Wallet buttons multiple places. All assets can be found at the bottom of this page.
Emails
- Wallet pass launch email
- Digital receipts
- Newsletters
- Campaigns
Web
- Signup flow
- My pages
- Receipt page
In-store
You can print QR-codes that takes a user to the Pass request page where existing members can get their wallet pass sent to them via email and/or sms. A link to your register page will be displayed on the top of the page for user’s that aren’t members yet.
We will provide links using our link shortening service so that you can update where the links go without having to print new QR-codes, e.g https://wshr.io/zoo/digitalt-medlemskort.
Technical
“Add to Apple/Google wallet” links using contactId
If you for one reason or another can’t use the API endpoint meant for server-to-server communication, which is the method we recommend. This endpoint does not use an API-key and can be used to place links directly in emails, my pages and other places. This relies on members not knowing other members contactId and is therefore not as secure as the server-to-server method, but can be used out of the box and is in most cases secure enough. If you have questions don’t hesitate to reach out.
| Base URL | https://voyado-integration.washere.io |
| Path | /api/cards/{cardId}/{walletProvider}/contact/{contactId} |
| Method | GET |
| Header | No header required. |
| Response | HTML (redirects use on success or error). |
Replace {cardId} with the card id you’ve been provided by WasHere, use apple or google as the value for {walletProvider} and {contactId} with the contact id of the member.
| Replace values | |
|---|---|
{cardId} |
Card id you’ve been provided by WasHere. |
{walletProvider} |
Replace with apple or google for the respective “Add to Wallet” button. |
{contactId} |
Contact id of the member. |
Success response
HTTP/2 302
date: Fri, 17 May 2024 11:48:36 GMT
content-length: 0
location: https://i.washere.io/join/{slug}/qr?url=https://voyado-integration.washere.io/api/cards/{cardId}/apple/contact/{contactId}
Error response
HTTP/2 302
date: Fri, 17 May 2024 11:48:36 GMT
content-length: 0
location: https://i.washere.io/join/{slug}/error?code=500
The error page will be a generic error page, see the screenshot below. You can configure your own background color and add your own logo.
What if I don’t have access to contactId/correlationId?
contactId.In this case we can use an encrypted representation of the user’s email address. You will be provided an encryption key. We use AES-256 GCM.
You can see an example implementation here in PHP (e.g for Magento) or here in TypeScript.
The only difference from using contactId as described above would be to use the below path instead, everything else is the same.
| 🔗 Path | /api/cards/{cardId}/{walletProvider}/contact/email/{encryptedEmail} |
Pass request page
A pass request page can, optionally, be configured where the member can get their wallet pass sent to them via SMS and/or email. Both the email and SMS can be sent via the loyalty plattform if the platform supports it, like Voyado, or via WasHere. If sent via WasHere it will be sent via a preconfigured phone number (cannot be changed) and the email is also standardized and cannot be customized at all.
Supported fields
- SMS
- SSN
- Member number
Both SMS and email will be sent if both a phone number and email address exists on the member profile.
Zoo.se example
In-store form to get wallet pass.
Member can get wallet pass sent via sms/email.
SMS can be sent via loyalty platform, if feasible, or from WasHere.
Email with “Add to wallet” links.
Diagram
Assets
Apple Wallet buttons
Google Wallet buttons
Apple Wallet guidelines and files
Click here to visit the Apple developer site.
Google Wallet guidelines and files
Click here to visit the Google developer site.
Article last reviewed
Comments
0 comments
Please sign in to leave a comment.