Razorpay Smart Collect enables you to create virtual accounts to accept large payments from your customers in the form of bank transfers via NEFT, RTGS and IMPS.

Virtual accounts are similar to bank accounts wherein customers can transfer payments. You can create, retrieve and close virtual accounts using the Smart Collect APIs.

The virtual account response contains attributes such as id, customer_id and a field, receivers. This is an array that defines what receivers are available for the virtual account.

For example, if the receiver.types array of the original request contained bank_account, then the response will contain a receivers array which gives details of that bank_account receiver such as account number, IFSC and more.

You can try out our APIs on the Razorpay Postman Public Workspace.

Smart Collect Entity🔗

id

string The unique identifier of the virtual account.

name

string The merchant billing label as it appears on the Razorpay Dashboard.

entity

string Indicates the type of entity. Here, it is virtual account.

status

string Indicates whether the virtual account is in active or closed state.

description

string A brief description about the virtual account.

amount_paid

integer The amount paid by the customer into the virtual account.

notes

json object Any custom notes you might want to add to the virtual account can be entered here. Refer Notes section of the API Reference Guide to learn more.

customer_id

string Unique identifier of the customer the virtual account is linked with. Refer the Customer API section to learn more.

receivers

json object Configuration of desired receivers for the virtual account.

id

string The unique identifier of the virtual bank account or virtual UPI ID. Sample IDs for:

- virtual bank account - ba_Di5gbQsGn0QSz3
- virtual UPI ID - vpa_CkTmLXqVYPkbxx.

entity

string Name of the entity. Possible values are
- bank_account
- vpa

ifsc

string The IFSC for the virtual bank account created. For example, RAZR0000001. This parameter appears in the response only when bank_account is passed as the receiver type.

bank_name

string The bank associated with the virtual bank account. For example, RAZR0000001. This parameter appears in the response only when bank_account is passed as the receiver type.

account_number

string The unique account number provided by the bank. For example, 1112220061746877. This parameter appears in the response only when bank_account is passed as the receiver type.

name

string The merchant billing label as it appears on the Razorpay Dashboard. This parameter appears in the response only when bank_account is passed as the receiver type.

notes

json object Any custom notes you might want to add to the virtual bank account or virtual UPI ID can be entered here. Refer Notes section of the API Reference Guide to learn more. This parameter appears in the response only when bank_account is passed as the receiver type.

username

string The UPI ID consists of the username and the bank handle. The username consists of the namespace (assigned by the bank to Razorpay), the merchant prefix (which can be customized by you) and the descriptor (which you provide to identify the customer). The unique identifier which forms the first half of the virtual UPI ID. For example, rpy.payto00000gaurikumar. This parameter appears in the response only when vpa is passed as the receiver type.

handle

string The bank name that forms the second half of the virtual UPI ID. For example, icici. This parameter appears in the response only when vpa is passed as the receiver type.

address

string The UPI ID that combines the username and the handle with the @ symbol. For example, rpy.payto00000gaurikumar@icici. This parameter appears in the response only when vpa is passed as the receiver type.

close_by

integer UNIX timestamp at which the virtual account is scheduled to be automatically closed. The time must be at least 15 minutes after current time. The date range can be set till 2147483647 in UNIX timestamp format (equivalent to Tuesday, January 19, 2038 8:44:07 AM GMT+05:30).
Note:
Any request beyond 2147483647 UNIX timestamp will fail.

closed_at

integer UNIX timestamp at which the virtual account is automatically closed.

created_at

integer UNIX timestamp at which the virtual account was created.

 Sample Entity
Copy{
  "id":"va_CaVE4QbyJvQRdk",
  "name":"Acme Corp",
  "entity":"virtual_account",
  "status":"active",
  "description":"Virtual Account created for Gaurav Kumar",
  "notes":{
    "flat no":"105"
  },
  "amount_paid":0,
  "customer_id":"cust_805c8oBQdBGPwS",
  "receivers":[
    {
      "id": "ba_DzXNNxY8yQu5iV",
      "entity": "bank_account",
      "ifsc":"RATN0VAAPIS",
      "bank_name": "RBL Bank",
      "name": "Acme Corp",
      "notes": [],
      "account_number": "2223333230231378"
    },
    {
      "id":"vpa_CkTmLXqVYPkbxx",
      "entity":"vpa",
      "username":"rpy.payto00000gaurikumar",
      "handle":"icici",
      "address":"rpy.payto00000gaurikumar@icici"
    }
  ],
  "close_by": 1581615838,
  "closed_at": null,
  "created_at": 1577962694
}

Create Virtual Account🔗

The following endpoint creates a virtual account.

/virtual_accounts

Note:
The request format for virtual account creation recently underwent a change. If you are looking for the request format as it was before 21/11/17, you can find it here.
For new integrations, we strongly recommend you use the updated request format, as it allows a host of new features, most particularly the support for completely-numeric account numbers by default.

Request Parameters🔗

Custom Merchant Prefix:
You can customize the merchant prefix of the vpa (payto00000) as per your business requirements. This is an on-demand feature and is not available by default. To enable creation of custom merchant prefix, raise a request on our Support Portal.

receivers mandatory

json object Configuration of desired receivers for the virtual account.

types

array List of desired receiver types. Possible values:

bank_account
vpa
qr_code

vpa optional

json object Descriptor details for the virtual UPI ID. This is to be passed only when vpa is passed as the receiver types.

descriptor: string You can provide a custom descriptor for the UPI ID. This is a unique identifier provided by you to identify the customer. For example, gaurikumar and akashkumar are the descriptors in the usernames rpy.payto00000gaurikumar and rpy.payto00000akashkumar respectively. The combination of merchant prefix and descriptor must be 20 characters. If you go ahead with the default merchant prefix, you will get 10 characters. Hence the descriptor should be 10 characters only.
Handy Tips
If a user tries to input 11 or more characters in a descriptor, our API will throw an error for invalid character length.

