API ReferenceIntegrationsKnowledge Base

Smart Collect

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.

Postman Collection#

We have a Postman collection to make the integration quicker and easier. Click the Download Postman Collection button below to get started.

Instructions for using the Postman Collection#

  • All Razorpay APIs are authorized using Basic Authorization.
    • Generate API Keys from the Dashboard .
    • Add your API Keys in Postman. Selected the required API → Auth → Type = Basic Auth → Username = <Your_Key_ID>; Password = <Your_Key_secret>
  • Some APIs in the collection require data specific to your account either in the request body or as path parameters. For example:
    • For example, the Fetch a Virtual Account by ID API requires you to add the va_id as a path parameter in the endpoint.
    • These parameters are enclosed in {} in the collection. For example, {va_id}.
    • The API throws an error if this value is incorrect or does not exist in your system.

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_expected

integer The amount you are expecting to receive from the customer.

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 identifier (which is decided by you) and the descriptor (which is provided as the identifier for the customer). The unique identifier which forms the first half of the virtual UPI ID. For example, rzpy.payto000005138396160. 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, hdfcbank. 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, rzpy.payto000005138396160@hdfcbank. 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.

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 Descriptor:
You can customize the descriptor of the vpa as per your business requirements. This is an on-demand feature and is not available by default. To enable creation of custom descriptors, 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 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 use a custom descriptor for the VPA. However, this is an on-demand feature. Raise a request with our support team to enable this for your account. This is a unique identifier (10 character long) provided by you to identify the customer. For example, 5138396160 and 5138396165 are the descriptors in the usernames rzpy.payto000005138396160 and rzpy.payto000005138396165 respectively.
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

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.

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 ISFC is RATN0VAAPIS and not RATNOVAAPIS.

Here is a sample request and response which can be used to create a virtual account with both bank_account and vpa receiver types.

Fetch a Virtual Account by ID#

The following endpoint fetches a virtual account by ID.

/virtual_accounts/:id

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

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

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

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_expected

integer The amount you are expecting to receive from the customer.

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

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_expected

integer The amount you are expecting to receive from the customer.

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, rzpy.payto000005138396160.
handle
string The bank name that forms the second half of the virtual UPI ID. For example, hdfcbank.
address
string The UPI ID that combines the username and the handle with the @ symbol. For example, rzpy.payto000005138396160@hdfcbank. 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.

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.

Request Parameters#

amount optional
string Amount to be refunded. If no value is passed, a full refund is issued.
notes optional
json object Array of notes fields. You can enter custom data in key-value pairs. Refer the Notes section of the API Reference documentation to learn more.

Response Parameters#

id
string The unique identifier of the refund.
amount
integer The amount that is refunded to the customer.
currency
string The currency in which the payment is made. We support international currencies.
payment_id
string The unique identifier of the payment.
notes
json object Array of notes fields. You can enter custom data in key-value pairs.
created_at
integer UNIX Timestamp that indicates when the refund was processed.

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.

Close a Virtual Account#

The following endpoint closes a virtual account.

/virtual_accounts/:id/close

Path Parameter#

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