Query Transaction Details
Test URL
GEThttps://uat.finserve.africa/v3-apis/transaction-api/v3.0/transactions/details/{{ref}}
Live URL
GEThttps://api.finserve.africa/v3-apis/transaction-api/v3.0/transactions/details/{{ref}}
This webservice enables an application or service to query a transactions details and status
Example Request
⚠️
In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.
Signature Formula e.g. randomstringhere
ref
Example Request
curl -X GET \
-H 'Authorization: Bearer {{token}}' \
-H 'Signature: ref' \
-L 'https://uat.finserve.africa/v3-apis//transaction-api/v3.0/transactions/details/10120120098767'
Example Successful Response
Example Successful Transaction Response for Bill Payment
{
"status": true,
"code": 0,
"message": "success",
"data": {
"state": "Success",
"stateCode": 2,
"dateCreated": "2024-10-04 08:47:41.767",
"code": 0,
"message": "Success",
"amount": 107,
"charge": 30,
"transactionReference": "6225966760537",
"serviceName": "Bill Payment",
"biller": "888880"
}
}
Example Failed Responses
Failed Transaction Response for Bill Payment
{
"status": true,
"code": 0,
"message": "success",
"data": {
"state": "Failed",
"stateCode": 1,
"dateCreated": "2024-09-30 12:50:52.377",
"code": 400105,
"message": "Transaction failed with unknown status, please contact Finserve support@finserve.africa attaching transaction reference to get the final status",
"amount": 110,
"charge": 30,
"transactionReference": "202409300813",
"serviceName": "Bill Payment",
"biller": ""
}
}
Failed Transaction Response for PESALINK_MOBILE_IMT
{
"status": true,
"code": 0,
"message": "success",
"data": {
"state": "Failed",
"stateCode": 1,
"dateCreated": "2024-10-03 16:48:16.27",
"code": 400105,
"message": "Transaction failed with unknown status, please contact [Finserve Support](mailto:support@finserve.africa) attaching transaction reference to get the final status",
"amount": 110,
"charge": 50,
"transactionReference": "202403090801",
"serviceName": "PESALINK_MOBILE_IMT",
"biller": ""
}
}
In both successful and failed cases, the API request itself is successful. This is indicated by the "status": true
and "message": "success"
fields, meaning the API communication was processed correctly.
The key difference lies in the transaction status:
- Successful Transaction:
"state": "Success"
and"stateCode": 2
indicate the transaction was completed successfully. - Failed Transaction:
"state": "Failed"
and"stateCode": 1
indicate the transaction processing failed, despite the API call succeeding.
Status Codes for Responses
Code | Description |
---|---|
0 | Indicates a successful API call. |
400105 | Indicates a failed transaction with an unknown status. Users should contactFinserve Support with the transaction reference for further assistance. |
State Codes
State Code | Description |
---|---|
2 | Successful transaction. |
1 | Failed transaction. |
-1 | Awaiting callback response. |