Getting Started
Core Concepts
Glossary of every term used in the docs.
| Term | What it means |
|---|---|
| Developer | You. The person who registered on SettleSettle and is building with it. |
| App | A project you register inside SettleSettle. Each app gets its own API key, users, and balance. If you're building two products, make two apps. |
| End User / User | The person using YOUR app. Not a SettleSettle account. Just an ID you pass — a UUID, email, whatever your system uses. |
| API Key | A secret key identifying your app. Format: ss_live_xxxxxxxxxx. Server-side only — never in browser or mobile code. |
| Usage Event | A signal sent when a user does something billable. You define the names. SettleSettle counts them. |
| Event Type | The name of a specific action. Use SCREAMING_SNAKE_CASE: AI_QUERY, API_CALL, PDF_EXPORT. |
| Wallet | A virtual credit balance attached to a user inside your app. Phase 1: credits. Phase 2: real Naira. |
| Credits | The unit of value in your app's wallet. You define what one credit costs. |
| Kobo | The smallest unit of Nigerian Naira. ₦1 = 100 kobo. All money amounts in the SDK are passed in kobo. |
| Platform Fee | The percentage SettleSettle takes per transaction. Default: 3.5%. Shown clearly before you go live. |
| Payout | When SettleSettle sends your earned money to your Nigerian bank account. |
| Webhook | A POST request SettleSettle sends to your server when something happens — payment confirmed, payout sent, etc. |