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 current status (e.g., success, failed, pending) of the specified payment.
By using the transaction reference, businesses can seamlessly confirm the outcome of payments processed through the payment gateway, enhancing transparency and facilitating efficient payment tracking.
Endpoint: merchant/initiate-payment
Content-Type: application/json
Request
METHOD: POST
Test URL: https://qa-api.hydrogenpay.com/bepayment/api/v1/Merchant/confirm-payment
Live URL: https://api.hydrogenpay.com/bepay/api/v1/Merchant/confirm-payment
Request parameters
| Mandatory | Type | Name | Comment |
|---|---|---|---|
| Yes | String | transactionRef | Transaction Ref that is returned on callback |
Missing Field Response
| Field | Type | Value |
|---|---|---|
| statusCode | String | 400 |
| success | Boolean | false |
| message | String | Validation Failed |
| error | Object | List of validation errors |
Invalid Transaction ID
| Field | Type | Value |
|---|---|---|
| statusCode | Integer | 10001 |
| message | String | No record found |
| data | Object | null |
Success Field Response
| Field | Type | Value |
|---|---|---|
| statusCode | Integer | 90000 |
| message | String | Operation Successful |
| data | Object | Details of the transaction |
Success Response
| 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 |
Sample Request
{
"transactionRef": "503002801229_6669939140"
}
Sample Response
{
"statusCode": "90000",
"message": "Operation Successful",
"data": {
"id": "54b00000-35a7-6e3b-0119-08db9e496fe9",
"amount": 100.00,
"chargedAmount": 100.00,
"currency": "NGN",
"customerEmail": "[email protected]",
"narration": null,
"status": "Pending",
"transactionRef": "503002801229_6669939140",
"processorResponse": null,
"createdAt": "2023-08-16T11:10:45.0399497",
"paidAt": "2023-08-16T11:10:45.0399498",
"ip": null,
"paymentType": "BankTransfer",
"authorizationObject": null,
"fees": 0
}
}