API Test Keys

Update a Customer Identifier

POST

/v1/virtual_accounts/:id

Click to copy

Use this endpoint to update your Customer Identifier. You cannot update the expiry date of a Customer Identifier that has been closed.

Watch Out!

Smart Collect APIs are not available in Malaysia.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X PATCH https://api.razorpay.com/v1/virtual_accounts/va_KFIrkRmd70ylIg
3-H 'content-type: application/json'
4-d '{
5    "close_by": 1981615845,
6    "description": "VA creation for Raftar Soft",
7    "notes": {
8        "project_name": "Banking Software Work"
9    }
10}'

Success

Failure

1{
2  "id": "va_KFIrkRmd70ylIg",
3  "name": "Word Express",
4  "entity": "virtual_account",
5  "status": "active",
6  "description": "VA creation for Raftar Soft",
7  "amount_expected": null,
8  "notes": {
9    "project_name": "Banking Software Work"
10  },
11  "amount_paid": 0,
12  "customer_id": "cust_FY61BIF7OVJLRp",
13  "receivers": [
14    {
15      "id": "ba_KFIrkdawCUDC6n",
16      "entity": "bank_account",
17      "ifsc": "RAZR0000001",
18      "bank_name": null,
19      "name": "Word Express",
20      "notes": [],
21      "account_number": "1112220091736494"
22    }
23  ],
24  "close_by": 1981615845,
25  "closed_at": null,
26  "created_at": 1577969986
27}

Path Parameters

id

string

The unique identifier of the Customer Identifier which you want to update.

Request Parameters

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.
If a Customer Identifier API is not used for 90 days, it will automatically close even if no close_by date has been set.

description

string

A brief description of the Customer Identifier.

notes

json object

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

Notes section

to learn more.

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

close_by

integer

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.

Errors

Bank account Receiver already exists

Error Status: 400

If you have created a Customer Identifier with a receiver, for example, bank account, you cannot add another bank account receiver or replace it.

Solution

close by date should be atleast 15 min after current time

Error Status: 400

The epoch time passed is less than current time.

Solution

Update a Customer Identifier

POST

/v1/virtual_accounts/:id

Click to copy

Use this endpoint to update your Customer Identifier. You cannot update the expiry date of a Customer Identifier that has been closed.

Watch Out!

Smart Collect APIs are not available in Malaysia.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the Customer Identifier which you want to update.

Request Parameters

close_by

integer

Watch Out!

Any request beyond 2147483647 UNIX timestamp will fail.
If a Customer Identifier API is not used for 90 days, it will automatically close even if no close_by date has been set.

description

string

A brief description of the Customer Identifier.

notes

json object

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

Notes section

to learn more.

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

close_by

integer

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.

Errors

Bank account Receiver already exists

Error Status: 400

If you have created a Customer Identifier with a receiver, for example, bank account, you cannot add another bank account receiver or replace it.

Solution

close by date should be atleast 15 min after current time

Error Status: 400

The epoch time passed is less than current time.

Solution

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X PATCH https://api.razorpay.com/v1/virtual_accounts/va_KFIrkRmd70ylIg
3-H 'content-type: application/json'
4-d '{
5    "close_by": 1981615845,
6    "description": "VA creation for Raftar Soft",
7    "notes": {
8        "project_name": "Banking Software Work"
9    }
10}'

Success

Failure

1{
2  "id": "va_KFIrkRmd70ylIg",
3  "name": "Word Express",
4  "entity": "virtual_account",
5  "status": "active",
6  "description": "VA creation for Raftar Soft",
7  "amount_expected": null,
8  "notes": {
9    "project_name": "Banking Software Work"
10  },
11  "amount_paid": 0,
12  "customer_id": "cust_FY61BIF7OVJLRp",
13  "receivers": [
14    {
15      "id": "ba_KFIrkdawCUDC6n",
16      "entity": "bank_account",
17      "ifsc": "RAZR0000001",
18      "bank_name": null,
19      "name": "Word Express",
20      "notes": [],
21      "account_number": "1112220091736494"
22    }
23  ],
24  "close_by": 1981615845,
25  "closed_at": null,
26  "created_at": 1577969986
27}