Smart Collect with TPV

You can create Customer Identifiers using the Smart Collect APIs to accept large payments from your customers in the form of bank transfers via NEFT, RTGS and IMPS.

Know more about

Smart Collect

Changelog

We have changed the term Virtual Account to Customer Identifier. (Jan 2023)

Explore the Smart Collect API collection below in the Razorpay Postman Public Workspace. Fork the workspace and test the APIs with your

Test API Keys

List of Endpoints

API Endpoint	Description
Create a Customer Identifier	Creates a Customer Identifier with bank account.
Add an Allowed Payer Account	Adds an allowed payer's account.
Fetch a Customer Identifier With ID	Retrieves details of a Customer Identifier with id.
Fetch all Customer Identifiers	Retrieves details of all Customer Identifiers.
Fetch Payments for a Customer Identifier	Retrieves details of payments made against a particular Customer Identifier.
Fetch Payment Details using ID and Transfer Method	Retrieves details of a payment using payment id and bank transfer method.
Delete an Allowed Payer Account	Deletes an allowed payer account.
Refund Payments made to a Customer Identifier	Initiates refunds for a payment made towards a Customer Identifier.
Add Receiver to an Existing Customer Identifier	Adds receiver to an existing Customer Identifier.
Close a Customer Identifier	Closes a Customer Identifier.

Smart Collect Entity

The Smart Collect with TPV entity has the following fields:

string The unique identifier of the Customer Identifier.

name

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

entity

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

status

string Indicates whether the Customer Identifier is in active or closed state.

description

string A brief description about the Customer Identifier.

amount_expected

integer The amount expected by the merchant.

amount_paid

integer The amount paid by the customer into the Customer Identifier.

notes

json object Any custom notes you might want to add to the Customer Identifier can be entered here. Check the

Notes section

to know more.

customer_id

string Unique identifier of the customer the Customer Identifier is linked with. Check the

Customer API

section to know more.

receivers

json object Configuration of desired receivers for the Customer Identifier.

string The unique identifier of the Customer Identifier. Sample id for Customer Identifier is ba_Di5gbQsGn0QSz3

entity

string Name of the entity. Possible value is bank_account.

ifsc

string The IFSC for the Customer Identifier 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 Customer Identifier. 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 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 Customer Identifier can be entered here. Check the

Notes section

to know more. This parameter appears in the response only when bank_account is passed as the receiver type.

allowed_payers

array Details of customer bank accounts which will be allowed to make payments to your Customer Identifier. The parent parameter under which the customer bank account details must be passed as child parameters.

Handy Tips

You can add account details of 10 allowed payers for a Customer Identifier. For more details, refer to the

Third Party Validation

section.

type

string The type of account through which the customer will make the payment. Possible value is bank_account.

string The unique identifier of the allowed_payers account.

bank_account

object Indicates the bank account details such as ifsc and account_number.

ifsc

string The IFSC associated with the bank account through which the customer is expected to make the payment.

account_number

string The bank account number through which the customer is expected to make the payment.

close_by

integer UNIX timestamp at which the Customer Identifier 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). Any request beyond 2147483647 UNIX timestamp will fail.

closed_at

integer UNIX timestamp at which the Customer Identifier is automatically closed.

created_at

integer UNIX timestamp at which the Customer Identifier was created.

{
  "id":"va_CaVE4QbyJvQRdk",
  "name":"Acme Corp",
  "entity":"virtual_account",
  "status":"active",
  "description":"Customer Identifier 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"
    }
  ],
  "allowed_payers": [
    {
      "type": "bank_account",
      "id":"ba_DlGmm9mSj8fjRM",
      "bank_account": {
        "ifsc": "UTIB0000013",
        "account_number": "914010012345679"
      }
    },
    {
      "type": "bank_account",
      "id":"ba_Cmtnm5tSj6agUW",
      "bank_account": {
        "ifsc": "UTIB0000014",
        "account_number": "914010012345680"
      }
    }
  ],
  "close_by": 1581615838,
  "closed_at": null,
  "created_at": 1577962694
}