API Test Keys

Add VPA Receiver to an Existing Customer Identifier

POST

/v1/virtual_accounts/:id/receivers

Click to copy

Use this endpoint to add a VPA receiver to an existing Customer Identifier.

If you have created a Customer Identifier with only a VPA receiver, you cannot replace or update it.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X POST https://api.razorpay.com/v1/virtual_accounts/va_DzcFjMezDcN8vv/receivers
3-H 'content-type: application/json'
4-d '{
5  "types": [
6    "vpa"
7  ],
8  "vpa": {
9    "descriptor": "gaurikumari"
10  }
11}'

Success

1{
2  "id": "va_DzcFjMezDcN8vv",
3  "name": "Acme Corp",
4  "entity": "virtual_account",
5  "status": "active",
6  "description": "",
7  "amount_expected": null,
8  "notes": [],
9  "amount_paid": 0,
10  "customer_id": "cust_DzbSeP2RJD1ZHg",
11  "receivers": [
12    {
13      "id": "ba_DzcFjVqAMSCEIW",
14      "entity": "bank_account",
15      "ifsc":"RATN0VAAPIS",
16      "bank_name": "RBL Bank",
17      "name": "Acme Corp",
18      "notes": [],
19      "account_number": "2223333232194699"
20    },
21    {
22      "id": "vpa_DzcZR5ofjCUKAx",
23      "entity": "vpa",
24      "username": "rpy.payto00000gaurikumari",
25      "handle": "icici",
26      "address": "rpy.payto00000gaurikumari@icici"
27    }
28  ],
29  "close_by": null,
30  "closed_at": null,
31  "created_at": 1577969986
32}

Path Parameters

id

string

The unique identifier of the Customer Identifier to which another receiver type is to be added.

Request Parameters

types

array

The receiver type to be added to the Customer Identifier. Possible values are:

bank_account
vpa

vpa

json object

Descriptor details for the virtual UPI ID. This is to be passed only when vpa is passed as the receiver types.

Show child parameters (1)

Response Parameters

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.

Show child parameters (10)

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.

Add VPA Receiver to an Existing Customer Identifier

POST

/v1/virtual_accounts/:id/receivers

Click to copy

Use this endpoint to add a VPA receiver to an existing Customer Identifier.

If you have created a Customer Identifier with only a VPA receiver, you cannot replace or update it.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the Customer Identifier to which another receiver type is to be added.

Request Parameters

types

array

The receiver type to be added to the Customer Identifier. Possible values are:

bank_account
vpa

vpa

json object

Descriptor details for the virtual UPI ID. This is to be passed only when vpa is passed as the receiver types.

Show child parameters (1)

Response Parameters

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.

Show child parameters (10)

close_by

integer

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.

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X POST https://api.razorpay.com/v1/virtual_accounts/va_DzcFjMezDcN8vv/receivers
3-H 'content-type: application/json'
4-d '{
5  "types": [
6    "vpa"
7  ],
8  "vpa": {
9    "descriptor": "gaurikumari"
10  }
11}'

Success

1{
2  "id": "va_DzcFjMezDcN8vv",
3  "name": "Acme Corp",
4  "entity": "virtual_account",
5  "status": "active",
6  "description": "",
7  "amount_expected": null,
8  "notes": [],
9  "amount_paid": 0,
10  "customer_id": "cust_DzbSeP2RJD1ZHg",
11  "receivers": [
12    {
13      "id": "ba_DzcFjVqAMSCEIW",
14      "entity": "bank_account",
15      "ifsc":"RATN0VAAPIS",
16      "bank_name": "RBL Bank",
17      "name": "Acme Corp",
18      "notes": [],
19      "account_number": "2223333232194699"
20    },
21    {
22      "id": "vpa_DzcZR5ofjCUKAx",
23      "entity": "vpa",
24      "username": "rpy.payto00000gaurikumari",
25      "handle": "icici",
26      "address": "rpy.payto00000gaurikumari@icici"
27    }
28  ],
29  "close_by": null,
30  "closed_at": null,
31  "created_at": 1577969986
32}