Virtual Account (Create, Update, Get) APIs Response Parameters
The Response parameters explained below.
Parameter Name | Values | Description |
---|---|---|
virtual_accounts_id | Numeric | Primary Identifier for each Virtual Account. |
virtual_account_number | Alphanumeric | Account No: |
virtual_account_ifsc_code | Alphanumeric | IFSC |
name | Alphanumeric | Customer company name, if individual, then customer name |
primary_contact | Alphanumeric | Customer name |
email_id | Alphanumeric | Email Id of customer |
landline_number | Numeric | Customer landline number |
mobile_number | numeric, 10 digits | Mobile number of customer |
created_at | Timestamp | Time of creation of Virtual Account |
updated_at | Timestamp | Time of last update of Virtual Account Details |
Below is the sample JSON for response
{
"data": [
{
"virtual_accounts_id": 1925091,
"virtual_account_number": "363611794580066",
"virtual_account_ifsc_code": "ICIC0000104",
"name": "MFK Enterprises",
"primary_contact": "John",
"email_id": "[email protected]",
"landline_number": null,
"mobile_number": "7011111111",
"created_at": "18-03-2020",
"updated_at": "18-03-2020"
}
],
"status": 200
}
Virtual Account Payment Webhook POST API request Parameters
Whenever a payment has been made for a virtual account, Open will notify the merchant with webhook. In order to get webhook, merchant should provide a valid POST URL in his Open Dashboard, under "Developer" section.
Parameter Name | Values | Description |
---|---|---|
event_source | Alphanumeric | Webhook Source, value will be "virtual_account_payment" for VA payment webhook |
event_types_id | Numeric | 4 - va_credited 5 - va_failed 6 - va_refunded 4 - va_credited 5 - va_failed 6 - va_refunded |
amount | Decimal (14,2) | Payment Amount |
bank_ref_id | Alphanumeric | Bank Transaction Reference Id |
virtual_account_number | Alphanumeric | Virtual Account No: |
payment_date | Timestamp | Timestamp |
payment_mode | Alphanumeric | Mode of Payment (NEFT, RTGS, IMPS, UPI, CASH) |
name | Alphanumeric | Customer company name, if individual, then customer name |
primary_contact | Alphanumeric | Customer name |
email_id | Alphanumeric | Email Id of customer |
mobile_number | numeric, 10 digits | Mobile number of customer |
vpa | Alphanumeric | UPI ID - will provide only if mode of payment is UPI |
hash | String | hashed body using HMAC 256. |
Sample POST Request body which we will send as webhook will be like below
{
"event_source":"virtual_account_payment",
"event_types_id":4,
"amount":"43.00",
"bank_ref_id":"7346tyeghd",
"virtual_account_number":"363636300000060019",
"payment_date":"2019-07-27",
"payment_mode":"NEFT",
"name":"Faris",
"primary_contact":"faris",
"email_id":"[email protected]",
"mobile_number":"7011111111",
"vpa":"",
"hash":"880026895d2123e114e97d1a3a386f2e34d9bdc5b49d5fa864f6099afd44a999"
}