Retrieve USSD Transaction Status

GET /payments/ussd/status-query/{referenceId}

Description

Retrieve the status of a USSD transaction based on a unique reference ID. This endpoint allows you to query and obtain the current status of a USSD transaction initiated with a specific reference ID.

Required Headers

	Type	Description
apiKey	string	(Required). Wallet API key for authentication. Include in the request header.
Authorization	string	(Required). Authentication token. Include in the request header using the "Bearer" scheme. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2Nm...

Path Parameter

Name	Type	Description
referenceId*	string	(Required) Unique reference ID of the USSD transaction for which the status is queried.

HTTP Status Code: 200 OK

Represents a successful response with a JSON structure providing status information and optional data or error details.

Response Fields

Field	Type	Description
status	boolean	Overall success or failure indicator (true for success, false for failure).
statusCode	integer	Numeric code representing the status of the response (0 for success).
message	string	Brief message providing additional context about the response.
data	object	Empty or contains relevant data depending on the operation.
errors	array	Array of error objects, each with a short and descriptive message.

Example

<ApiResponse>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data/>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</ApiResponse>

Method: GET

>http://20.87.230.105/platform/wallets/payments/ussd/status-query/transaction_123

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string