Smart Collect APIs

Create, update, close and fetch Virtual Accounts and resend notifications using APIs.


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.

API-wise Integration Checklist for Smart Collect🔗

Create a Customer🔗

  1. Use this API if a virtual account/UPI ID will be mapped to a unique customer.
  2. You can use the fail_existing (set to 1) API parameter to create a customer. This helps you avoid customer_id being created multiple times for the same customer and will help in your reconciliation process.
  3. We request you to create a single customer_id rather than making multiple Ids for the same customer. If their details change, you can use the Edit Customer Details API. Duplicate validation is done based on the combination of email ID and phone number.

Create a Virtual Account🔗

  1. UPI virtual accounts are supported only in Live mode.
  2. The combination of merchant prefix and descriptor must be 20 characters. The length of the merchant prefix can vary between 4-10 characters and the length of the descriptor from 10-16 characters.
  3. Payments made to the virtual accounts must be within the transaction limits.
  4. We recommend that you use Fetch APIs to make a GET call for any downstream dependencies. Webhooks are just a recommended layer on top of this.
  5. We recommend you Close the Virtual Account once the payment is received.

List of Smart Collect APIs🔗

API

Description

Create Virtual Account

API to create a Virtual Account.

Fetch a Virtual Account by ID

API to Fetch a Virtual Account by ID.

Fetch all Virtual Accounts

API to fetch all Virtual Accounts.

Fetch Payments for a Virtual Account

API to fetch payments made against a particular Virtual Account.

Fetch Payment Details using ID and Transfer Method

API to retrieve details of a payment using the Payment ID and transfer method.

Refund Payments made to a Virtual Account

APIs to process refunds for a payment made towards a virtual account.

Add Receiver to an Existing Virtual Account

API to add receiver to an existing virtual account.

Close a Virtual Account

API to close a virtual account.

API-wise Integration Checklist for Smart Collect TPV🔗

Create a Customer🔗

  1. Use this API if a virtual account is mapped to a unique customer.
  2. You can use the fail_existing (set to 1) API parameter to create a customer. This helps you avoid customer_id being created multiple times for the same customer and will help in your reconciliation process.
  3. We request you to create a single customer_id rather than making multiple Ids for the same customer. If their details change, you can use the Edit Customer Details API. Duplicate validation is done based on the combination of email ID and phone number.

Create a Virtual Account🔗

  1. Smart Collect with TPV is supported only for Netbanking.
  2. The combination of merchant prefix and descriptor must be 20 characters. The length of the merchant prefix can vary between 4-10 characters and the length of the descriptor from 10-16 characters.
  3. Avoid ambiguous account numbers. Consider the following:
    • When displaying a bank account number to a customer, the font may cause the customer to misread the alphanumeric characters (if any) in the number. Customers can commit typos while entering the beneficiary account number. Misreading the letter O in an account number as the numeral 0, for example, is extremely common.
    • Payments made to such mistyped accounts are considered invalid. They are refunded to the customer's account within 1 working day. However, this is still a massive inconvenience for the customer, who now has to wait 24 hours to receive a refund for what is often a rather large payment.
    • We strongly advise against using the following characters in your descriptor for alphanumeric accounts, as they may appear ambiguous in specific fonts.
      • 0 or O
      • 1 or I
      • 5 or S
      • 8 or B
      • 2 or Z
  4. You can add up to 10 allowed payers while creating the virtual account.
  5. The allowed payer can be deleted or added later using the Add an Allowed Payer and the Delete an Allowed Payer APIs.

List of APIs for Smart Collect TPV🔗

To know more about Third Party Validation (TPV), click here.

API

Description

Create Virtual Account

API to create a Virtual Account.

Add an Allowed Payer Account

API to add allowed payers account details to a virtual account.

Fetch a Virtual Account by ID

API to Fetch a Virtual Account by ID.

Fetch all Virtual Accounts

API to fetch all Virtual Accounts.

Fetch Payments for a Virtual Account

API to fetch payments made against a particular Virtual Account.

Fetch Payment Details using ID and Transfer Method

API to retrieve details of a payment using the Payment ID and transfer method.

Delete an Allowed Payer Account

API to delete allowed payers account details added to a Virtual Account.

Refund Payments made to a Virtual Account

APIs to process refunds for a payment made towards a Virtual Account.

Add Receiver to an Existing Virtual Account

API to add receiver to an existing Virtual Account.

Close a Virtual Account

API to close a Virtual Account.

×