Get started

Sections

Get started
Welcome
Overview
- Platform overview
- How Spendstream works
- Choose your integration model
- Product configuration
Quickstart
- API quickstart
- Authentication guide
- Environments
Choose your path
White-label
- White-label integration
- White-label single sign-on guide
- Testing payments on staging
Full API
- Full API integration
- Users guide
- Brands guide
- Categories guide
- Promotions guide
Gift cards and payments
- Gift card product guide
- Gift cards resource guide
- Payments guide
- Hosted payment model
- Balances guide
- Prepaid balance management
- Gift card testing
Cashback and affiliates
- Affiliate offers and cashback
- Cashback guide
- Transactions guide
- Rewards and commission
- Gift cards and affiliates together
- Affiliate testing
Build and go live
Webhook guides
- Webhooks overview
- USER_UPDATED
- TRANSACTION_UPDATED
- Webhook security
- Webhook processing best practices
- Webhook testing
Go live
- Staging testing
- Production readiness
- Go-live checklist
- Reconciliation
Security and support
- Credential security
- Data handling
- Fraud and duplicate prevention
- Support responsibilities
Reference
- Glossary
- Status meanings
- Common implementation mistakes
- FAQ
- Changelog
API reference
Authentication
- POST
  Exchange API credentials for a bearer token valid for 10 hours.
Users
- GET
  List users registered against the calling publisher.
- POST
  Register a new end-user against the calling publisher.
- POST
  Update attributes on an existing user record.
- POST
  Record a user activity log entry against a token.
- POST
  Set a user's email-reminder opt-in preference.
Brands
- GET
  List the brand catalogue available to the calling publisher.
Categories
- GET
  List brand categories.
Promotions
- GET
  List active promotions (flat, minimal) — deprecated.
- GET
  List active promotions with embedded brand detail.
Gift Cards
- POST
  Process a gift card fulfilment from a pre-existing order in the publisher's database.
- POST
  Issue a gift card directly via the API (self-contained request).
- POST
  Check the remaining balance on an issued gift card.
Payments
- POST
  Generate a hosted payment gateway URL for a gift card purchase.
Balances
- GET
  Check the calling publisher's prepaid float balance.
Cashback
- GET
  List active affiliate commission offers (primary variant).
Transactions
- GET
  List transactions attributable to the calling publisher's users.
- GET
  Get a user's aggregated transaction summary.
- POST
  Flag an affiliate transaction as paid to the end-user.
Webhooks
- POST
  USER_UPDATED webhook
- POST
  TRANSACTION_UPDATED webhook

Overview

What Spendstream is, how it works, and how to choose an integration model.

Sections

Overview

On this page