Transaction Query API Integration Documentation

Welcome to the Transaction Query API Integration Documentation page. This guide will help you integrate our Transaction Query API and see details of transactions you have performed via API or directly on our platform.

cURL Init Sample

Successful Transaction Query API Response Example

This is an example of the response returned for a successful Transaction Query.

Explanation of Response Fields

In a successful Transaction Query, the main response contains status, Status, and message. The detailed transaction information is returned inside the data object.

• status: Indicates whether the transaction query was processed successfully (true for success).
• Status: Indicates whether the transaction query details was completely gotten (e.g., completed).
• message: Provides context about the query result (e.g., confirmation that the transaction was retrieved).

Fields inside data:

• transaction_id: The unique identifier assigned to the transaction, this is the same as the request-id you sent when the transaction was initially purchased.
• transaction_name: The category or label of the transaction (e.g., DATA).
• transaction_type: Specifies the type of transaction performed (e.g., DataShare3).
• size: The size or package of the data, cable tv, electricity, datacard, exam pin purchased (e.g., 2GB Datashare).
• number: The recipient’s phone number, cable tv, electricity number for the transaction.
• network: The mobile network, cable tv, electricity, datacard, rechargecard provider associated with the transaction (e.g., DSTV).
• amount: The monetary value of the transaction.
• usercommission: The commission earned by the user for the transaction.
• status: The current status of the transaction (e.g., successful or success or processing or pending or failed or fail ).
• api_response: The raw response message returned by the network provider.
• description: A human-readable summary of the transaction.
• date: The timestamp when the transaction was completed.

Failed Transaction Query API Response Example

This example illustrates the exact response returned when a request ID is not found in our database.

Failed Transaction Query API Response Example

This example shows the response returned for a failed Transaction Query, which may occur due to factors such as using a non-GET request method, an invalid API key for the transaction query, or similar issues.

GET Parameters Defined and Interpreted

request-id: This is the unique identifier of the transaction you want to query. It represents the request-id you included in the purchase request to Vtunaija when you wanted to purchase that specific transaction via API. This parameter is required and must be included in the URL as a query string (e.g., ?request-id=4904949180089). Remember to replace "4904949180089" with the actual Request-ID that you sent in the purchase request of the specific transaction you wish to query.

Authorization Header: You must include your API key in the request header as Authorization: Token YOUR_API_KEY. Without a valid API key, the request will fail with a 401 Unauthorized response.

Content-Type Header: Always set Content-Type: application/json in your request headers.

Integration Notes

• Use HTTPS for all requests to ensure security.
• Only request-id is required as a GET parameter. All other transaction details are returned in the response JSON.