Developer Documentation
API sita, kila moja na ukurasa wake: pokea malipo, tuma pesa, angalia hali, salio, namba na webhooks.
Speedpesa Payments API
Kusanya na tuma malipo ya mobile money — M-Pesa, Mixx By Yas, Airtel Money na Halopesa — kwa API moja yenye REST endpoints rahisi.
Mahitaji (Prerequisites)
- API Key — nenda Dashboard → Settings → Developer kisha bonyeza Generate API Key.
- Webhook URL — sajili URL yako ili upokee taarifa pale hali ya malipo inapobadilika.
Inavyofanya kazi
- Hatua 1 — Preview — Thibitisha namba, kiasi na reference kabla ya kutuma push.
- Hatua 2 — USSD-PUSH — Tuma ombi; mteja anaingiza PIN ya wallet yake kwenye simu.
- Hatua 3 — Status / Webhook — Angalia hali kwa transaction_id, au subiri webhook yako.
Authentication
Kila ombi linahitaji API key yako kwenye headers.
Required Headers
Authorization
Bearer sk_live_XXXXXXXXXXXX
Content-Type
application/json
Base URL
Njia zote za endpoint zinaongezwa mwishoni mwa base URL.
APIs Zote
Bonyeza kundi lolote kufungua maelezo kamili, request body na mifano ya code.
Collection API
USSD PUSH · POSTPokea malipo kutoka mobile money kwa USSD-PUSH. Unatuma ombi (POST) kwa mteja; simu yake inapata USSD push ya kuweka PIN.
Fungua maelezoDisbursement API
PAYOUT · POSTTuma pesa kwa wateja, mawakala au wauzaji. Unatuma ombi (POST) la kutoa pesa; pesa huenda moja kwa moja kwenye simu ya mpokeaji.
Fungua maelezoTransaction Status API
STATUS · GETAngalia hali ya muamala wowote papo hapo. Unauliza tu (GET) hali ya muamala: pending, success au failed.
Fungua maelezoBalance Check API
BALANCE · GETAngalia salio lako la Speedpesa muda halisi. Unauliza tu (GET) salio lako — haitumi pesa yoyote.
Fungua maelezoMobile Number Lookup API
LOOKUP · POSTThibitisha namba na mtoa huduma kabla ya muamala. Unauliza (POST) namba ya simu ni ya mtandao gani kabla ya kutuma pesa.
Fungua maelezoWebhook API
WEBHOOK · POST kwakoPokea taarifa za matukio moja kwa moja kwenye server yako. Speedpesa inatuma POST kwenye server yako kila hali ya muamala inabadilika.
Fungua maelezoJaribu Muunganisho
Ping — Jaribu API Key
Tumia endpoint hii kuthibitisha kuwa API key yako inafanya kazi kabla ya kuanza kutuma malipo halisi.
curl -X GET 'https://speedpesa.com/api/public/v1/ping' \
-H 'Authorization: Bearer sk_live_XXXXXXXXXXXX'Error Codes
Makosa yote hurudishwa kwa muundo mmoja: success, message.
| Code | HTTP | Maana | Suluhisho |
|---|---|---|---|
| STB-1001 | 401 | API key si sahihi au imefutwa | Tengeneza key mpya kwenye Dashboard → Settings → Developer. |
| STB-1010 | 422 | Data ya ombi haijakamilika | Angalia ujumbe wa message kwenye jibu na rekebisha sehemu iliyotajwa. |
| STB-1042 | 400 | Namba ya simu haitambuliki | Tumia muundo 07XXXXXXXX au 2557XXXXXXXX. |
| STB-1055 | 409 | Order reference imeshatumika | Tumia reference ya kipekee kwa kila muamala. |
| STB-2044 | 404 | Muamala haupatikani | Thibitisha transaction_id au reference uliyotuma. |
| STB-3001 | 429 | Umezidi kiwango cha maombi | Punguza kasi ya maombi; upeo ni maombi 120 kwa dakika. |
| STB-5000 | 500 | Hitilafu ya ndani ya mfumo | Jaribu tena baada ya sekunde chache; kama itaendelea wasiliana na support. |
Support & Resources
Timu yetu inasaidia muunganiko, utatuzi wa hitilafu na usimamizi wa akaunti.
| Njia | Mawasiliano | Muda wa Majibu |
|---|---|---|
| Barua pepe | support@speedpesa.com | Saa 24 |
| Simu / WhatsApp | +255 700 000 000 | 08:00 – 20:00 EAT |
© 2026 Speedpesa API Documentation. Haki zote zimehifadhiwa.