Issue and update Wallet passes from your own system.
Signing Apple passes, managing Google objects and keeping every change in sync is a project in itself. The Vuelvy API lets your technical team integrate enrolment, issuance, updates, events and redemptions for a programme that is already published. Programme design and publication happen in the dashboard.
Google shares your name, email and profile picture, if available, to verify your identity. This does not subscribe you to marketing. Privacy policy
Notification and update availability depends on each Wallet platform’s capabilities and policies.
- 01Keys with per-operation permissions
- 02Idempotency-Key where required
- 03Asynchronous, traceable issuance
- 04Documentation shared by scope
What you can integrate
Wallet API v1 covers the day-to-day operation of a published programme. Pass design and version publication stay in the Vuelvy dashboard and are not managed through the API.
- Enrolment, profiles and consents
- Pass issuance, lookup and updates
- Enrolment QR codes and links
- Events, points, benefits and redemptions
A minimal example of the contract
To issue a pass, your system sends an authenticated request with its key and an idempotency key. Issuance is asynchronous: the response confirms the operation was accepted, not that the customer already has the pass in their Wallet.
- Request: POST /api/wallet/v1/passes with Authorization: Bearer and the Idempotency-Key header.
- Body: programId of the published programme, optional subscriberId and pass data.
- 202 response: passId, state “pending” and operation identifiers to check its status.
- Repeating the same request with the same idempotency key returns 200 without creating another pass.
Explicit errors and safe retries
Every response tells you whether to fix the request, check permissions or retry. Operations that require it, such as pass issuance, need an Idempotency-Key, so a retry after a network failure does not duplicate the operation.
- 401 invalid_credentials: missing, revoked or expired key
- 403 forbidden: the key lacks that permission
- 400 idempotency_key_required: header missing on an operation that requires it
- Request limit per key
Apple and Google: one contract without false parity
The API unifies the business logic and Vuelvy generates each provider's variant. Apple and Google keep different credentials, fields, updates and alerts; when a capability does not exist on a platform, it is not simulated.
How to get access and documentation
The technical reference is not public. If your case needs an integration, request a scope assessment: we review which operations you need, who owns the integration and which data is exchanged. Keys are then created with the minimum permissions for your organisation and we share the documentation for those endpoints. Every case is assessed individually before you sign up.
- Use case and required operations
- Minimum permissions per key
- Personal data and consent reviewed
- Test plan before working with real customers
FAQ
Frequently asked questions
Is the API documentation public?
No. The endpoint reference is shared once the technical scope is agreed, together with keys holding the minimum permissions for your organisation.
Can I issue for several brands?
Yes, with separate credentials: each key belongs to one organisation and only operates its programmes, passes and data. An agency with several brands uses different keys for each organisation.
What can the Wallet Marketing API automate?
The API connects enrolment, pass issuance, updates, statuses and business events with Apple Wallet and Google Wallet. Scope is defined by use case so only the required operations are exposed.
Can one integration support Apple Wallet and Google Wallet?
Vuelvy unifies the business logic and adapts output for each provider, while Apple and Google retain different models, credentials and capabilities. The integration avoids duplicating common operations without pretending both platforms are identical.
How is API and data access protected?
Access is authenticated, scoped by organisation and logged for traceability. Provider credentials and each brand's data remain separated according to the contracted scope.
Does the API send webhooks to my system?
The integration is designed for your system to send events and check operation status. If your case needs Vuelvy to notify another system, that is assessed during the scope assessment before it is committed. Operations that require it use an Idempotency-Key so a retry does not duplicate the operation.
Let’s discuss your case
Does Wallet make sense for your business?
Tell us about your case and we will contact you by email to review integrations, the activation plan and the next step. No generic deck and no commitment.
Google shares your name, email and profile picture, if available, to verify your identity. This does not subscribe you to marketing. Privacy policy