Speedpesa API v1

Collection API

Pokea malipo kutoka mobile money kwa USSD-PUSH.

USSD PUSH · POSTUnatuma ombi (POST) kwa mteja; simu yake inapata USSD push ya kuweka PIN.

Home DocumentationReceive Payment

Authentication

Kila ombi linahitaji API key yako kwenye headers.

Required Headers

Authorization

Bearer sk_live_XXXXXXXXXXXX

Content-Type

application/json

Muhtasari

Kusanya malipo kutoka M-Pesa, Mixx By Yas, Airtel Money na Halopesa. Hatua ya kwanza inathibitisha maelezo, hatua ya pili inatuma push kwa mteja.

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 1POST

Hatua 1 — Preview USSD-PUSH Request

Endpoint hii inathibitisha maelezo ya malipo kama namba ya simu, kiasi na order reference, na inakuonyesha njia ya malipo (wallet) inayopatikana kwa namba hiyo kabla hujatuma push.

POST https://speedpesa.com/api/public/v1/collections/preview

Request Body (JSON)

Parameter	Type	Required	Maelezo
phone	string	Yes	Namba ya simu ya mteja (M-Pesa, Mixx By Yas, Airtel Money, Halopesa).mfano: 0712345678
amount	integer	Yes	Kiasi cha kukusanya kwa TZS.mfano: 1000
reference	string	No	Kumbukumbu ya kipekee ya oda kwenye mfumo wako.mfano: ORD-1001

bash

curl -X POST 'https://speedpesa.com/api/public/v1/collections/preview' \
  -H 'Authorization: Bearer sk_live_XXXXXXXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "0712345678",
    "amount": 1000,
    "reference": "ORD-1001"
  }'

Kumbuka: Hatua hii si ya lazima, lakini inakusaidia kuepuka kutuma push kwenye namba isiyo sahihi au reference iliyokwisha tumika.

Hatua 2POST

Hatua 2 — Initiate USSD-PUSH Request

Endpoint hii inatuma ombi la USSD-PUSH kwenye simu ya mteja. Mteja ataombwa kuweka PIN ya wallet yake ili kukamilisha muamala. Jibu linarudi mara moja na hali ya awali ni pending.

POST https://speedpesa.com/api/public/v1/collections/ussd-push

Request Body (JSON)

Parameter	Type	Required	Maelezo
phone	string	Yes	Namba ya simu ya mteja.mfano: 0712345678
amount	integer	Yes	Kiasi cha kukusanya kwa TZS.mfano: 1000
reference	string	No	Kumbukumbu ya kipekee ya oda kwenye mfumo wako.mfano: ORD-1001
name	string	No	Jina la mteja.mfano: Neema Mushi
email	string	No	Barua pepe ya mteja.mfano: neema@mfano.co.tz

bash

curl -X POST 'https://speedpesa.com/api/public/v1/collections/ussd-push' \
  -H 'Authorization: Bearer sk_live_XXXXXXXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "0712345678",
    "amount": 1000,
    "reference": "ORD-1001"
  }'

Kumbuka: Hifadhi transaction_id uliyopewa. Ndiyo utakayotumia kuangalia status na ndiyo itakayotumwa kwenye webhook yako.

Disbursement API