Fetch Transaction Status
This endpoint is used to verify the status of a transaction. If successful, the merchant and customer are notified. A webhook is triggered (if webhookUrl
is provided) to notify the merchant of the transaction status.
Endpoint
POST Payments/VerifyPayment
Headers
Authorization: Bearer
To authorize this API request, you need to include your apiKey
as a bearer token. This is done by setting the Authorization header in your request. The header should have the format:
Authorization: "Bearer your_api_key"
Note: Get your API key from Settings > API Keys in your dashboard.
Request Body Parameters
transactionId
(String): The unique identifier for the transaction.
Request
{
"transactionId": "492uu387927",
}
- Success
- Failed
- Pending
Response - Successful Transaction
{
"responseCode": "00",
"responseMessage": "Transaction retrieved successfully",
"data": {
"amount": "7.00",
"paymentType": "Card",
"currency": "NGN",
"status": "Successful",
"isSuccessful": true,
"gatewayResponse": "Transaction Successful. Approved by Financial Institution",
"transactionId": "ECHY_INI_006",
"productId": null,
"productDescription": null,
"paymentDate": null,
"callBackUrl": null,
"paymentReference": "EDGL7591614131220250722202147",
"recurringID": "",
"histories": null,
"merchantId": 12
}
}
Response - Failed Transaction
{
"responseCode": "00",
"responseMessage": "Transaction retrieved successfully",
"data": {
"amount": "7.00",
"paymentType": "Card",
"currency": "NGN",
"status": "Failed",
"isSuccessful": false,
"gatewayResponse": "Transaction Failed. Error processing request, please try again",
"transactionId": "ECHY_INI_003",
"productId": null,
"productDescription": null,
"paymentDate": null,
"callBackUrl": null,
"paymentReference": "EDGL5081689331220250722201401",
"recurringID": null,
"histories": null,
"merchantId": 12
}
}
Response - Pending Transaction
{
"responseCode": "00",
"responseMessage": "Transaction retrieved successfully",
"data": {
"amount": "7.00",
"paymentType": "Card",
"currency": "NGN",
"status": "Pending",
"isSuccessful": false,
"gatewayResponse": "Transaction Processing. Awaiting Otp/Token",
"transactionId": "ECHY_INI_005",
"productId": null,
"productDescription": null,
"paymentDate": null,
"callBackUrl": null,
"paymentReference": "EDGL1553492241220250722202023",
"recurringID": "",
"histories": null,
"merchantId": 12
}
}