Introducing the ChargeWise API/DEV Portal
ChargeWise's Public Loyalty API lets any operator embed ChargeWise into their custom-made native/web mobile application.
We've built a public, owner-authenticated REST API (/v1 ) that exposes the whole loyalty engine - provision members, report earn events, read balances/tiers/streaks, redeem rewards - plus:
- API keys(
cw_live_/cw_test_) with SHA-256 hashing and constant-time verification. - Outbound webhooks with HMAC-signed delivery, retries, and dead-lettering.
- A self-serve Developer Portal in the admin app (Scalar docs, key management, usage stats).
- ACI-guarded OpenAPI contract(our first GitHub Actions workflow) so the public API can never silently drift.
- A dedicated tenant-isolation test suite proving one operator can never see another's data - even the same end-user ID under two operators resolves to two separate members.
Here's how to access and use the ChargeWise API / Developer Portal:
- Log into your ChargeWise workspace > Navigate to API:
- To create a new API Key, click the + New API Key button > Enter the API Key Name > Create API Key:
⚠️ Please remember that when you create your API key, you'll be able to copy it in fully only once. You'll be prompted to do that step as soon as you generate the new key.
- To rotate an API Key's secret, navigate to the bottom of the page to access the API Keys. Right next to every API key, there are rotate and revoke icons. Click Rotate:
Once you do that, a new API key will be generated and the old one revoked:
- To access the ChargeWise Developer Portal, click the Developer Portal button in the top right corner of the screen.
- When you access the ChargeWise Developer Portal, you'll see both the API Guide and the API Reference Documentation: