Inquire Payment Transaction

The merchant can check the status of an already processed transaction using this function.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Name	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v3/mpower/payment/transaction/status

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/mpower/v1/payment/transaction/status

note

API requests must be made over https. Calls made over plain http will fail.

Request body

Field Name	Type	Description
merchantId	String	The ID of the Merchant.
transactionId	String	Unique ID corresponding to the transaction.
merchantCallback	String	Callback URL to notify the Merchant about the status of the transaction. This URL also contains the OrderID generated by the Merchant for correspondence.

Sample Request

{
  "merchantId": "0eb0e0f1-e51b-4a43-9133-93bc2c73b2a0",
  "transactionId": "37d1adfa-f5fc-48f5-87b8-68c12c86e0fc",
  "merchantCallback": "<CallbackURL>"
}

Response

Field Name	Type	Description
transactionId	String	Unique ID corresponding to the transaction.
transactionStatus	String	Status of the transaction.
transactionMessage	String	Briefing on the transaction status.

Sample Response

{
  "transactionId": "37d1adfa-f5fc-48f5-87b8-68c12c86e0fc",
  "transactionStatus": "inquiring status",
  "transactionMessage": "Inquire status in progress"
}