Skip to main content
The Stell API gives your systems everything the merchant portal does. Issue and update passes for Apple Wallet and Google Wallet, manage programs and pass templates, record transactions, and read the state of your stores and terminals, all from your CRM, POS, e-commerce platform, or your own backend. Everything is scoped to your company. An API key only ever sees and changes your own company’s data.

​
Base URL

All requests go to:
Every endpoint is versioned under the /v1 path prefix. Every request must be authenticated. See Authentication.

​
How the resources fit together

  • Companies, merchants, and stores. Your company holds one or more merchants (brands). Each merchant has stores, physical or online. Terminals are the Stell tap points attached to those stores.
  • Programs, pass templates, and passes. A program is the loyalty product, membership, or ticket offering you run. Each program has one or more pass templates that define how the pass looks. Passes are issued to customers from those templates.
  • Transactions. The record of a pass used at a terminal, with a status of Approved, Denied, Failed, or Pending.
  • Engagement. Notifications and messages to pass holders. Engage is a gated module; these endpoints only work if Engage is enabled for your company.
The sidebar groups the endpoints the same way, starting where most integrations start: issuing and managing passes.

​
Typical integrations

  • Issue a pass from your own signup flow instead of the enrollment page.
  • Record transactions from your POS so purchases earn loyalty points automatically.
  • Keep customer data in sync by reading passes and transactions into your CRM.
  • Trigger a pass update (points balance, tier, expiry) when something changes in your systems.
For a step-by-step walkthrough of these flows, start with the integration guide. For updates in the other direction, where Stell notifies your systems, use webhooks. Webhooks push events to you; the API is how you read and change state.