Payment Confirmation is a functionality within the payment gateway integration that enables businesses to verify the status of initiated payments. This process utilizes the transaction reference to retrieve the specified payment's current status (e.g., success, failed, pending).
Businesses can seamlessly confirm the payment outcome through the payment gateway by using the transaction reference, enhancing transparency and facilitating efficient payment tracking.
METHOD: POST
✅ Mandatory Type Name Comment Yes String transactionRef Transaction Ref that is returned on No String transactionId The unique ID assigned to the transaction across systems.
Field Type Value statusCode String 400 success Boolean false message String Validation Failed error Object List of validation errors
Field Type Value statusCode Integer 10001 message String No record found data Object null
Field Type Value statusCode Integer 90000 message String Operation Successful data Object Details of the transaction
Field Type Description statusCode String Status code of the API call, indicating success message String Message indicating the result of the API call data Object Contains details of the transaction id String Unique identifier for the transaction amount Decimal Total amount of the transaction chargedAmount Decimal Amount charged for the transaction currency String Currency of the transaction customerEmail String Email of the customer. narration String Additional notes or narration (if any) status String Current status of the transaction. Possible values are: Pending, Failed, and Paid. transactionRef String Reference code for the transaction, useful for tracking and identification. processorResponse String Response from the payment processor. createdAt DateTime The timestamp when the transaction was created. paidAt DateTime The timestamp when the transaction was done. ip String The IP address from which the transaction was initiated. paymentType String The method of payment used for the transaction (e.g., Card or BankTransfer). authorizationObject Obect Contains details related to the authorization of the transaction. fees Decimal Fees associated with the transaction
JSON
{
"transactionRef": "503002801229_6669939140",
"transacionId": "a7450000-9356-eead-9167-08dcbe986d82"
}JSON
{
"statusCode": "90000",
"message": "Operation Successful",
"data": {
"id": "a7450000-9356-eead-9167-08dcbe986d82",
"amount": 70.00,
"chargedAmount": 70.00,
"currency": "NGN",
"customerEmail": "[email protected] ",
"narration": "Demo test",
"description": "Demo test",
"status": "Paid",
"transactionStatus": "Paid",
"transactionRef": "30002699_152427cc15",
"processorResponse": null,
"createdAt": "2024-08-17T08:41:46.1347675",
"paidAt": "2024-08-17T08:41:46.1347675",
"ip": "102.88.83.108",
"paymentType": "Card",
"authorizationObject": null,
"fees": 0.00,
"vat": 0.00,
"meta": "Test Modes",
"recurringCardToken": "",
"metadata": null
}
}