Initiate payment is designed to help businesses initiate one-off payment transactions. This operation gathers essential information to create a payment request, including the amount, currency, and customer details. Users or customers can utilise 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
| Mandatory | Type | Name | Comment |
|---|---|---|---|
| Yes | Decimal | amount | Amount to debit the customer. |
| Yes | Customer’s Email Address. | ||
| Yes | String | customerName | Customer's name. |
| No | String | currency | Default to NGN if not passed, other currencies available are USD and GBP. |
| No | String | description | Payment Description. |
| No | String | meta | Contains any other information you want to be recorded with the transaction. |
| No | String | transactionRef | Unique transaction ref for Payment. It will be automatically generated for you if you don't specify. |
| Yes | String | callback | Redirect URL after payment has been completed on the gateway. |
Success Response
| Field | Type | Value |
|---|---|---|
| statusCode | Integer | 90000 |
| message | String | Initiate Payment Saved Successfully. |
| transactionRef | String | Transaction Client Reference |
| url | String | Payment gateway redirect url |
Missing Callback Response
| Field | Type | Value |
|---|---|---|
| statusCode | String | 10001 |
| message | String | Callback is Required |
| data | Object | null |
Invalid Currency Response
| Field | Type | Description |
|---|---|---|
| statusCode | String | 10001 |
| message | String | Invalid Currency |
| data | Object | null |
Missing Field Response
| Field | Type | Description |
|---|---|---|
| statusCode | String | 400 |
| success | Boolean | false |
| message | String | Validation Failed |
| error | Object | List 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"
}
}