qr_code optional

json object Descriptor details for the QR code. This is to be passed only when qr_code is passed as the receiver types. Know about the request parameters to be passed to create a QR code.

bank_account optional

json object Descriptor details for the Bank Account. This is to be passed only when bank_account is passed as the receiver types.

descriptor: string You can provide a custom descriptor for the bank account. This allows generation of bank account numbers in a sequence defined by you. The maximum length allowed is 8 digits.
Handy Tips
The descriptor parameter can be passed for both bank_account and vpa receiver types. Please reach out to the support team if you are unable to pass the parameter with bank_account.

description optional

string A brief description of the virtual account.

customer_id optional

string Unique identifier of the customer to whom the virtual account must be tagged. Refer to the Customer API documentation to learn how to create a customer.

notes optional

json object Any custom notes you might want to add to the virtual account can be entered here. Refer to the Notes section of the API Reference Guide to learn more.

close_by optional

Note:
While sharing the details of VAs (created using RBL bank) with the customers, ensure that the fifth character in the IFSC is number 0 and not the letter O. For example, valid IFSC is RATN0VAAPIS and not RATNOVAAPIS.

 Curl- bank account Java Python Go PHP Node.JS Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/virtual_accounts \
-H "Content-Type: application/json" \
-d '{
    "receivers": {
        "types": [
            "bank_account"
        ]
    },
    "description": "Virtual Account created for Raftar Soft",
    "customer_id": "cust_CaVDm8eDRSXYME",
    "close_by": 1681615838,
    "notes": {
        "project_name": "Banking Software"
    }
}' 
CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject request = new JSONObject();
JSONArray receiverTypeArray = new JSONArray();
receiverTypeArray.put("bank_account");
request.put("receiver_types", receiverTypeArray);
JSONObject notes = new JSONObject();
notes.put("receiver_key", "receiver_value");
request.put("notes", notes);
request.put("description", "First Virtual Account");

VirtualAccount virtualAccount = razorpayClient.VirtualAccounts.create(request);
Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.create({
  "receivers": {
    "types": [
      "bank_account"
    ]
  },
  "description": "Virtual Account created for Raftar Soft",
  "customer_id": "cust_CaVDm8eDRSXYME",
  "close_by": 1681615838,
  "notes": {
    "project_name": "Banking Software"
  }
})

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

types := make(map[string]interface{})
types["0"] = "bank_account"

data:= map[string]interface{}{
  "receivers": map[string]interface{}{
    "types": types,
  },
  "description": "Virtual Account created for Raftar Soft",
  "customer_id": "cust_CaVDm8eDRSXYME",
  "close_by": 1681615838,
  "notes": map[string]interface{}{
    "project_name": "Banking Software",
  },
}

body, err := client.VirtualAccount.Create(data, nil)

Copy$api = new Api($key_id, $secret);

$api->virtualAccount->create(array('receivers' => array('types'=> array('bank_account')),'allowed_payers' => array(array('type'=>'bank_account','bank_account'=>array('ifsc'=>'RATN0VAAPIS','account_number'=>'2223330027558515'))),'description' => 'Virtual Account created for Raftar Soft','customer_id' => 'cust_HssUOFiOd2b1TJ', 'notes' => array('project_name' => 'Banking Software')));

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.create({
  receivers: {
    types: [
      "bank_account"
    ]
  },
  description: "Virtual Account created for Raftar Soft",
  customer_id: "cust_CaVDm8eDRSXYME",
  close_by: 1681615838,
  notes: {
    project_name: "Banking Software"
  }
})

Copy{
  "id":"va_DlGmm7jInLudH9",
  "name":"Acme Corp",
  "entity":"virtual_account",
  "status":"active",
  "description":"Virtual Account created for Raftar Soft",
  "amount_expected":null,
  "notes":{
    "project_name":"Banking Software"
  },
  "amount_paid":0,
  "customer_id":"cust_CaVDm8eDRSXYME",
  "receivers":[
    {
      "id":"ba_DlGmm9mSj8fjRM",
      "entity":"bank_account",
      "ifsc":"RATN0VAAPIS",
      "bank_name": "RBL Bank",
      "name":"Acme Corp",
      "notes":[],
      "account_number":"2223330099089860"
    }
  ],
  "close_by":1681615838,
  "closed_at":null,
  "created_at":1574837626
}

Sample Code for VPA Creation🔗

Use the sample codes given on the right to create a virtual account with vpa as the receiver type.

 Curl Response Curl Go Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/virtual_accounts \
-H "Content-Type: application/json" \
-d '{
  "receivers": {
    "types": [
      "vpa"
    ],
    "vpa": { // Pass this only for custom descriptor.
      "descriptor": "gaurikumar"
    }
  },
  "description": "Receive payment instalment from Gaurav Kumar- Flat No 105",
  "customer_id": "cust_BM8NbnFAk1BVDA",
  "close_by": 1681615838
}'
Copy{
  "id": "va_DzaBLzIz494C64",
  "name": "Acme Corp",
  "entity": "virtual_account",
  "status": "active",
  "description": "Receive payment instalment from Gaurav Kumar- Flat No 105",
  "amount_expected": null,
  "notes": [],
  "amount_paid": 0,
  "customer_id": "cust_BM8NbnFAk1BVDA",
  "receivers": [
    {
      "id": "vpa_DzaBM9AEJew8H1",
      "entity": "vpa",
      "username": "rpy.payto00000gaurikumar",
      "handle": "icici",
      "address": "rpy.payto00000gaurikumar@icici"
    }
  ],
  "close_by": 1681615838,
  "closed_at": null,
  "created_at": 1577962694
}

