Complete API reference for the Jokoor platform - SMS messaging, payments, billing, payouts, and webhooks.Base URL: https://api.jokoor.com/v1Version: 1.0.0
Last Updated: 2024-01-15
Overview#
Welcome to the Jokoor API documentation. This comprehensive guide covers all aspects of integrating with the Jokoor platform for SMS messaging, payment processing, invoicing, subscriptions, payouts, and webhooks.
Documentation Structure#
The documentation is organized into focused topic areas:📘 Getting Started#
Essential information for working with the Jokoor API:Authentication - API keys, test vs live mode
Response Format - Standard response structure
Error Handling - Error codes and handling
Pagination - Offset/limit pattern
Quick Start - Get started quickly
Secret keys (sk_*) for server-side operations
Publishable keys (pk_*) for client-side operations
Test vs Live mode restrictions
⚠️ SMS requires live keys only
📱 SMS#
Core SMS messaging and resource management:Sending Messages - Send single or bulk SMS
Templates - Reusable message templates with variables
Contacts - Manage contact lists
Contact Groups - Organize contacts
Sender IDs - Custom sender ID management
Campaigns - Bulk messaging campaigns
Message Segments - Character count and encoding
Resending - Resend failed messages
Schedule messages for future delivery
Template variable substitution
Character count and encoding detection
💳 Payments#
Payment processing with hosted pages and custom integrations:Payment Links - Shareable payment links (hosted pages)
Checkouts - Flexible checkout sessions (hosted OR embedded)
Initialize Payment - Embedded checkout integration
Payment Status - Check payment status
Hosted payment pages (no coding required)
Custom SDK integration (full UI control)
Progressive payment enrichment
Multiple payment methods (Wave, Afrimoney, Card, QMoney)
Redirect URLs for success/failure
Metadata for custom tracking
🧾 Billing#
Invoices, receipts, and recurring subscriptions:Invoices - Create and manage invoices
Invoice Payments - Record offline/manual payments (cash, bank transfers, etc.)
Receipts - Automatic receipt generation
Subscriptions - Recurring billing
Automatic tax calculation
PDF generation and email delivery
Online payments via hosted page
Offline payment recording (cash, bank transfers)
Multiple billing intervals
🛒 Resources#
Supporting resources for payments and billing:Customers - Customer management
Products - Product catalog
Transactions - Transaction history
Refunds - Process refunds
Donations - Fundraising campaigns
💰 Payouts & Webhooks#
Withdraw funds and receive event notifications:Payout Balance - Check available balance
Bank Accounts - List bank accounts (read-only)
Payout Requests - Request withdrawals
Payout Recipients - Manage Wave B2P recipients
Recipient Payouts - Send Wave B2P transfers
Payout Reversals - Reverse completed payouts (48-hour window)
Webhook Endpoints - Configure webhooks
Webhook Events - View and retry events
⚠️ Bank account management requires OTP (web dashboard only)
⚠️ Payout reversals must be within 48 hours
⚠️ Webhook secrets shown only on creation
SDK Installation#
Quick Start Examples#
Send an SMS Message#
Accept a Payment#
Key Features by Use Case#
For SMS Messaging#
✅ Send single or bulk SMS messages
✅ Schedule messages for future delivery
✅ Use templates with variables
✅ Manage contact lists and groups
For Payment Processing#
✅ Multiple payment methods (Wave, Afrimoney, Card, QMoney)
✅ Payment links (shareable URLs)
✅ Checkouts (embedded flows)
✅ Progressive enrichment (collect info step-by-step)
✅ Test mode for development
✅ Webhooks for real-time notifications
For Invoicing & Billing#
✅ Professional PDF invoices
✅ Automatic tax calculation
✅ Partial payment tracking
✅ Automatic receipt generation
✅ Recurring subscriptions
✅ Flexible billing intervals
For Payouts#
✅ Bank account withdrawals
✅ Payout recipient management
✅ 48-hour reversal window
Important Restrictions#
SMS Requirements#
⚠️ SMS only works with live API keys (sk_live_*)
Test keys cannot send SMS messages
All other APIs support both test and live modes
OTP-Protected Operations#
The following operations require OTP verification via the web dashboard and are not accessible via API keys:Creating/updating/deleting bank accounts
Creating payout requests to bank accounts
Setting default bank accounts
Time-Limited Operations#
Payout reversals: 48 hours from completion
Payment refunds: No time limit (subject to provider policies)
Security Requirements#
Webhook endpoints must use HTTPS
Webhook secrets are shown only once during creation
Always verify webhook signatures
Rate Limits#
Generous rate limits designed to support high-traffic production use. All limits are per organization.Payment Operations#
Payment Initialization: 5,000 requests per minute (~83/second)
Checkout Creation: 5,000 requests per minute (~83/second)
Checkout Processing: 5,000 requests per minute (~83/second)
Payment CRUD: 5,000 requests per minute
SMS Operations#
SMS Sending: 1,000 messages per minute (~16/second)
SMS CRUD: 2,000 requests per minute (~33/second) - Contacts, templates, groups, etc.
Campaign Sending: 500 campaigns per minute (~8/second)
Payout Operations#
Payout Requests: 1,000 requests per day
Bank Account Operations: 100 requests per hour
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
X-RateLimit-Reset: 1234567890
Retry-After: 60 (when rate limited)
Support & Resources#
Ready to get started? Explore the documentation sections in Apidog to learn about specific API endpoints and features. Modified at 2025-11-16 23:53:26
