Smart Collect Entity

Entity parameters and sample code for Smart Collect API.

The Smart Collect entity has the following parameters:

Entity

{
  "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"
    }
  ],
  "close_by": 1581615838,
  "closed_at": null,
  "created_at": 1577962694
}

id · 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. Know more about notes.

customer_id · string

Unique identifier of the customer the Customer Identifier is linked with. Know more about Customer API.

receivers · json object

Configuration of desired receivers for the Customer Identifier.

id · string

The unique identifier of the virtual bank account. Sample IDs for:

• Virtual bank account: ba_Di5gbQsGn0QSz3

entity · string

Name of the entity. Possible values are:

• bank_account

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, RBL Bank. 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 virtual bank account can be entered here. Know more about notes. This parameter appears in the response only when bank_account is passed as the receiver type.

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).

Watch Out!

• Any request beyond 2147483647 UNIX timestamp will fail.
• A Customer Identifier API that has not been used for 90 days will be automatically closed even if no close_by date has been set.

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.