Wallet Passes
Patient Pass is the product name (identity in the patient’s wallet). These endpoints stay at/wallet-passes.
Query templates, issue a pass, verify a scan, and send push notifications. The patient must already be a customer of the shop — create or resolve them with POST /patients first, then POST /wallet-passes. See Patient Pass.
List Templates
Retrieve wallet pass templates for a specific shop.wallet_pass_template:read
Example Request
Response
List Wallet Passes
Retrieve wallet passes for a specific shop customer and shop combination.wallet_pass:read
Example Request
Response
total is the number of passes in data — this endpoint returns every matching pass in
one response and is not paginated, so it carries neither totalRegistries nor
totalPages.The Wallet Pass Object
Create a Wallet Pass
shop_customer_id together with the shop_identifier, so you never need to
resolve an RxScale patient UID first.
Required permission: wallet_pass:write
Request Body
Optional calendar date when this pass should expire, in
YYYY-MM-DD. Omit to use the template default (fixed date, validity in days from issuance, or no expiry). Set on first creation only — refreshing an existing pass does not change expires_at.Example Request
Response
Returns the wallet pass object.The status code tells you whether a pass was created or reused. This endpoint is
idempotent per patient and template:
201 means a new pass was issued, 200 means the
patient already had a pass for that template and it was refreshed and returned. Calling
it twice will not give the patient two passes.ios_download_url / android_download_url to the patient to add the pass to their
wallet.
Error Responses
A template that requires a signed prescription returns a specific message, so you can
distinguish it from a malformed request:
Get a Wallet Pass
deleted_at is null).
Required permission: wallet_pass:read
Example Request
Response
Returns the wallet pass object.Error Responses
Delete a Wallet Pass
deleted_at is set, so a
scan of a revoked pass still resolves — POST /wallet-passes/verify answers
"valid": false with "status": "revoked" rather than a 404.
Required permission: wallet_pass:write
Example Request
Response
204 No Content with an empty body.
Error Responses
Verify a Scanned Pass
Resolve a scanned Patient Pass to shop-scoped identity handles. Requires an API key with thewallet_pass:verify permission.
wallet_pass:verify
Request Body
The value encoded in the pass barcode. Treat it as a credential and send it in the body, never in a URL.
Example Request
Response (200)
An expired pass returns HTTP
200 with "valid": false, "status": "expired", and "expired": true, but still includes wallet_pass_uid, patient_profile_uid, and shop_customer_id when available. A revoked pass returns "valid": false with "status": "revoked"; if a pass is both revoked and past its expiry, "status" is "revoked". shop_customer_id is absent for passes issued before the shop customer requirement.
This endpoint returns identity handles only. Load the patient’s details with GET /v1/management/patients.
Error Responses
Send Push Notifications
Send push notifications to one or more wallet pass holders. Accepts a batch of notifications.wallet_pass_push_notification:write