API ReferenceIntegrationsKnowledge Base

Fetch Virtual Accounts

You can retrieve details of virtual accounts and payments made to virtual accounts using these APIs.

APIs are available to:

Allowed Payers:
allowed_payers is an optional parameter. Returns in the response only if you have sent those while creating the virtual account. You can add account details of 5 allowed payers for a virtual account.

Fetch Virtual Account by ID🔗

/virtual_accounts/:id

Retrieves a specific virtual account using its ID.

Path Parameter🔗

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

Fetch All Virtual Accounts🔗

/virtual_accounts

Retrieves all the virtual accounts that are created by you.

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 made to a Virtual Account🔗

/virtual_accounts/:id/payments

Retrieves all the payments made to a specific virtual account for a given ID.

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🔗

Retrieve the payment details for a given payment ID and transfer method.

Bank Transfer🔗

/payments/:id/bank_transfer

Retrieves the bank transfer details of a given payment ID.

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

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.

UPI🔗

/payments/:id/upi_transfer

Retrieves the UPI transfer details of a given payment ID.

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

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.

‹›
×