The Simulate Bank Transfer endpoint is used to simulate a bank transfer transaction. It allows developers to test the bank transfer functionality during the development phase of integrating the Payment Gateway. Developers are required to select the bank transfer method at the payment checkout stage before making the request to this endpoint.
Request
METHOD: POST
Endpoint: https://api.hydrogenpay.com/bepay/api/v1/Payment/simulate-bank-transfer
Request Parameters
In the table below, the required parameters for the request body are listed:
| Parameter | Type | Description |
|---|---|---|
| clientTransactionRef | String | A unique reference for the client’s transaction. |
| currency | String | The currency in which the transaction is being made. |
| amount | String | The amount to be transferred. |
Headers
| Header | Value |
|---|---|
| Mode | 19289182 |
Sample Request
{
"clientTransactionRef": "30002699_842650ef22",
"currency": "NGN",
"amount": "71000"
}
Response Parameters
| Field | Type | Description |
|---|---|---|
| statusCode | String | The status code of the operation. |
| message | String | A message describing the result of the operation. |
| data | Object | An object containing details of the transaction. |
| orderId | String | The unique order identifier. |
| merchantRef | String | The merchant reference number. |
| transactionId | String | The unique identifier for the transaction. |
| amount | String | The transaction amount. |
| customerEmail | String | The email address of the customer. |
| description | String | Description of the transaction. |
| callBackUrl | String | Callback URL for the transaction, if any. |
| otpOrBankTransferTimeoutLeft | Integer | Timeout left for OTP or bank transfer. |
| isRecurring | Boolean | Indicates if the transaction is recurring. |
| totalAmount | String | Total amount of the transaction. |
| discountAmount | String | Discount amount applied to the transaction. |
| paymentId | String | Payment identifier. |
| currency | String | Currency of the transaction. |
| discountPercentage | Integer | Discount percentage applied. |
| isCardSpecificDiscount | Boolean | Indicates if a card-specific discount is applied. |
| isBankDiscountEnabled | Boolean | Indicates if a bank discount is enabled. |
| vatFee | String | VAT fee applied to the transaction. |
| vatPercentage | Integer | VAT percentage applied to the transaction. |
Sample Response
{
"statusCode": "90000",
"message": "Operation Successful",
"data": {
"orderId": "30002699_842650ef22",
"merchantRef": "30002699",
"transactionId": "71680000-744b-e63a-3013-08dc911b3bff",
"amount": "71,000.00",
"customerEmail": "[email protected]",
"description": "test desc",
"isRecurring": false,
"totalAmount": null,
"discountAmount": null,
"paymentId": "success-success-success-HYDR171888257983564894",
"currency": "NGN",
"discountPercentage": 0,
"isCardSpecificDiscount": false,
"isBankDiscountEnabled": false,
"vatFee": null,
"vatPercentage": 0
}
}
Notes:
- The Mode header is required and must be set to 19289182.
- This endpoint is intended for testing purposes only during the development phase.
- The response provides essential information about the simulated bank transfer, including transaction details, status, and any applicable fees or discounts.