Guides: Overview
The Wallet Platform turns a merchant into a digital wallet their guests can save to Apple Wallet or Google Wallet: the branding, the content, the offers, the tickets, the store credit, the memberships. The merchant portal does all of that on its own.
These guides cover the other half of the job: connecting Wallet to a system you
already run.
New to the API? The API Reference overview
covers keys, authentication, rate limits, and your first call. Start there, then
come back.
Redeem at your point of sale
Every redeemable object in Wallet (a voucher, a prize, store credit, a ticket, a
membership tier) is handled through a terminal endpoint, and the shape never
changes:
- Get the item to see what it is and what it is worth.
- Redeem it to spend it.
- Refund it to put it back.
Pick the terminal that matches where the transaction happens:
Web ·
Mobile ·
Shopify ·
Wix ·
WooCommerce
Redemption is the one integration a guest feels the instant it runs, and it moves
real value. Build it against a test merchant before you point it at a live one.
React to what guests do
Wallet emits webhook events
for the moments worth reacting to: a subscriber opts in, a voucher is redeemed, an
invoice is paid, a plan changes.
You subscribe from your merchant portal, which opens a delivery console where you
add endpoints, read your signing secret, and replay anything that failed. Two
things to build for:
- Verify the signature on every delivery. An unverified endpoint is a public
endpoint. - Expect retries. Anything that is not a 2xx comes back, so make your handler
safe to run twice on the same event.
Bring your existing audience in
You do not have to start from an empty list.
One caution worth more than the rest of this section: importing a list moves the
records, it does not move consent. You remain responsible for having permission
to message everyone in that file, and the obligation attaches per message type,
not per list.
Put wallet content on your own site
A small set of endpoints take no API key, so you can call them straight from a
public page:
- Sign up an email subscriber or an
SMS subscriber from your own form - Resolve a vanity handle to the
wallet behind it - Offer a calendar file for an upcoming
event, or a business card download
Because these need no key, treat everything they return as public, and never put
one behind a form that collects anything you would not publish.
Getting help
Ask in Discord, or email
[email protected].
Updated 8 days ago