Initiate payment is designed to help businesses initiate one-off payment transactions. This operation gathers essential information, including the amount, currency, and customer details, to create a payment request. Users or customers can utilize this request to generate payment links, facilitating the completion of payments through their preferred methods, including card or bank transfer.

This payment request specifically supports Mastercard, Visa, and Verve cards for transactions in both NGN (Nigerian Naira) and USD (United States Dollar).

Request

METHOD: POST

🚧

Test URL: https://qa-dev.hydrogenpay.com/qa/bepay/api/v1/merchant/initiate-payment

Live URL: https://api.hydrogenpay.com/bepay/api/v1/merchant/initiate-payment

Request parameters

MandatoryTypeNameComment
YesDecimalamountAmount to debit the customer.
YesEmailemailCustomer’s Email Address.
YesStringcustomerNameCustomer's name.
NoStringcurrencyDefault to NGN if not passed, other currencies available are USD and GBP.
NoStringdescriptionPayment Description.
NoStringmetaContains any other information you want to be recorded with the transaction.
NoStringtransactionRefUnique transaction ref for Payment. It will be automatically generated for you if you don't specify.
YesStringcallbackRedirect URL after payment has been completed on the gateway.

Success Response

FieldTypeValue
statusCodeInteger90000
messageStringInitiate Payment Saved Successfully.
transactionRefStringTransaction Client Reference
urlStringDeveloper redirect url

Missing Callback Response

FieldTypeValue
statusCodeString10001
messageStringCallback is Required
dataObjectnull

Invalid Currency Response

FieldTypeDescription
statusCodeString10001
messageStringInvalid Currency
dataObjectnull

Missing Field Response

FieldTypeDescription
statusCodeString400
successBooleanfalse
messageStringValidation Failed
errorObjectList of validation errors

Sample Request

{
  "amount": 50,
  "customerName": "Dev Test",
  "email": "[email protected]",
  "currency": "NGN",
  "description": "test desc",
  "meta": "test meta",
  "callback": "https://hydrogenpay.com",
}

Sample Response

{
    "statusCode": "90000",
    "message": "Initiate payment Saved successfully.",
    "data": {
        "transactionRef": "503021992595_93766192e1",
        "url": "https://qa-gateway.hydrogenpay.com?transactionId=b3736f70-f930-4170-8160-e7a4a4a2d4b8"
    }
}