### Sample Codes for QR Creation

Use the sample codes given on the right to create a virtual account with `qr_code` as the receiver type.

<aside>

Copycurl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/virtual_accounts \
-H "Content-Type: application/json" \
-d '{
  "receivers": {
    "types": [
      "qr_code"
    ]
  },
  "description": "Virtual Account created for Raftar Soft",
  "customer_id": "cust_HfC8G4TFAthfxw",
  "close_by": 1681615838,
  "notes": {
    "project_name": "Banking Software"
  }
}'

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

types := make(map[string]interface{})
types["0"] = "qr_code"

data:= map[string]interface{}{
  "receivers": map[string]interface{}{
    "types": types,
  },
	"description": "Virtual Account created for Raftar Soft",
	"customer_id": "cust_HfC8G4TFAthfxw",
	"notes": map[string]interface{}{
	  "reference_key": "reference_value",
	},
}

body, err := client.VirtualAccount.Create(data, nil)

Copy{
  "id": "va_JZSu5AAEtmoUYT",
  "name": "Word Express",
  "entity": "virtual_account",
  "status": "active",
  "description": "Virtual Account created for Raftar Soft",
  "amount_expected": null,
  "notes": {
    "project_name": "Banking Software"
  },
  "amount_paid": 0,
  "customer_id": "cust_HfC8G4TFAthfxw",
  "receivers": [
    {
      "id": "qr_JZSu5AgGaUyo49",
      "entity": "qr_code",
      "reference": "JZSu5AgGaUyo49",
      "short_url": "https://rzp.io/i/MiL2iudYU",
      "created_at": 1653482739
    }
  ],
  "close_by": 1681615838,
  "closed_at": null,
  "created_at": 1653482740
}

Sample Code for Both- VPA and Bank Account Creation🔗

Use the sample code given on the right to create a virtual account with both bank_account and vpa receiver types.

 Request Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/virtual_accounts \
-H "Content-Type: application/json" \
-d '{
  "receivers": {
    "types": [
      "vpa",
      "bank_account"
    ],
    "vpa": {
      "descriptor": "gaurikumar"
    }
  },
  "description": "Receive payment instalment from Gaurav Kumar- Flat No 105",
  "customer_id": "cust_BM8NbnFAk1BVDA",
  "close_by": 1681615838
}'
Copy{
  "id": "va_DzaznJGgvduD1R",
  "name": "Acme Corp",
  "entity": "virtual_account",
  "status": "active",
  "description": "Receive payment instalment from Gaurav Kumar- Flat No 105",
  "amount_expected": null,
  "notes": [],
  "amount_paid": 0,
  "customer_id": "cust_BM8NbnFAk1BVDA",
  "receivers": [
    {
      "id": "ba_Dzaznb0XK1yx1l",
      "entity": "bank_account",
      "ifsc": "RATN0VAAPIS",
      "bank_name": "RBL Bank",
      "name": "Acme Corp",
      "notes": [],
      "account_number": "2223333226676435"
    },
    {
      "id": "vpa_DzaznS24HKkTBY",
      "entity": "vpa",
      "username": "rpy.payto00000gaurikumar",
      "handle": "icici",
      "address": "rpy.payto00000gaurikumar@icici"
    }
  ],
  "close_by": 1681615838,
  "closed_at": null,
  "created_at": 1577965559
}

Fetch a Virtual Account by ID🔗

The following endpoint fetches a virtual account by ID.

/virtual_accounts/:id

 Curl Java Python PHP Node.JS Go Response - bank_account Response - vpa Both types
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET \
https://api.razorpay.com/v1/virtual_accounts/va_D6Vw6zyJ0OmRZg \
CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

VirtualAccount virtualAccount = razorpayClient.VirtualAccounts.fetch("<virtual_account_id>");
Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.fetch(virtualId)

Copy$api = new Api($key_id, $secret);

$api->virtualAccount->fetch($virtualId);

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.fetch(virtualId)

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.VirtualAccount.Fetch("<virtualId>", nil, nil)

Copy{
  "id": "va_D6Vw6zyJ0OmRZg",
  "name": "Acme Corp",
  "entity": "virtual_account",
  "status": "active",
  "description": "Virtual Account for Raftar Soft",
  "amount_expected": 5000,
  "notes": [],
  "amount_paid": null,
  "customer_id": "cust_9xnHzNGIEY4TAV",
  "receivers": [
    {
      "id": "ba_D6Vw76RrHA3DC9",
      "entity": "bank_account",
      "ifsc": "RATN0VAAPIS",
      "bank_name": "RBL Bank",
      "name": "Acme Corp",
      "notes": [],
      "account_number": "2223330025991681"
    }
  ],
  "close_by": null,
  "closed_at": 1568109789,
  "created_at": 1565939036
}
Copy{
  "id": "va_D6Vw6zyJ0OmRZg",
  "name": "Acme Corp",
  "entity": "virtual_account",
  "status": "active",
  "description": "Virtual Account for Raftar Soft",
  "notes": [],
  "amount_paid": 5000,
  "customer_id": "cust_9xnHzNGIEY4TAV",
  "receivers": [
    {
      "id": "vpa_CkTmLXqVYPkbxx",
      "entity": "vpa",
      "username": "rpy.payto00000gaurikumar",
      "handle": "icici",
      "address": "rpy.payto00000gaurikumar@icici"
    }
  ],
  "close_by": null,
  "closed_at": 1568109789,
  "created_at": 1565939036
}
Copy{
  "id": "va_D6Vw6zyJ0OmRZg",
  "name": "Acme Corp",
  "entity": "virtual_account",
  "status": "active",
  "description": "Virtual Account for Raftar Soft",
  "notes": [],
  "amount_paid": 5000,
  "customer_id": "cust_9xnHzNGIEY4TAV",
  "receivers": [
    {
      "id": "ba_D6Vw76RrHA3DC9",
      "entity": "bank_account",
      "ifsc": "RATN0VAAPIS",
      "bank_name": "RBL Bank",
      "name": "Acme Corp",
      "notes": [],
      "account_number": "2223330025991681"
    },
    {
      "id": "vpa_CkTmLXqVYPkbxx",
      "entity": "vpa",
      "username": "rpy.payto00000gaurikumar",
      "handle": "icici",
      "address": "rpy.payto00000gaurikumar@icici"
    }
  ],
  "close_by": null,
  "closed_at": 1568109789,
  "created_at": 1565939036
}

