API Test Keys

Activate or Deactivate a Fund Account

PATCH

/v1/fund_accounts/:id

Click to copy

Use this endpoint to activate or deactivate a fund account. This helps you block payouts to certain fund accounts, as and when required.

Is this page helpful?

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X PATCH https://api.razorpay.com/v1/fund_accounts/fa_00000000000001 \
3-H "Content-Type: application/json" \
4-d '{
5      "active": false
6    }'

Success

1{
2  "id": "fa_00000000000001",
3  "entity": "fund_account",
4  "contact_id": "cont_00000000000001",
5  "account_type": "bank_account",
6  "bank_account": {
7    "ifsc": "HDFC0000053",
8    "bank_name": "HDFC Bank",
9    "name": "Gaurav Kumar",
10    "account_number": "765432123456789"
11  },
12  "active": false,
13  "batch_id": null,
14  "created_at": 1545312598
15}

Path Parameters

id

string

The unique identifier linked to the fund account. For example, fa_00000000000001.

Request Parameters

active

boolean

The state to which you want to move the fund account. Possible values:

true (default): active
false: inactive
Pass false to deactivate an account and pass true to activate an account.

Response Parameters

id

string

The unique identifier linked to the fund account validation. For example, fav_0000000001.

entity

string

Here it is fund_account.validation.

status

string

The status of the account validation transaction. Possible values:

created
completed
failed

validation_results

object

Details extracted from the results of the fund account validation.

Show child parameters (4)

validated_account_type

string

Here it is bank_account.

Show child parameters (1)

status_details

object

Status of the fund account validation.

Show child parameters (3)

reference_id

string

Unique reference_id generated for the validation transaction.

fund_account

object

The details of the fund account which was validated.

Show child parameters (3)

vpa

object

The details associated with the account holder's virtual payment address.

Show child parameters (1)

active

boolean

Possible values of fund account status:

true: active
false: inactive

created_at

integer

Timestamp, in unix, when the fund account was created. For example, 1543650891.

contact

object

The contact's details.

Show child parameters (8)

Errors

<fund account id> is not a valid id.

Error Status: 4xx

The fund account ID entered is invalid.

Solution

Activate or Deactivate a Fund Account

PATCH

/v1/fund_accounts/:id

Click to copy

Use this endpoint to activate or deactivate a fund account. This helps you block payouts to certain fund accounts, as and when required.

Is this page helpful?

Path Parameters

id

string

The unique identifier linked to the fund account. For example, fa_00000000000001.

Request Parameters

active

boolean

The state to which you want to move the fund account. Possible values:

true (default): active
false: inactive
Pass false to deactivate an account and pass true to activate an account.

Response Parameters

id

string

The unique identifier linked to the fund account validation. For example, fav_0000000001.

entity

string

Here it is fund_account.validation.

status

string

The status of the account validation transaction. Possible values:

created
completed
failed

validation_results

object

Details extracted from the results of the fund account validation.

Show child parameters (4)

validated_account_type

string

Here it is bank_account.

Show child parameters (1)

status_details

object

Status of the fund account validation.

Show child parameters (3)

reference_id

string

Unique reference_id generated for the validation transaction.

fund_account

object

The details of the fund account which was validated.

Show child parameters (3)

vpa

object

The details associated with the account holder's virtual payment address.

Show child parameters (1)

active

boolean

Possible values of fund account status:

true: active
false: inactive

created_at

integer

Timestamp, in unix, when the fund account was created. For example, 1543650891.

contact

object

The contact's details.

Show child parameters (8)

Errors

<fund account id> is not a valid id.

Error Status: 4xx

The fund account ID entered is invalid.

Solution

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X PATCH https://api.razorpay.com/v1/fund_accounts/fa_00000000000001 \
3-H "Content-Type: application/json" \
4-d '{
5      "active": false
6    }'

Success

1{
2  "id": "fa_00000000000001",
3  "entity": "fund_account",
4  "contact_id": "cont_00000000000001",
5  "account_type": "bank_account",
6  "bank_account": {
7    "ifsc": "HDFC0000053",
8    "bank_name": "HDFC Bank",
9    "name": "Gaurav Kumar",
10    "account_number": "765432123456789"
11  },
12  "active": false,
13  "batch_id": null,
14  "created_at": 1545312598
15}