Guides & Tutorials
Jenga API
Receive Money
M-Pesa STK push
Wallet Based Settlement
Query Order Status

Merchant Query Order Status

Test URL

GEThttps://uat.finserve.africa/api-checkout/mpesa-stk-push/v3.0/status/order/{orderReference}

Live URL

GEThttps://api.finserve.africa/api-checkout/mpesa-stk-push/v3.0/status/order/{orderReference}

This web service allows merchants to query the real-time status of orders made through the Mpesa STK (Push) service.It allows an application to retrieve the status of an order.

Example Request

⚠️

In the example below, please replace {orderReference} with the actual order reference number.

Example Request
curl -X GET \
	-H 'Authorization: Bearer {{token}}' \
	-L 'https://uat.finserve.africa/api-checkout/mpesa-stk-push/v3.0/status/order/OR28922980077'
 
200 Success Response Schema
Field NameTypeDescription
statusbooleanIndicates if the request was successful.
codenumberResponse code indicating status.
messagestringDescription of the response status.
data.order.orderAmountdoubleRequest amount.
data.order.amountPaiddoubleAmount paid by customer including service charge
data.order.orderReferencestringOrder Reference .
data.order.orderStatusstringThis is the status of an order. Paid, Pending
data.order.createdOnnumberCreation date of the order in EPOC time
data.invoices[0].amountdoubleInvoice Amount
data.invoices[0].amountDebiteddoubleAmount paid by the customer
data.invoices[0].chargedoubleService charge
data.invoices[0].invoiceStatusstringThis can be Pending, Paid, Cancelled or Expired
data.invoices[0].orderReferencestringOrder Reference
data.invoices[0].externalReferencestringMpesa Reference
data.invoices[0].createdOnstringDate invoice was generated
data.invoices[0].completedOnstringDate Payment was completed

Example Response

Example Sucessful Response
   {
    "status": true,
    "code": "0",
    "message": "Order found",
    "data": {
        "order": {
            "orderAmount": 2.0,
            "amountPaid": 2.0,
            "orderReference": "OR28922980077",
            "orderStatus": "Paid",
            "createdOn": 1723209757300
        },
        "invoices": [
            {
                "amount": 2.0,
                "amountDebited": 2.0,
                "charge": 1.0,
                "invoiceStatus": "Paid",
                "orderReference": "OR28922980077",
                "externalReference": "SH90HU7FO2",
                "createdOn": "2024-08-09 16:22:37.907",
                "completedOn": "2024-08-09 16:22:50.197"
            }
        ]
    }
}
Example Sucessful Response - Pending Order
```json filename="Example Sucessful Response" copy
{
    "status": true,
    "code": "0",
    "message": "Order found",
    "data": {
        "order": {
            "orderAmount": 2.0,
            "amountPaid": 0.0,
            "orderReference": "OR28922980079",
            "orderStatus": "Pending",
            "createdOn": 1723212145140
        },
        "invoices": [
            {
                "amount": 2.0,
                "amountDebited": 2.0,
                "charge": 1.0,
                "invoiceStatus": "Pending",
                "orderReference": "OR28922980079",
                "externalReference": null,
                "createdOn": "2024-08-09 17:02:25.847",
                "completedOn": null
            }
        ]
    }
}