Overview

Welcome to the Developer Documentation! Our APIs empower you to build robust financial, eCommerce, and business management solutions for Africa and beyond.

• Purpose: Enable seamless payments, collections, and financial automation.
• Target Audience: Fintech developers, eCommerce platforms, business system integrators, and internal teams.

---

High-Level Architecture

APIs are RESTful and stateless. Your application communicates securely with our platform over HTTPS, using Bearer Token authentication. All data is exchanged in JSON format.

• 🔑 Authentication: Obtain a Bearer Token using your API credentials.
• 🔗 API Calls: Use endpoints to initiate payments, check statuses, and more.
• 🔄 Responses: Receive structured JSON responses for all operations.

---

Quickstart Checklist

1. Sign Up: Register on our business portal to get your API keys.
2. Read the Authentication Guide: Learn how to obtain and use your Bearer Token.
3. Test Endpoints: Use Postman, Curl, or your favorite language to try out the APIs.
4. Integrate: Build your integration and go live!

---

API Design & Standards

• RESTful Design: Standard HTTP methods:
  • GET – Retrieve data
  • POST – Create new data
  • PUT/PATCH – Update data
  • DELETE – Remove data
• Data Format: All requests and responses use application/json.
• Authentication: All endpoints require a Bearer Token in the Authorization header.
• Error Handling: Standard HTTP status codes and clear error messages are returned for all errors.

---

Versioning

Current API version: v2. All endpoints are prefixed with /api/v2/. For changes and migration notes, see the changelog.

---

Rate Limiting

Default: 1500 requests per minute. Exceeding this returns HTTP 429 with a Retry-After header.

---

Changelog

Stay up to date with new features, bug fixes, and breaking changes in our changelog.

---

What You’ll Find Here

• ✅ Account Services API – Manage account information, balances, and statements.
• ✅ Receive Money API – Accept payments from customers via mobile money.
• ✅ Send Money/BULK Payment API – Disburse payments to customers, employees, and vendors in bulk or individually.

---

Terms of Use & Legal

By using this API, you agree to our Terms of Service and Privacy Policy. Do not share sensitive data or credentials.