Docs

GiftingStack documentation

Everything you need to add gifting to your app: a quickstart, one page for each part of the API, and a checklist for going live.

Start here

QuickstartCreate a project, credit a user and send your first gift in the test environment. API or SDK?What your server does, what your app does, and how they fit together. Integration patternsThree ways to show gifts in your app.

The API, piece by piece

AuthenticationSecret keys, client tokens, live and test, headers and 401s. Client tokensMint, use from a browser, refresh and revoke the app-safe credential. ErrorsThe error shape and every error type, with status and what to do. IdempotencyIdempotency-Key and reference: retry safely, never twice. Paginationlimit, starting_after, has_more and next_cursor, filtered pages and date ranges. Rate limitsLimits per plan, the 429 response, backoff and the test caps. How your fee is measuredVerified store sales, web sales, bonus coins and refunds. WebhooksEvents and payloads, signature check, retries, ordering and catch-up. Receipt validationApp Store and Google Play purchase checks, required on live for store sales.

Apps and live gifts

SDKsWeb, React Native, Flutter, Android and iOS: status and what they cover. Customize the SDKTheme, tray placement, texts, motion, effect tiers and render slots, per platform. Gift roomsShow gifts live to everyone watching, with battles. BenchmarksOne room with 250,000 viewers, 200 gifts a second: results and method. Leaderboards, away and inboxRankings, the while-you-were-away summary and the 24-hour gift inbox.

Running it

Go liveA checklist for moving from test to live. Users and privacyUser, project and account deletion, and what cannot be purged. VersioningThe /v1 compatibility and deprecation policy.

Reference and help

API referenceEvery endpoint, generated from the OpenAPI document. OpenAPI JSONImport it into Postman, Insomnia or a code generator. No key needed. Supportsupport@giftingstack.com. Also the contact for service status and security reports.

What GiftingStack is not

There is no real money in GiftingStack: no payments from your users, no payouts, no cash-out and no transfers between users. Coins are balances you credit after your own store takes the money. Receivers of a gift get a counter, never spendable coins. There is no video, audio or chat either: gift rooms carry gift events only.

Questions or something unclear? support@giftingstack.com.