Central API Reference
For developers building custom wrappers, non-Node backends, or microservices, SettleSettle provides a robust, RESTful REST endpoint grid.
Base Endpoint
All raw REST queries flow securely through our global API gateway:
https://settlesettle-api.onrender.com/v1Required Request Headers
Every request sent to our central edge must supply the following headers to pass request firewalls:
Content-Type: application/json
X-API-Key: ss_live_your_active_application_keyIf you are accessing developer-specific administrative endpoints (such as manual payouts or predictive AI leaderboards), you must instead pass a developer JWT token:
Authorization: Bearer dev_jwt_token_hereKey Central Endpoint Grid
| Method | REST Route | Access Level | Description |
|---|---|---|---|
POST | /payments/initialize | App Key | Creates a dynamic checkout link and records reference nodes. |
GET | /payments/verify/:reference | App Key | Queries gateway networks to audit the completion state of a transaction. |
GET | /wallet/:userId/balance | App Key | Retrieves the active credit wallet parameters and balance of a synced user. |
POST | /wallet/:userId/debit | App Key | Performs an atomic credit withdrawal from a user's wallet ledger. |
GET | /intelligence/apps/:appId/users/top-by-credits | Dev JWT | Returns high-spend customer leaderboards for developer auditing. |
GET | /intelligence/apps/:appId/users/top-by-events | Dev JWT | Returns usage-volume analysis logs representing top user telemetry. |
GET | /intelligence/apps/:appId/users/event-patterns | Dev JWT | Synthesizes all global app events through Gemini to advice on pricing. |
GET | /intelligence/apps/:appId/users/:userId/full-profile | Dev JWT | Fetches detailed unified user logs, wallet transactions, and recurring subscriptions. |
Advanced AI & Telemetry Endpoints (Dev JWT Required)
#### 1. Top Users by Credits (/intelligence/apps/:appId/users/top-by-credits)
Returns a list of power users who have consumed the most financial credits. Useful for mapping high-value client segments.
* Response Payload Shape:
{
"data": [
{
"userId": "user_123",
"totalCreditsConsumed": 250000,
"riskLevel": "healthy"
}
]
}#### 2. Top Users by Events (/intelligence/apps/:appId/users/top-by-events)
Returns usage volume rankings to identify users with the highest telemetry activity (total events tracked, average daily frequency).
#### 3. Global AI Event Patterns (/intelligence/apps/:appId/users/event-patterns)
Leverages Gemini AI to process application telemetry streams and generate:
- advice: Strategic business pricing and packaging recommendations.
- featuresSuggested: Recommended expansion modules.
- bottlenecksFound: Potential friction points in payment flows.
- anomaliesDetected: Security or rate-limiting warnings.
#### 4. Unified Ledger User Profile (/intelligence/apps/:appId/users/:userId/full-profile)
Aggregates all telemetry, wallet micro-debits, active subscriptions, plans, and churn scores for a specific customer into a unified developer-facing record.