Docs Logo

Linked Accounts

Create a Linked Account

Update a Linked Account

Fetch a Linked Account With ID

Create a Stakeholder Account

Update a Stakeholder Account

Request a Product Configuration

Update a Product Configuration

Fetch a Product Configuration

Docs Logo

API Test keys

Api

Payments

Route

Linked Account Onboarding

Update Product Config

API Test keys

Api

Payments

Route

Linked Account Onboarding

Update Product Config

Update a Product Configuration

PATCH
/v1/accounts/:account_id/products/:product_id

Click to copy

Use this endpoint to update a product configuration.

Is this page helpful?

Curl

1
curl -X PATCH https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \
2
-u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
3
-H "Content-Type: application/json" \
4
-d '{
5
   "settlements":{
6
      "account_number":"1234567890",
7
      "ifsc_code":"HDFC0000317",
8
      "beneficiary_name":"Gaurav Kumar"
9
   },
10
   "tnc_accepted":true
11
}'

Success

Failure

1
{
2
   "requested_configuration":[
3
      
4
   ],
5
   "active_configuration":{
6
      "settlements":{
7
         "account_number":"1234567890",
8
         "ifsc_code":"HDFC0000317",
9
         "beneficiary_name":"Gaurav Kumar"
10
      }
11
   },
12
   "requirements":[
13
      
14
   ],
15
   "tnc":{
16
      "id":"tnc_K1eopApuHyBE7D",
17
      "accepted":true,
18
      "accepted_at":1659638222
19
   },
20
   "id":"acc_prd_K1eopFF8G21tux",
21
   "product_name":"route",
22
   "activation_status":"activated",
23
   "account_id":"acc_K1em7bWYEiwmnc",
24
   "requested_at":1659638222
25
}
Path Parameters
account_id

*

string

The unique identifier of an account generated by Razorpay. For example, acc_HQVlm3bnPmccC0.

product_id

*

string

The unique identifier of a product generated by Razorpay. For example, acc_prd_HEgNpywUFctQ9e.

Request Parameters
settlements
object

The Settlement settings object.

Show child parameters (3)

tnc_accepted
boolean

This parameter is optional but needs to be added to accept terms and conditions. Possible value is only true.

Response Parameters
requested_configuration
object

The configuration of the product requested by the user that is yet to be set as active.

active_configuration
object

The configuration of the product that has been set as active.

Show child parameters (1)

requirements
object

The list of requirements to be enabled for this product or some of the configurations under this product.

Errors

Linked account does not exist.

Error Status: 400

This error occurs when the requester is not the parent of the child account, or the child account does not exist.

Solution

Merchant activation form has been locked for editing by admin.

Error Status: 400

This error occurs when the submitted extra fields are under the review stage.

Solution

Invalid IFSC Code.

Error Status: 400

This error occurs when the IFSC is invalid.

Solution

The account number must be between 5 and 20 characters.

Error Status: 400

This error occurs when the account number is less than 5 or more than 20 characters.

Solution

Update a Product Configuration

PATCH
/v1/accounts/:account_id/products/:product_id

Click to copy

Use this endpoint to update a product configuration.

Is this page helpful?

Path Parameters
account_id

*

string

The unique identifier of an account generated by Razorpay. For example, acc_HQVlm3bnPmccC0.

product_id

*

string

The unique identifier of a product generated by Razorpay. For example, acc_prd_HEgNpywUFctQ9e.

Request Parameters
settlements
object

The Settlement settings object.

Show child parameters (3)

tnc_accepted
boolean

This parameter is optional but needs to be added to accept terms and conditions. Possible value is only true.

Response Parameters
requested_configuration
object

The configuration of the product requested by the user that is yet to be set as active.

active_configuration
object

The configuration of the product that has been set as active.

Show child parameters (1)

requirements
object

The list of requirements to be enabled for this product or some of the configurations under this product.

Errors

Linked account does not exist.

Error Status: 400

This error occurs when the requester is not the parent of the child account, or the child account does not exist.

Solution

Merchant activation form has been locked for editing by admin.

Error Status: 400

This error occurs when the submitted extra fields are under the review stage.

Solution

Invalid IFSC Code.

Error Status: 400

This error occurs when the IFSC is invalid.

Solution

The account number must be between 5 and 20 characters.

Error Status: 400

This error occurs when the account number is less than 5 or more than 20 characters.

Solution

Curl

1
curl -X PATCH https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \
2
-u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
3
-H "Content-Type: application/json" \
4
-d '{
5
   "settlements":{
6
      "account_number":"1234567890",
7
      "ifsc_code":"HDFC0000317",
8
      "beneficiary_name":"Gaurav Kumar"
9
   },
10
   "tnc_accepted":true
11
}'

Success

Failure

1
{
2
   "requested_configuration":[
3
      
4
   ],
5
   "active_configuration":{
6
      "settlements":{
7
         "account_number":"1234567890",
8
         "ifsc_code":"HDFC0000317",
9
         "beneficiary_name":"Gaurav Kumar"
10
      }
11
   },
12
   "requirements":[
13
      
14
   ],
15
   "tnc":{
16
      "id":"tnc_K1eopApuHyBE7D",
17
      "accepted":true,
18
      "accepted_at":1659638222
19
   },
20
   "id":"acc_prd_K1eopFF8G21tux",
21
   "product_name":"route",
22
   "activation_status":"activated",
23
   "account_id":"acc_K1em7bWYEiwmnc",
24
   "requested_at":1659638222
25
}