Skip to main content

Integration models

Two decisions: which modules you want, and which surface you integrate them on. This page helps you make both, then points at the right guide.

Decide the surface first​

SurfaceYou buildCheggout providesEffort
Headless APIEverything the user seesJSON onlyHigh effort, total control
Native SDKPlacement and launch pointsRendering components and the full marketplaceMedium
JavaScript widgetA container div and event triggersBanner and scratch-card overlayLow
Hosted (PWA)Authentication and a launch buttonThe entire journeyLowest

You can mix. A bank commonly uses the SDK for the marketplace and headless APIs for post-transaction rewards on its web channel.

Reference models​

Named combinations we see in practice. Effort estimates assume a competent team with the prerequisites already in place, and cover integration only — not campaign design or commercial setup.

Model A — Advertisement only​

Monetise attention you already have.

  • Modules Advertisement
  • APIs Banner and store placement APIs, plus impression and click tracking
  • Auth Session or token from your backend
  • Journey User opens a screen → you request the placement → render the creative → fire impression → user taps → fire click → they land on the offer
  • Effort ~1 week on one surface

Model B — Scratch cards only​

The single most common starting point. Reward a moment you already own.

  • Modules Scratch Cards & Rewards
  • APIs Rewards Center — reference token, GetReward, GetAuthToken, FetchRewardInfo, GetAllScratchCardsByUserId
  • Auth RSA-signed envelope from your backend, then bearer tokens
  • Journey Transaction completes → card appears → user scratches → reward revealed → user redeems at the merchant
  • Effort ~2 weeks headless; a few days with the SDK or widget

Model C — Marketplace only​

Give customers a shopping and offers destination without building commerce yourself.

  • Modules Lifestyle Marketplace
  • APIs GenerateSessionInfoV2 for single sign-on
  • Auth RSA-signed envelope, then an SDK session
  • Journey User taps "Shop" → you mint a session → SDK or microsite launches, already signed in
  • Effort Roughly 2–3 weeks native SDK; roughly 1 week hosted. Estimates, not commitments.

Model D — Refer & Earn only​

The lightest module to run standalone — it needs no other Cheggout module, and on the microsite and CRM paths it needs no SDK either.

  • Modules Refer & Earn
  • Surfaces Mobile SDK by deep link, hosted microsite, or a CRM campaign
  • Auth SSO from your app session, or mobile number and OTP on the web
  • Journey Customer shares a code → friend signs up with it → you activate the account and fire RegisterEvent → both sides are rewarded
  • You build One signed server-to-server call on activation. Plus a sendSMS webhook for the microsite path, or getReferralCodeForUser for the CRM path.
  • Effort Roughly 1–2 weeks. Estimate, not a commitment.

See Refer & Earn.

Model E — Marketplace + Scratch cards​

The standard bank package: a shopping destination plus a reason to transact.

  • Modules Marketplace, Scratch Cards
  • Shared One session and identity serve both; the reward list lives inside the marketplace
  • Effort ~3–4 weeks native

Model F — Marketplace + Advertisement​

Commerce destination plus monetised placements on your existing screens.

  • Modules Marketplace, Advertisement
  • Shared Same session; banners deep-link into marketplace pages
  • Effort ~3–4 weeks

Model G — Coupons & Deals (headless commerce)​

For publishers with their own points or coin economy who want to run the storefront themselves.

  • Modules Coupons & Deals
  • APIs Deals Store — catalogue, inventory, coupon delivery, user coupons
  • Auth API key header, server-to-server only
  • Journey You cache the catalogue → user spends coins in your wallet → you request the coupon → you store it under "My Coupons"
  • Effort ~2 weeks, plus your own storefront
  • Note The coin burn is entirely yours. Cheggout has no wallet API. Burn coins first, then request the coupon, and refund if delivery fails.

Model H — Full platform​

Everything, usually phased rather than launched at once.

Recommended sequence: marketplace session first (it establishes identity and SSO), then scratch cards on top of it, then advertisement placements, then headless coupons if you run your own store.

Capability matrix​

What is available on which surface today.

ModuleHeadless APIAndroidiOSFlutterReact NativeJS / WebHosted
Scratch CardsAvailableAvailableAvailableTBDTBDBetaAvailable
AdvertisementBetaAvailableAvailableTBDTBDTBD—
Marketplace—AvailableAvailableTBDTBD—Available
Coupons & DealsAvailablevia SDKvia SDKTBDTBDTBDAvailable
Refer & EarnAvailableAvailableAvailableTBDTBDTBDAvailable
Deep payment—AvailableAvailableTBDTBD—Available

Reading the marks:

  • Available Documented, with a confirmed contract.
  • Beta Works, but some part of the contract is still settling — the web widget is currently distributed from a UAT host, and standalone ad APIs are not yet packaged as a self-service product.
  • TBD Not available today. Flutter and React Native are roadmap items with no published artifact.
  • Not available Described in older documents but not offered.
  • — Not applicable by design.

Effort summary​

ModelModulesSurfaceRough effort
AAdvertisementSDK or web~1 week
BScratch cardsAny3 days – 2 weeks
CMarketplaceSDK or hosted1–3 weeks
EMarketplace + scratch cardsSDK3–4 weeks
FMarketplace + adsSDK3–4 weeks
GCoupons & dealsHeadless~2 weeks + storefront
HFull platformMixedPhased, 6–10 weeks

Every model shares the same prerequisite: onboarding — key exchange, IP whitelisting and channel issuance. Start that early; it is usually the long pole.

Next​