Glossary
Identity and identifiers
virtualId — Your pseudonymous identifier for a user. Publisher-owned, unique per user,
immutable, and must contain no personal data. The iOS SDK names its launch parameter userID,
which carries this same value. See
Core concepts.
CHANNELID / channelName / bName — Your publisher identity, issued by Cheggout. An
identifier, not a secret. The payload key differs by endpoint and is matched case-sensitively.
extTransactionId — Your unique reference for a rewardable event or a coupon claim. Globally
unique, never reused. Serves as both the idempotency key and the reconciliation key.
orderId — A Cheggout-generated reference for a delivered coupon, described as the official
delivery record.
rewardId / scratchcardId — A scratch card's identifier. Both names appear; rewardId is the
one used when revealing.
referenceId — Cheggout's reference for a webhook event.
cheggoutRefNo — Cheggout's reference for a payment transaction in the deep payment flow.
Credentials
Reference token (referenceKey) — A channel-scoped bearer token minted by
getSecuredReferenceToken. Refreshed
hourly and cached. Used by GetReward. Never place it on a client.
User token — A user-scoped bearer token minted by
GetAuthToken. Used to reveal rewards and list history.
sessionId / SessionToken — A session handle from
GenerateSessionInfoV2, passed with the virtualId
when launching the SDK or a microsite so the user arrives already signed in.
APP_KEY / SEC_KEY — The API key pair used by the Deals Store, sent in the Authorization
header. Secrets — backend only.
SIGN / BDATA — The signature and Base64 payload of the
signed envelope. SIGN covers the BDATA string.
Platform concepts
Placement — A slot in your UI that Cheggout can fill, addressed by placementId. You integrate
the slot; Cheggout decides the content.
Trigger event (triggerEventType, eventType) — A predefined code telling Cheggout that a
rewardable thing happened. subTriggerEventType provides a finer sub-category.
Campaign — Cheggout's configuration of what a trigger produces: eligibility rules, reward pool, frequency caps and budget. Configured by Cheggout, never by the publisher.
Frequency cap — A limit on how often a user can receive a reward. A common reason for a legitimate "no reward" response.
Two-phase issuance — Scratch cards are created empty and the reward is assigned only at reveal, so inventory is not burned on cards nobody opens.
Late binding — The assignment step at reveal, applying the targeting context stored at creation.
Rewards
Temporary card — A card created by GetReward that
carries eligibility but no assigned reward yet.
Reveal — Calling FetchRewardInfo to assign and
return the reward. One-shot — re-revealing returns REWARD NOT FOUND.
BETTER LUCK NEXT TIME — A successful reveal with no reward behind it. A normal outcome.
couponType — "Brand" for a coupon reward, "points" for a points reward. Determines which
response fields are populated.
isSeen — Whether a card has been revealed. Distinguishes the two element types in reward
history.
Deals
Catalogue — The full offer list. Not user-specific, therefore cacheable.
Inventory — Live remaining stock per offer, with a 180-second TTL.
Coin burn — Deducting the user's coins or points in your wallet before requesting a coupon. Cheggout has no wallet API.
purchase_limit — How many times one user may claim an offer. Exceeding it returns
MAX_LIMIT_REACHED.
Tags — Targeting labels on an offer. The publisher decides which users see which offers.
CPE — Cost per engagement, carried on catalogue offers.
Tracking
Impression — Fired when an item becomes visible to the user.
Click — Fired when the user taps or scratches an item.
trackLink / clicktrack / copyClick / redeemClick — Arrays of tracking URLs returned with
rewards. Fire them with a plain GET.
href — On banner and store responses, a pseudo-XML string carrying tracking URLs plus display
metadata. Pass it to the SDK, or parse the tag you need.
Surfaces
Headless — API-only integration with no Cheggout UI at all.
SDK — The native Android or iOS library.
Widget — The browser script that renders reward banners and scratch-card overlays.
Hosted experience / microsite / PWA — A Cheggout-hosted web experience launched with a session, served from a Cheggout subdomain or your own branded domain.
Deep link — A click.cheggout.com URL that opens a specific destination inside the SDK or a
hosted experience.
DeeplinkInfo — The SDK launch payload field carrying a deep link, so the SDK opens on a
specific screen.
Heartbeat — The SDK's user-activity signal, used to decide whether a returning user goes to your home screen or your login screen.
Deep payment
Deep payment — The flow where Cheggout hands a payment back to your app to execute, then relaunches with the result.
COLLECTPAYMENT — The response code identifying a payment collection request.
Paisa — Deep payment amounts are expressed in paisa: "54000" means ₹540.00.
Client Status API — The endpoint you host so Cheggout can check a payment's status.