Get Payment/Request Status

Retrieves the status and details of a specific consumer request by request ID.

Transaction Status Query API

Query the status of a transaction by request ID

This API provides detailed information on the status, results, and metadata of a previously submitted transaction request.

URL Path Parameters

ParameterDescriptionTypeMandatory
organizationIdUnique identifier for the organizationStringYes
consumerIdUnique identifier for the consumerStringYes
requestIdUnique identifier for the transaction requestStringYes

Response Body Parameters

ParameterDescriptionType
trackingIdUnique identifier for tracking this specific API transactionString
transactionIdExternal or provider-assigned transaction IDString
referenceUnique identifier for the original transaction requestString
statusStatus code indicating transaction state (e.g., S000000 = success)String
messageHuman-readable message describing transaction statusString
errorError details if any, empty string if noneString
typeType of transaction, e.g., PayoutString
datetimeCreatedISO 8601 timestamp when the transaction was createdString
lastUpdatedISO 8601 timestamp of the last update on this transactionString
datetimeCompletedISO 8601 timestamp when transaction completed (if done)String
resultObject containing transaction result detailsObject
requestOriginal request details sent with the transactionObject
ipnIPN (Instant Payment Notification) callback URLObject
resultsAdditional results object, nullableNullable

Example Response

{
  "trackingId": "01991a17-7328-740a-9b30-1b383a88e985",
  "transactionId": "DRU4S2VE5ZB",
  "reference": "eeadb2fd-ae58-41c4-9b34-4ff514a01613",
  "status": "S000000",
  "message": "Test payment successful, however, no e-value will be disbursed.",
  "error": "",
  "type": "Payout",
  "datetimeCreated": "2025-09-05T13:36:08.488Z",
  "lastUpdated": "2025-09-05T13:36:08.488Z",
  "datetimeCompleted": "2025-09-05T13:36:08.488Z",
  "result": {
    "accountNumber": "254793875319",
    "amount": "1.00",
    "customerFee": "0.00",
    "ref": "fv9n_TDX",
    "storeFee": ""
  },
  "request": {
    "accountNumber": "254793875319",
    "amount": "1",
    "commandId": "ConsumerMobileMoneyWithdrawal",
    "mobileNumber": "254793875319",
    "narration": "Payment"
  },
  "ipn": {
    "url": "https://tanda-tills-ipn.free.beeceptor.com"
  },
  "results": null
}
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!