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

MandatoryTypeNameComment
YesStringtransactionRefTransaction Ref that is returned on
callback

Missing Field Response

FieldTypeValue
statusCodeString400
successBooleanfalse
messageStringValidation Failed
errorObjectList of validation errors

Invalid Transaction ID

FieldTypeValue
statusCodeInteger10001
messageStringNo record found
dataObjectnull

Success Response

FieldTypeValue
statusCodeString9000
messageStringOperation Successful
dataObject
amountDecimalAmount
chargedAmountDecimalAmount
customerEmailStringCustomer Email
narrationStringTransaction Narration
statusStringTransaction Status
transactionRefStringTransaction Reference
processorResponseStringProcessor Response
createdAtDateTimeRequest Creation Date
paidAtDateTimeDate Payment was done
ipStringIP Address
paymentTypeStringPayment Type
authorizationObjectObectAuthorization Details

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",
		"clientTransactionRef": "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
	}
}