# Voucher Platform

> Partner integration docs for the Voucher Platform.

## Docs

- [Claim a voucher to the user's wallet](https://docs.vouchersx.com/api-reference/consumer/claim-a-voucher-to-the-users-wallet.md): Adds a wallet-flow voucher to the user's saved list. Required before the same voucher can be redeemed at an outlet. Idempotent — calling twice returns the original claim row with HTTP 200. Only works for vouchers whose `claimFlow` is `WALLET`; instant-flow vouchers are redeemed directly without clai…
- [Favorite a merchant](https://docs.vouchersx.com/api-reference/consumer/favorite-a-merchant.md): Marks a merchant as a favorite so the user receives `VOUCHER_PUBLISHED` events for new vouchers and unlocks vouchers flagged `favoritesOnly`. Idempotent.
- [Get current user + partner brand](https://docs.vouchersx.com/api-reference/consumer/get-current-user-+-partner-brand.md): Bootstrap call for the embedded webview. Returns the user the JWT resolved to (created just-in-time on first request) plus the partner brand block so the UI can render your logo without a second round-trip.
- [List the user's favorited merchants](https://docs.vouchersx.com/api-reference/consumer/list-the-users-favorited-merchants.md): Joins each favorite with the current merchant metadata. Newest favorites first.
- [List the user's redemption history](https://docs.vouchersx.com/api-reference/consumer/list-the-users-redemption-history.md): Newest first. Includes both SUCCESS and FLAGGED rows.
- [List the user's wallet claims](https://docs.vouchersx.com/api-reference/consumer/list-the-users-wallet-claims.md): All vouchers the user has claimed, newest first. Each row joins the current voucher state, so `voucherIsActive=false` means the merchant has since unpublished it — the claim still exists but can no longer be redeemed.
- [Redeem a voucher at an outlet](https://docs.vouchersx.com/api-reference/consumer/redeem-a-voucher-at-an-outlet.md): Atomically validates the PIN, GPS distance, redemption limits, claim/membership requirements, and dispenses a voucher code (when the voucher is configured for codes).
- [Unfavorite a merchant](https://docs.vouchersx.com/api-reference/consumer/unfavorite-a-merchant.md): Idempotent — returns 204 whether or not the favorite existed.
- [Anonymise a partner user](https://docs.vouchersx.com/api-reference/integrations/anonymise-a-partner-user.md): Soft-deletes the user: clears email/displayName/phone/countryCode/locale and stamps `anonymizedAt`. The redemption and claim history is **preserved** for audit and reporting. A subsequent `POST /integrations/users` with the same `externalUserId` revives the row and re-populates the PII. Use this to…
- [Upsert a partner user](https://docs.vouchersx.com/api-reference/integrations/upsert-a-partner-user.md): Idempotently provisions or updates a consumer from the partner backend. Keyed by `(partner_id, externalUserId)`. If the user was previously anonymised via `DELETE`, calling this again revives the row and clears `anonymizedAt`. PII fields that are omitted are left unchanged; passing an explicit `null…
- [HMAC authentication](https://docs.vouchersx.com/authentication/hmac.md): Signing server-to-server requests and verifying webhook callbacks.
- [JWT authentication](https://docs.vouchersx.com/authentication/jwt.md): Authenticating consumer requests with a partner-signed JWT.
- [Onboarding & credentials](https://docs.vouchersx.com/concepts/credentials.md): Everything we issue at onboarding and how to handle each value.
- [Vocabulary](https://docs.vouchersx.com/concepts/overview.md): Terms you will see throughout this documentation.
- [Introduction](https://docs.vouchersx.com/introduction.md): What the Voucher Platform partner integration is and how the pieces fit together.
- [Quickstart](https://docs.vouchersx.com/quickstart.md): End-to-end worked example: provision a user, mint a JWT, open the webview, receive the webhook.
- [Errors reference](https://docs.vouchersx.com/reference/errors.md): Every error code, its HTTP status, and what it means.
- [Operational notes](https://docs.vouchersx.com/reference/operational-notes.md): Environments, clock skew, logging, and where to escalate.
- [Consumer API](https://docs.vouchersx.com/surfaces/consumer-api.md): Routes called from inside the webview (or your own UI) on behalf of an end user.
- [Server-to-server API](https://docs.vouchersx.com/surfaces/server-to-server.md): Routes your backend calls with HMAC auth.
- [The webview](https://docs.vouchersx.com/surfaces/webview.md): Embedding the voucher UI inside your native app.
- [Delivery semantics](https://docs.vouchersx.com/webhooks/delivery.md): Retry schedule, idempotency, and receiver requirements.
- [Webhooks overview](https://docs.vouchersx.com/webhooks/overview.md): Outbound HTTP POSTs the Voucher Platform sends to your webhookUrl.
- [Event payloads](https://docs.vouchersx.com/webhooks/payloads.md): The full body shape for each webhook event, with verification code.

## OpenAPI Specs

- [openapi](https://docs.vouchersx.com/openapi.json)