Loading...
Checks the current status of a payment initiated via a virtual account using its unique external reference. This endpoint provides real-time updates on payment status including success, pending, or expired states. Required Fields: externalReference: The unique identifier for the payment request
KEY | VALUE | DESCRIPTION |
---|---|---|
X-API-Key | X-API-Key | - |
X-API-Secret | X-API-Secret | - |
// Using fetch API
const response = await fetch("http://localhost:5000/api/v1/developer/payments/check-payment-status", {
method: "POST",
headers: {
"X-API-Key": "X-API-Key",
"X-API-Secret": "X-API-Secret"
},
body: JSON.stringify({
"externalReference": null
})
});
const data = await response.json();
console.log(data);
Parameter | Type | Required | Description |
---|---|---|---|
externalReference | No |
{
"externalReference": null
}
Success response
{
"statusCode": 200
"message": "Payment successful"
"data" {
"amount": 5000
"accountNumber": "9876543210"
"accountName": "Jane Smith"
"bank": "First Bank"
"transactionTime": "2024-03-18T14:30:45.000Z"
"paymentReference": "PAY987654321"
"narration": "Payment for services"
"status": "success"
"senderDetails" {
"accountNumber": "9876543210"
"accountName": "Jane Smith"
"bank": "First Bank"
}
}
}