Path Parameter🔗

id mandatory: string The unique identifier of the virtual account whose details are to be fetched.

Fetch all Virtual Accounts🔗

The following endpoint fetches the details of all virtual accounts.

/virtual_accounts

 Curl Java Python PHP Node.JS GoResponse
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET \
https://api.razorpay.com/v1/virtual_accounts \
CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

List<VirtualAccount> virtualAccountList = razorpayClient.VirtualAccounts.fetchAll();
Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.all(options)

Copy$api = new Api($key_id, $secret);

$api->virtualAccount->all($options);

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.all(options)

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data:= map[string]interface{}{
    "count" : 1
}

body, err := client.VirtualAccount.All(data, nil)

Copy{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "va_Di5gbNptcWV8fQ",
      "name": "Acme Corp",
      "entity": "virtual_account",
      "status": "closed",
      "description": "Virtual Account created for M/S ABC Exports",
      "amount_expected": 2300,
      "notes": {
        "material": "teakwood"
      },
      "amount_paid": 239000,
      "customer_id": "cust_DOMUFFiGdCaCUJ",
      "receivers": [
        {
          "id": "ba_Di5gbQsGn0QSz3",
          "entity": "bank_account",
          "ifsc": "RATN0VAAPIS",
          "bank_name": "RBL Bank",
          "name": "Acme Corp",
          "notes": [],
          "account_number": "1112220061746877"
        }
      ],
      "close_by": 1574427237,
      "closed_at": 1574164078,
      "created_at": 1574143517
    },
    {
      "id": "va_Dho86Avmdw6h09",
      "name": "Acme Corp",
      "entity": "virtual_account",
      "status": "active",
      "description": "Virtual Account created for Raftar Soft",
      "amount_expected": null,
      "notes": {
        "material": "oakwood"
      },
      "amount_paid": 0,
      "customer_id": "cust_DOMUFFiGdCaDNK",
      "receivers": [
        {
          "id": "ba_Dho86DoV16LqiO",
          "entity": "bank_account",
          "ifsc": "RATN0VAAPIS",
          "bank_name": "RBL Bank",
          "name": "Acme Corp",
          "notes": [],
          "account_number": "1112220046254840"
        }
      ],
      "close_by": 1574427237,
      "closed_at": null,
      "created_at": 1574081690
    }
  ]
}

Query Parameters🔗

from: integer Timestamp, in seconds, from when virtual accounts are to be fetched.
to: integer Timestamp, in seconds, till when virtual accounts are to be fetched.
count: integer Number of virtual accounts to be fetched. The default value is 10 and the maximum value is 100. This can be used for pagination, in combination with skip.
skip: integer Number of records to be skipped while fetching the virtual accounts. This can be used for pagination, in combination with count.

Fetch Payments for a Virtual Account🔗

The following endpoint fetches payments made against a particular virtual account.

/virtual_accounts/:id/payments

 Curl Java Python PHP Node.JS GoResponse
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET \
https://api.razorpay.com/v1/virtual_accounts/va_CminDKtoToBGmd/payments \
CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

List<Payment> paymentList = razorpayClient.VirtualAccounts.fetchPayments("virtual_account_id");
Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.payments(virtualId,options)

Copy$api = new Api($key_id, $secret);

$api->virtualAccount->fetch($virtualId)->payments($options);

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.fetchPayments(virtualId,options)

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.VirtualAccount.Payments("<virtualId>", nil, nil)

Copy{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "pay_Di5iqCqA1WEHq6",
      "entity": "payment",
      "amount": 239000,
      "currency": "INR",
      "status": "captured",
      "order_id": null,
      "invoice_id": null,
      "international": false,
      "method": "bank_transfer",
      "amount_refunded": 0,
      "refund_status": null,
      "captured": true,
      "description": "",
      "card_id": null,
      "bank": null,
      "wallet": null,
      "vpa": null,
      "email": "saurav.kumar@example.com",
      "contact": "+919972139994",
      "customer_id": "cust_DOMUFFiGdCaCUJ",
      "notes": [],
      "fee": 2820,
      "tax": 430,
      "error_code": null,
      "error_description": null,
      "created_at": 1574143644
    }
  ]
}

Path Parameter🔗

id mandatory: string The unique identifier of the virtual account for which the payment details are to be fetched.

The response parameters are the same as those mentioned in Fetch a Payment API.

Query Parameters🔗

from: integer Timestamp, in seconds, from when payments are to be fetched.
to: integer Timestamp, in seconds, till when payments are to be fetched.
count: integer Number of payments to be fetched. The default value is 10 and the maximum value is 100. This can be used for pagination, in combination with skip.
skip: integer Number of records to be skipped while fetching the payments. This can be used for pagination, in combination with count.

Fetch Payment Details using ID and Transfer Method🔗

You can retrieve details of a payment using the Payment ID and transfer method.

Bank Transfer🔗

/payments/:id/bank_transfer

 Curl PHP Python Go Node.JSResponse
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET \
https://api.razorpay.com/v1/payments/pay_CmiztqmYJPtDAu/bank_transfer \

