Version: 1.0.0
The MPESA gateway is organized around REST. The API utilizes resource-oriented URLs, and uses HTTP response codes to indicate API errors. JSON is consumed and returned by all API responses, including errors. All requests should be sent to mpesagw.pestoe.com.
| Operation | Description |
|---|---|
| POST /v1/stk/request | Request MPESA Payment |
| Operation | Description |
|---|---|
| POST /v1/stk/status | Request MPESA Payment status |
HTTP Basic Authentication using API ID and KEY
This endpoint requests payment
Uses default content-types: application/json
Payee, MPESA details
Uses default content-types: application/json
Payment status
Unexpected error
| basicAuth |
This endpoint requests payment the status of a previously submitted request
Uses default content-types: application/json
3rd party reference id or gateway transaction id
Uses default content-types: application/json
Payment status
Unexpected error
| basicAuth |
the status of the request success is the default where ok
the status code of the request 0 is successful.
a unique transaction reference generated by the gateway
the original reference provided in the original
MPESA transaction reference, only present for a successful transaction
MPESA phone number in the format 07XXXXXXXXX.
The amount payable
A unique transaction reference number
A transaction reference number for display (Service PIN Only) and is used as transaction description for STK
A paybill number to use for transaction
a callback url to call when payment completed, will contain paymentConfirmed in query. With 5 as confirmed.