Overview¶
The Hivemind Payments API is a REST API for initiating and managing payments across mobile money, bank, and card rails, and for querying the resulting transaction and wallet state.
What the API does¶
- Initiate payments for three transaction types:
C2B(customer to business / collections),B2C(business to customer / payouts), andB2B(business to business transfers), across five payment methods:mpesa,airtel,tkash,bank, andcard. - Query transaction status by merchant reference.
- Check your merchant wallet balance.
- Pull a transaction statement, with optional filters by date range, reference, and status.
- Notify your system asynchronously via webhook when a transaction reaches a final state.
Base URL¶
All paths in this documentation are relative to this base URL.
Authentication model¶
Every endpoint requires a Bearer access token in the Authorization header, except the token endpoint itself (GET /auth/token/), which uses HTTP Basic Auth with your API client ID and secret. See Authentication for the full flow.
Where to go next¶
- New here? From Signup to Live is the whole path in order — account, sandbox credentials, verification, build, go-live checklist, production.
- First time integrating? Follow the Quickstart to authenticate and run a test transaction end to end.
- Need a specific endpoint's request/response shape? Go to the API Reference.
- Handling asynchronous results? See Webhooks.