The virtual account API allows users to create virtual accounts and get transaction notifications. These virtual accounts can be used to track transactions and accept customer payments.
The API is designed to easily integrate existing systems using standard HTTP requests and responses. The virtual account API provides a powerful and flexible solution for managing virtual accounts and streamlining payment processes for businesses of all sizes. The API takes in the necessary information such as the account label and identification details to create virtual accounts for the merchants. This allows the merchants to receive payments through bank transfer.
Request
METHOD: POST
Test URL: https://qa-dev.hydrogenpay.com/qa/api/v2/vpay/virtual-account
Live URL: https://api.hydrogenpay.com/api/v2/account/virtual-account
Request parameters
| Mandatory | Type | Name | Comment |
|---|---|---|---|
| Yes | String | accountLabel | A custom label to identify the virtual account. This will be part of the account name. |
| No | String | bvn | The Bank Verification Number (BVN) of the account holder. |
| No | String | nin | The National Identification Number (NIN) of the account holder. |
| No | String | phoneNumber | The phone number associated with the account. |
| No | String | The email address associated with the account. |
Ensure to pass at least one of the IDs alongside the accountLabel when creating accounts.
Response Parameters
| Name | Type | Description |
|---|---|---|
| statusCode | Integer | Status code indicating the result of the request. |
| message | String | A message describing the result of the request. |
| data | Object | Contains the details of the newly generated virtual account. |
| accountLabel | String | The label used to identify the virtual account. |
| accountName | String | The name of the account, which includes the organization name and the account label. |
| account | String | The virtual account number that was generated. |
| bankName | String | The name of the bank where the virtual account is hosted (Access Bank). |
Sample Request
{
"accountLabel": "New Account ID",
"bvn": "0123456789",
"nin": "987654321",
"phoneNumber": "08012345678",
"email": "[email protected]"
}
Sample Response
{
"statusCode": "90000",
"message": "success",
"data": {
"accountLabel": "New Account ID",
"accountName": "HYDROGENCO - Random Organization-New Account ID",
"account": "0423079034",
"bankName": "Access Bank"
}
}
Additional Notes
- The bvn, nin, phoneNumber, and email are mandatory for account creation. All of these fields must be provided for the request to be successful.
- The accountLabel will be included in the accountName field of the generated virtual account, allowing for easy identification.
- Ensure that the authorization token is included in the header for each request, as it is necessary for authentication.