Skip to main content
TermMeaning
PartnerYour company — an external app that integrates with the Voucher Platform. Identified by a partner_id (UUID) and slug.
External user IDYour stable identifier for an end user (typically your DB primary key). Treated as opaque on our side.
Internal user IDOur UUID for the same user, returned the first time you provision them. Stable forever.
WebviewA single-page React UI hosted by us. You embed it (or link to it) from your native app. Authenticated by a partner-signed JWT.
JWTShort-lived token your app signs for a single user, used by the webview and consumer endpoints.
HMACStripe-style signed header used to authenticate your server’s calls to /integrations/*.
WebhookOutbound HTTP POST we make to your webhookUrl when a user event happens.
ScopeOptional allowlist limiting which merchants / categories your users can see. Defaults to ALL — everything in our catalog.
VoucherA redeemable offer published by a merchant. Either claimed first (wallet flow) or redeemed directly (instant flow).
OutletA physical location where a voucher can be redeemed. Has a 4-digit staff PIN and (usually) GPS coordinates.
CycleRepeating window in which a per-user redemption limit applies — ONE_TIME, MONTHLY, or BIWEEKLY.
CodeOptional one-time code dispensed to the user on redemption. Either MANUAL (pre-uploaded by the merchant) or AUTO (generated by us).
FavoriteA user “starring” a merchant. Drives VOUCHER_PUBLISHED fan-out and gates vouchers flagged favoritesOnly. (Previously called subscription — same concept, renamed in 2026-05.)
CommissionPer-voucher revenue snapshot taken at redemption time. Stored on each redemption row and surfaced in admin reports. Editing the voucher’s commission later does not rewrite past redemptions.
Billing entityThe SSM-registered company behind one or more outlets. Each outlet must be linked to a billing entity before its vouchers can go live so accounting can invoice per legal entity. Internal-only — partners never see these.