The Simulate Bank Transfer endpoint is used to simulate a bank transfer transaction. This is useful for testing the bank transfer functionality during the development phase. Developers must select the bank transfer method on the payment checkout before making the API call to this endpoint.
Request
METHOD: POST
Test URL: https://qa-api.hydrogenpay.com/bepayment/api/v1/Payment/simulate-bank-transfer
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| clientTransactionRef | String | The unique reference for the client's transaction. |
| currency | String | The currency in which the transaction is made. |
| amount | String | The amount to be transferred. |
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. |
| merchantInfo | String | Merchant information, if any. |
| currencyInfo | String | Currency information, if any. |
| canRetry | Boolean | Indicates if the transaction can be retried. |
| timeoutLeft | Integer | Time left for the transaction to complete. |
| 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. |
| billingMessage | String | Billing message, if any. |
| frequency | String | Frequency of the recurring transaction, if any. |
| isRecurringActive | Boolean | Indicates if the recurring transaction is active. |
| serviceFees | String | Service fees applied to the transaction. |
| 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. |
| bankDiscountValue | String | Value of the bank discount, if any. |
| bankDiscountedAmount | String | Amount after bank discount, if any. |
| vatFee | String | VAT fee applied to the transaction. |
| vatPercentage | Integer | VAT percentage applied to the transaction. |
Sample Request
{
"clientTransactionRef": "30002699_842650ef22",
"currency": "NGN",
"amount": "71000"
}
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",
"merchantInfo": null,
"currencyInfo": null,
"canRetry": null,
"timeoutLeft": null,
"callBackUrl": null,
"otpOrBankTransferTimeoutLeft": null,
"isRecurring": false,
"billingMessage": null,
"frequency": null,
"isRecurringActive": null,
"serviceFees": null,
"totalAmount": null,
"discountAmount": null,
"paymentId": "success-success-success-HYDR171888257983564894",
"currency": "NGN",
"discountPercentage": 0,
"isCardSpecificDiscount": false,
"isBankDiscountEnabled": false,
"bankDiscountValue": null,
"bankDiscountedAmount": null,
"vatFee": null,
"vatPercentage": 0
}
}