Copy$api = new Api($key_id, $secret);

$api->payment->fetch($virtualId)->bankTransfer();

Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment.bank_transfer(paymentId)

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.Payment.BankTransfer("<paymentID>", nil, nil)

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.bankTransfer(paymentId)

Copy{
  "id": "bt_Di5iqCElVyRlCb",
  "entity": "bank_transfer",
  "payment_id": "pay_Di5iqCqA1WEHq6",
  "mode": "NEFT",
  "bank_reference": "157414364471",
  "amount": 239000,
  "payer_bank_account": {
    "id": "ba_Di5iqSxtYrTzPU",
    "entity": "bank_account",
    "ifsc": "UTIB0003198",
    "bank_name": "Axis Bank",
    "name": "Acme Corp",
    "notes": [],
    "account_number": "765432123456789"
  },
  "virtual_account_id": "va_Di5gbNptcWV8fQ",
  "virtual_account": {
    "id": "va_Di5gbNptcWV8fQ",
    "name": "Acme Corp",
    "entity": "virtual_account",
    "status": "closed",
    "description": "Virtual Account created for M/S ABC Exports",
    "amount_expected": 2300,
    "notes": {
      "material": "teakwood"
    },
    "amount_paid": 239000,
    "customer_id": "cust_DOMUFFiGdCaCUJ",
    "receivers": [
      {
        "id": "ba_Di5gbQsGn0QSz3",
        "entity": "bank_account",
        "ifsc": "RATN0VAAPIS",
        "bank_name": "RBL Bank",
        "name": "Acme Corp",
        "notes": [],
        "account_number": "1112220061746877"
      }
    ],
    "close_by": 1574427237,
    "closed_at": 1574164078,
    "created_at": 1574143517
  }
}

Note:
If Razorpay does not receive the bank account information of the customer from the remitting bank, the payer_bank_account key will be set to null.

Path Parameter🔗

id mandatory: string The unique identifier of the payment made to the virtual account.

Response Parameters🔗

id

string The unique identifier of the bank transfer.

entity

string The name of the entity. Here, it is bank_transfer.

payment_id

string The unique identifier of the payment.

mode

string The mode of bank transfer used. Possible values are:
- NEFT
- RTGS
- IMPS
- UPI

bank_reference

string Unique reference number provided by the bank for the transaction.

payer_bank_account

object The payer bank account details from which payment is received.

id: string The unique identifier of the customer's bank account.
entity: string The name of the entity. Here, it is bank_account.
ifsc: string The IFSC associated with the bank account.
bank_name: string The name of the bank in which the customer has an account.
notes: object Any custom notes added to the virtual bank account.
account_number: string The unique account number of the customer.

virtual_account_id

string The unique identifier of the virtual account.

virtual_account

object Details of the virtual account.

id

string The unique identifier of the virtual account.

name

string The merchant billing label as it appears on Razorpay Dashboard.

entity

string The name of the entity. Here, it is virtual account.

status

string Indicates the status of the virtual account. Possible values are:
- active
- closed

description

string A brief description about the virtual account.

amount_paid

integer The amount paid by the customer to the virtual account.

notes

object Any custom notes added during the creation of the virtual account.

customer_id

string The unique identifier of the customer the virtual account is linked with. For more details, refer to the Customers API.

receivers

object Configuration of desired receivers for the virtual account.

id: string The unique identifier of the virtual bank account. For example, ba_Di5gbQsGn0QSz3.
entity: string The name of the entity. Here, it is bank_account.
ifsc: string The IFSC for the virtual bank account created. For example, RATN0VAAPIS.
bank_name: string The bank associated with the virtual bank account. For example, RBL.
account_number: string The unique account number provided by the bank. For example, 1112220061746877.
name: string The merchant billing label as it appears on Razorpay Dashboard.
notes: object Any custom notes added during the creation of the virtual account.

close_by

closed_at

integer UNIX timestamp at which the virtual account is automatically closed.

created_at

integer UNIX timestamp at which the virtual account was created.

Bank Transfer via UTR🔗

/payments

 CurlResponse
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET \
https://api.razorpay.com/v1/payments?skip=0&count=25&va_transaction_id=209817848101&virtual_account=1
-H "Content-Type: application/json" \

Copy{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "pay_JGmL38CqCHTyZZ",
      "entity": "payment",
      "amount": 1000,
      "currency": "INR",
      "status": "captured",
      "order_id": null,
      "invoice_id": null,
      "international": false,
      "method": "upi",
      "amount_refunded": 0,
      "refund_status": null,
      "captured": true,
      "description": null,
      "card_id": null,
      "bank": null,
      "wallet": null,
      "vpa": "gaurav.khanna@okhdfcbank",
      "email": "saurav.kumar@razorpay.com",
      "contact": "+919900990099",
      "customer_id": "cust_HWj3MjySAHSjtq",
      "notes": [],
      "fee": 12,
      "tax": 2,
      "error_code": null,
      "error_description": null,
      "error_source": null,
      "error_step": null,
      "error_reason": null,
      "acquirer_data": {
        "rrn": "209817848101"
      },
      "created_at": 1649402719
    }
  ]
}

Query Parameters🔗

count: integer Number of payments to be fetched.
Default value is 10. Maximum value is 100. This can be used for pagination, in combination with the skip parameter.
skip: integer Number of records to be skipped while fetching the payments.
va_transaction_id: integer The unique id of the transaction done via a Virtual Account.
virtual_account: string The unique id of the Virtual Account.

Response Parameters🔗

