API Documentation
The RewardOS B2B API lets your server discover tenant-priced offers, inspect wallet funds, create idempotent purchases, and use hosted streak embeds. It uses a tenant-scoped API key and must only be called from your backend.
Integration journey
Section titled “Integration journey”- Configure environments — use isolated staging and production keys.
- Authenticate — verify the key and tenant binding.
- Read catalog offers — show only offers priced for your tenant.
- Read wallet — confirm available funds.
- Create purchases — use durable idempotency keys and retrieve status.
- Add streak embeds — mint WebView or iframe URLs from your server.
Core endpoints
Section titled “Core endpoints”| Method | Path | Purpose |
|---|---|---|
GET |
/b2b/whoami |
Verify API-key tenant binding |
GET |
/b2b/catalog/offers |
List purchasable tenant offers |
GET |
/b2b/wallet/balance |
Read available wallet funds |
GET |
/b2b/wallet/ledger |
Read immutable ledger entries |
POST |
/b2b/purchases |
Create an idempotent purchase |
GET |
/b2b/purchases/{orderId} |
Retrieve purchase status |
POST |
/b2b/embeds/streak |
Mint a 60-minute hosted streak URL |
See error handling and versions for compatibility guidance.