Virtual Account (Create, Update, Get) APIs Response Parameters

The Response parameters explained below.

Parameter NameValuesDescription
virtual_accounts_idNumericPrimary Identifier for each Virtual Account.
virtual_account_numberAlphanumericAccount No:
virtual_account_ifsc_codeAlphanumericIFSC
nameAlphanumericCustomer company name,
if individual, then customer name
primary_contactAlphanumericCustomer name
email_idAlphanumericEmail Id of customer
landline_numberNumericCustomer landline number
mobile_numbernumeric, 10 digitsMobile number of customer
created_atTimestampTime of creation of Virtual Account
updated_atTimestampTime 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 NameValuesDescription
event_sourceAlphanumericWebhook Source,
value will be "virtual_account_payment" for VA payment webhook
event_types_idNumeric4 - va_credited
5 - va_failed
6 - va_refunded
4 - va_credited
5 - va_failed
6 - va_refunded
amountDecimal (14,2)Payment Amount
bank_ref_idAlphanumericBank Transaction Reference Id
virtual_account_numberAlphanumericVirtual Account No:
payment_dateTimestampTimestamp
payment_modeAlphanumericMode of Payment (NEFT, RTGS, IMPS, UPI, CASH)
nameAlphanumericCustomer company name,
if individual, then customer name
primary_contactAlphanumericCustomer name
email_idAlphanumericEmail Id of customer
mobile_numbernumeric, 10 digitsMobile number of customer
vpaAlphanumericUPI ID - will provide only if mode of payment is UPI
hashStringhashed 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"
}