id: string Unique identifier of the payment.
entity: string Indicates the type of entity.
amount: string The payment amount represented in smallest unit of the currency passed. For example, amount = 100 translates to 100 paise, that is ₹1 (default currency is INR).
currency: string The currency in which the payment is made. Refer to the list of international currencies that we support.
status: string The status of the payment. Possible values:
-created
-authorized
-captured
-refunded
-failed
base_amount: string The converted payment amount used to calculate fees and settlements. Represented in smallest unit of the base_currency. This attribute is currently only present if the currency is non-INR.
base_currency: string The conversion currency used to calculate fees and settlements. This currently defaults to INR, and is present only if the currency is non-INR.
method: string The payment method used for making the payment. Possible values:
-card
-netbanking
-wallet
- emi
-upi
order_id: string Order ID, if provided. Know more about Orders API.
description `: string Description of the payment, if any.
international: boolean Indicates whether the payment is done via an international card or a domestic one.
refund_status: string The refund status of the payment. Possible values include:
- null
- partial
- full
amount_refunded: integer The amount refunded in smallest unit of the currency passed.
For example, if amount_refunded = 100, here 100 stands for 100 paise, which is equal to ₹1. INR is the default currency.
captured: boolean Indicates if the payment is captured.
email: string Customer email address used for the payment.
contact: string Customer contact number used for the payment.
fee: integer Fee (including GST) charged by Razorpay.
tax: integer GST charged for the payment.
error_code: string Error that occurred during payment. For example, BAD_REQUEST_ERROR.
error_description: string Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.
error_source: string The point of failure. For example, customer.
error_step: string The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication.
error_reason: string The exact error reason. For example, incorrect_otp.
notes: json object Contains user-defined fields, stored for reference purposes.
created_at: integer Timestamp, in UNIX format, on which the payment was created.

UPI🔗

/payments/:id/upi_transfer

RequestResponse
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET \
https://api.razorpay.com/v1/payments/pay_E5YETrWuVgP3fI/upi_transfer \
Copy{
  "id": "ut_E5YEUKb9yA0YvX",
  "entity": "upi_transfer",
  "amount": 100,
  "payer_vpa": "gauravkumar@exampleupi",
  "payer_bank": "HDFC BANK LTD",
  "payer_account": "50100093961111",
  "payer_ifsc": "HDFC0000004",
  "payment_id": "pay_E5YETrWuVgP3fI",
  "npci_reference_id": "001718859181",
  "virtual_account_id": "va_E5V3Rb3sQaMS5v",
  "virtual_account": {
    "id": "va_E5V3Rb3sQaMS5v",
    "name": "Acme Corp",
    "entity": "virtual_account",
    "status": "active",
    "description": "First Virtual Account",
    "amount_expected": null,
    "notes": [],
    "amount_paid": 200,
    "customer_id": "cust_9xnHzNGIEY4TAV",
    "receivers": [
      {
        "id": "vpa_E5V3RsO1g4QK7t",
        "entity": "vpa",
        "username": "rpy.payto00000gaurikumar",
        "handle": "icici",
        "address": "rpy.payto00000gaurikumar@icici"
      }
    ],
    "close_by": null,
    "closed_at": null,
    "created_at": 1579254678
  }
}

Path Parameter🔗

id mandatory: string The unique identifier of the payment made to the virtual account.

Response Parameters🔗

id

string The unique identifier of the UPI transfer.

entity

string The name of the entity. Here, it is upi_transfer.

amount

integer The amount paid by the customer.

payer_vpa

string The UPI ID of the customer that is used to make the payment.

payer_bank

string The name of the customer's bank.

payer_account

string The bank account number of the customer that is linked to the UPI ID.

payer_ifsc

string The IFSC associated with the bank account.

payment_id

string The unique identifier of the payment made by the customer.

npci_reference_id

string The unique reference number provided by NPCI for the payment.

virtual_account_id

string The unique identifier of the virtual account.

virtual_account

object Details of the virtual account.

id

string The unique identifier of the virtual account.

name

string The merchant billing label as it appears on Razorpay Dashboard.

entity

string The name of the entity. Here, it is virtual account.

status

string Indicates the status of the virtual account. Possible values are:
- active
- closed

description

string A brief description about the virtual account.

amount_paid

integer The amount paid by the customer into the virtual account.

notes

object Any custom notes added during the creation of the virtual account.

customer_id

string The unique identifier of the customer the virtual account is linked with. For more details, refer to the Customers API.

receivers

object Configuration of desired receivers for the virtual account.

id: string The unique identifier of the virtual UPI ID. For example, vpa_CkTmLXqVYPkbxx.
entity: string The name of the entity. Here, it is vpa.
username: string The unique identifier which forms the first half of the virtual UPI ID. For example, rpy.payto00000gaurikumar.
handle: string The bank name that forms the second half of the virtual UPI ID. For example, icici.
address: string The UPI ID that combines the username and the handle with the @ symbol. For example, rpy.payto00000gaurikumar@icici. This parameter appears in the response only when vpa is passed as the receiver type.

close_by

closed_at

integer UNIX timestamp at which the virtual account is automatically closed.

created_at

integer UNIX timestamp at which the virtual account was created.

Refund Payments made to a Virtual Account🔗

You can process refunds for a payment made towards a virtual account. The following endpoint refunds a payment using the payment ID.

/payments/:id/refund

Path Parameter🔗

id mandatory: string The unique identifier of the payment to be refunded.

 Curl PHP Python Go Ruby Node.JS .NET Java Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f/refund \
-H 'Content-Type: application/json' \
-d '{
  "amount": 500100
}'

Copy<?php

use Razorpay\Api\Api;
$api = new Api('YOUR_KEY_ID, 'YOUR_KEY_SECRET');

$payment = $api->payment->fetch('pay_DgExayLn3RBbZX');
$refund = $payment->refund();

//$refund = $payment->refund(array('amount' => 500100)); for partial refund

?>
Copyimport razorpay
razorpay.Client(auth=("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"))

client.payment.refund(paymentId,{
  "amount": "100",
  "speed": "normal",
  "notes": {
    "notes_key_1": "Beam me up Scotty.",
    "notes_key_2": "Engage"
  },
  "receipt": "Receipt No. 31"
})

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data := map[string]interface{}{
	"notes": map[string]interface{}{
    "key_1": "value1",
    "key_2": "value2",
  },
}
body, err := client.Payment.Refund("pay_FCXKPFtYfPXJPy",1200, data, nil)

Copyrequire 'razorpay'

Razorpay.setup("YOUR_KEY_ID", "YOUR_KEY_SECRET")
Razorpay::Payment.fetch("pay_DgExayLn3RBbZX").refund()

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.refund(paymentId,{
  "amount": "100",
  "speed": "normal",
  "notes": {
    "notes_key_1": "Beam me up Scotty.",
    "notes_key_2": "Engage"
  },
  "receipt": "Receipt No. 31"
})

Copy//initialize the SDK client
RazorpayClient client = new RazorpayClient("<api-key>", "<api-secret>");

// payment to be refunded, payment must be a captured payment
Payment payment = client.Payment.Fetch(paymentId);

//Full Refund
Refund refund = payment.Refund();

//Partial Refund
Dictionary<string, object> data = new Dictionary<string, object>();
data.Add("amount", "500100");
Refund refund = payment.Refund(data);
Copyimport org.json.JSONObject;
import com.razorpay.Payment;
import com.razorpay.Refund;
import com.razorpay.RazorpayClient;
import com.razorpay.RazorpayException;

RazorpayClient razorpay = new RazorpayClient("<api_key>", "<api_secret>");
try {
	// Full Refund
	Refund refund = razorpay.Payments.refund("<payment_id>");

	// Partial Refund
	JSONObject refundRequest = new JSONObject();
	refundRequest.put("amount", amount); // Amount should be in paise
	Refund refund = razorpay.Payments.refund("<payment_id>", refundRequest);
} catch (RazorpayException e) {
	// Handle Exception
	System.out.println(e.getMessage());
}
Copy{
  "id": "rfnd_FP8QHiV938haTz",
  "entity": "refund",
  "amount": 500100,
  "receipt": "Receipt No. 31",
  "currency": "INR",
  "payment_id": "pay_FCXKPFtYfPXJPy",
  "notes": []
  "receipt": null,
  "acquirer_data": {
    "arn": null
  },
  "created_at": 1597078866,
  "batch_id": null,
  "status": "processed",
  "speed_processed": "normal",
  "speed_requested": "normal"
}

Request Parameters🔗

amount optional

integer The amount to be refunded. Amount should be in the smallest unit of the currency in which the payment was made.

For a partial refund, enter a value lesser than the payment amount. For example, if the payment amount is ₹1500 and you want to refund only ₹500, you must pass 50000.
For full refund, enter the entire payment amount. If amount parameter is not passed, the entire payment amount will be refunded.

speed optional

string The speed at which the refund is to be processed. The default value is normal. Refund will be processed via the normal speed and the customer will receive the refund within 5-7 working days.

notes optional

json object Key-value pairs used to store additional information. A maximum of 15 key-value pairs can be included.

receipt optional

string A unique identifier provided by you for your internal reference.

Refer Refunds API to perform other refund-related operations:

Fetch a particular refund or a list of refunds for a payment ID.
Update a refund to modify the Notes field.

Add Receiver to an Existing Virtual Account🔗

You can add receiver to an existing virtual account using the endpoint given below. Watch Out:
If you had created a virtual account with a receiver, for example, bank account, you cannot add another bank account receiver or replace it. Similarly, if you had created a virtual account with only a VPA receiver, you cannot replace or update it.

/virtual_accounts/:id/receivers

Path Parameter🔗

id mandatory: string The unique identifier of the virtual account to which another receiver type is to be added.

 Curl - vpa PHP - vpa Curl - bank_account Node.JS - vpa Python - vpa Go Response - vpa Response - bank_account
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X POST https://api.razorpay.com/v1/virtual_accounts/va_DzcFjMezDcN8vv/receivers
-H 'content-type: application/json'
-d '{
  "types": [
    "vpa"
  ],
  "vpa": {
    "descriptor": "gaurikumar"
  }
}'

Copy$api = new Api('YOUR_KEY_ID, 'YOUR_KEY_SECRET');
$api->virtualAccount->fetch($virtualId)->addReceiver(array('types' => array('vpa'),'vpa' => array('descriptor'=>'gauravkumar')));
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X POST https://api.razorpay.com/v1/virtual_accounts/va_DzaBLzIz494C64/receivers
-H 'content-type: application/json'
-d '{
  "types": [
    "bank_account"
  ]
}'

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.addReceiver(virtualId,{
  types: [
    "vpa"
  ],
  vpa: {
    descriptor: "gauravkumar"
  }
})

Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.add_receiver(virtualId,{
  "type": [
    "vpa"
  ],
  "vpa": {
    "descriptor": "gauravkumar"
  }
})

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

types := make(map[string]interface{})
types["0"] = "vpa"

data:= map[string]interface{}{
	"types": types,
	"vpa": map[string]interface{}{
	  "descriptor": "gaurikumar",
	},
  }

body, err :=  client.VirtualAccount.AddReceiver("<virtualID>", data, nil)
  
Copy{
  "id": "va_DzcFjMezDcN8vv",
  "name": "Acme Corp",
  "entity": "virtual_account",
  "status": "active",
  "description": "",
  "amount_expected": null,
  "notes": [],
  "amount_paid": 0,
  "customer_id": "cust_DzbSeP2RJD1ZHg",
  "receivers": [
    {
      "id": "ba_DzcFjVqAMSCEIW",
      "entity": "bank_account",
      "ifsc":"RATN0VAAPIS",
      "bank_name": "RBL Bank",
      "name": "Acme Corp",
      "notes": [],
      "account_number": "2223333232194699"
    },
    {
      "id": "vpa_DzcZR5ofjCUKAx",
      "entity": "vpa",
      "username": "rpy.payto00000gaurikumar",
      "handle": "icici",
      "address": "rpy.payto00000gaurikumar@icici"
    }
  ],
  "close_by": null,
  "closed_at": null,
  "created_at": 1577969986
}
Copy{
  "id": "va_DzaBLzIz494C64",
  "name": "Acme Corp",
  "entity": "virtual_account",
  "status": "active",
  "description": "Virtual Account created for Raftar Soft",
  "amount_expected": null,
  "notes": [],
  "amount_paid": 0,
  "customer_id": "cust_Cp5BlkchbcN9vf",
  "receivers": [
    {
      "id": "ba_DzcfdIfpw37iUl",
      "entity": "bank_account",
      "ifsc": "YESB0CMSNOC",
      "bank_name": "Yes Bank",
      "name": "Acme Corp",
      "notes": [],
      "account_number": "2223333225458057"
    },
    {
      "id": "vpa_DzaBM9AEJew8H1",
      "entity": "vpa",
      "username": "rpy.payto00000gaurikumar",
      "handle": "icici",
      "address": "rpy.payto00000gaurikumar@icici"
    }
  ],
  "close_by": 1581615838,
  "closed_at": null,
  "created_at": 1577962694
}

Request Parameters🔗

types mandatory

array The receiver type to be added to the virtual account. Possible values are:

bank_account
vpa

vpa optional

json object Descriptor details for the virtual UPI ID. This is to be passed only when vpa is passed as the receiver types.

descriptor: string You can provide a custom descriptor for the UPI ID. This is a unique identifier provided by you to identify the customer. For example, gaurikumar and akashkumar are the descriptors in the usernames rpy.payto00000gaurikumar and rpy.payto00000akashkumar respectively. The combination of merchant prefix and descriptor must be 20 characters. If you go ahead with the default merchant prefix, you will get 10 characters. Hence the descriptor should be 10 characters only.
Note:
If a user tries to input 11 or more characters in a descriptor, our API will throw an error for invalid character length.

Close a Virtual Account🔗

The following endpoint closes a virtual account.

/virtual_accounts/:id/close

 Curl Java Python PHP Node.JS Go Response - bank_account Response - vpa Response - qr_code
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/virtual_accounts/va_Di5gbNptcWV8fQ/close
CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

VirtualAccount virtualAccount = razorpayClient.VirtualAccounts.close("<virtual_account_id>");
Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.close(virtualId)

Copy$api = new Api($key_id, $secret);

$api->virtualAccount->fetch($virtualId)->close();

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.close(virtualId)

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.VirtualAccount.Close("<virtualId>", nil, nil)

Copy{
  "id":"va_Di5gbNptcWV8fQ",
  "name":"Acme Corp",
  "entity":"virtual_account",
  "status":"closed",
  "description":"Virtual Account created for M/S ABC Exports",
  "amount_expected":230000,
  "notes":{
    "material":"teakwood"
  },
  "amount_paid":239000,
  "customer_id":"cust_DOMUFFiGdCaCUJ",
  "receivers":[
    {
      "id":"ba_Di5gbQsGn0QSz3",
      "entity":"bank_account",
      "ifsc":"RATN0VAAPIS",
      "bank_name": "RBL Bank",
      "name":"Acme Corp",
      "notes":[],
      "account_number":"1112220061746877"
    }
  ],
  "close_by":1574427237,
  "closed_at":1574164078,
  "created_at":1574143517
}
Copy{
  "id":"va_Di5gbNptcWV8fQ",
  "name":"Acme Corp",
  "entity":"virtual_account",
  "status":"closed",
  "description":"Virtual Account created for M/S ABC Exports",
  "amount_expected":null,
  "notes":{
    "material":"teakwood"
  },
  "amount_paid":239000,
  "customer_id":"cust_DOMUFFiGdCaCUJ",
  "receivers":[
    {
      "id":"vpa_CkTmLXqVYPkbxx",
      "entity":"vpa",
      "username": "rpy.payto00000468657501",
      "handle": "icici",
      "address": "rpy.payto00000468657501@icici"
    }
  ],
  "close_by":1574427237,
  "closed_at":1574164078,
  "created_at":1574143517
}
Copy{
  "id": "va_4xbQrmEoA5WJ0G",
  "name": "Acme Corp",
  "entity": "virtual_account",
  "status": "closed",
  "description": "Test UPI QR description",
  "amount_expected": null,
  "notes": {
    "purpose": "Test UPI QR notes"
  },
  "amount_paid": 0,
  "customer_id": "cust_805c8oBQdBGPwS",
  "receivers": [
    {
      "id": "qr_FuZIYx6rMbP6gs",
      "entity": "qr_code",
      "type": "upi_qr",
      "name": "Store_1",
      "image_url": "https://rzp.io/i/PLs03pOc",
      "usage": "single_use",
      "fixed_amount": true,
      "payment_amount": 300,
      "description": "For Store 1",
      "customer_id": "cust_FUEQArey3YFi9R",
      "close_by": 1681615838,
      "notes": {
        "purpose": "Test UPI QR code notes"
      },
      "status": "closed",
      "payments_count_received": 0,
      "payments_amount_received": 0,
      "closed_at": null,
      "created_at": 1603942055
    }
  ],
  "close_by": null,
  "closed_at": 1599650868,
  "created_at": 1607938184
}

Path Parameter🔗

id mandatory: string The unique identifier of the virtual account that is to be closed.