Docs Logo

Product Configuration

Request a Product Configuration

Fetch a Product Configuration

Update Settlement Account Details

Request Payment Methods

Docs Logo

API Test keys

Api

Partners

Product Configuration

Update

Update Settlement Account Details

API Test keys

Api

Partners

Product Configuration

Update

Update Settlement Account Details

Update Settlement Account Details

PATCH
/v2/accounts/:account_id/products/:product_id

Click to copy

Use this endpoint to update a product's configuration. Update settlement account details and request for Payment Gateway and Payment Links products. In this sample, the payment methods object has not been used. Know about the

various error responses

for this API.


Check the

use cases

and

updates permitted for different product activation statuses

before using this API.

Watch Out!

Currently, we do not support making concurrent requests to the following Onboarding APIs including their combination on the same account_id:

Please wait for the response of these APIs before making subsequent requests.

Is this page helpful?

Curl

change language

change language

1
curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2
-X PATCH https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \
3
-d '{
4
  "notifications": {
5
    "email": [
6
      "gaurav.kumar@example.com",
7
      "acd@gmail.com"
8
    ]
9
  },
10
  "checkout": {
11
    "theme_color": "#528FFF"
12
  },
13
  "refund": {
14
    "default_refund_speed": "optimum"
15
  },
16
  "settlements": {
17
    "account_number": "1234567890",
18
    "ifsc_code": "HDFC0000317",
19
    "beneficiary_name": "Gaurav Kumar"
20
  },
21
  "tnc_accepted": true,
22
  "ip": "233.233.233.234"
23
}'

PL Success

PG Success

1
{
2
  "requested_configuration": [],
3
  "active_configuration": {
4
    "payment_capture": {
5
      "mode": "automatic",
6
      "refund_speed": "normal",
7
      "automatic_expiry_period": 7200
8
    },
9
    "settlements": {
10
      "account_number": "1234567890",
11
      "ifsc_code": "HDFC0000317",
12
      "beneficiary_name": "Gaurav Kumar"
13
    },
14
    "checkout": {
15
      "theme_color": "#528FFF",
16
      "flash_checkout": true
17
    },
18
    "refund": {
19
      "default_refund_speed": "optimum"
20
    },
21
    "notifications": {
22
      "whatsapp": true,
23
      "sms": false,
24
      "email": [
25
        "gaurav.kumar@example.com",
26
        "acd@gmail.com"
27
      ]
28
    }
29
  },
30
  "requirements": [
31
    {
32
      "field_reference": "individual_proof_of_address",
33
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders/sth_HVChECMdCsVR9D/documents",
34
      "status": "required",
35
      "reason_code": "document_missing"
36
    },
37
    {
38
      "field_reference": "individual_proof_of_identification",
39
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders/sth_HVChECMdCsVR9D/documents",
40
      "status": "required",
41
      "reason_code": "document_missing"
42
    },
43
    {
44
      "field_reference": "business_proof_of_identification",
45
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/documents",
46
      "status": "required",
47
      "reason_code": "document_missing"
48
    },
49
    {
50
      "field_reference": "contact_name",
51
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
52
      "status": "required",
53
      "reason_code": "field_missing"
54
    },
55
    {
56
      "field_reference": "customer_facing_business_name",
57
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
58
      "status": "required",
59
      "reason_code": "field_missing"
60
    },
61
    {
62
      "field_reference": "profile.address.operation.street1",
63
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
64
      "status": "required",
65
      "reason_code": "field_missing"
66
    },
67
    {
68
      "field_reference": "profile.address.operation.city",
69
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
70
      "status": "required",
71
      "reason_code": "field_missing"
72
    },
73
    {
74
      "field_reference": "profile.address.operation.postal_code",
75
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
76
      "status": "required",
77
      "reason_code": "field_missing"
78
    },
79
    {
80
      "field_reference": "profile.address.operation.state",
81
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
82
      "status": "required",
83
      "reason_code": "field_missing"
84
    }
85
  ],
86
  "tnc":{
87
    "id": "tnc_IgohZaDBHRGjPa",
88
    "accepted": true,
89
    "accepted_at": 1641550798
90
  },
91
  "id": "acc_prd_HEgNpywUFctQ9f",
92
  "account_id": "acc_HQVlm3bnPmccC0",
93
  "product_name": "payment_links",
94
  "activation_status": "needs_clarification",
95
  "requested_at": 1625478849
96
}
Path Parameters
account_id

*

string

The unique identifier of a sub-merchant account generated by Razorpay. For example, acc_HQVlm3bnPmccC0.

id

*

string

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

Request Parameters
notifications
object

This denotes the notifications settings.

Show child parameters (3)

checkout
object

The checkout form of the payment capture.

Show child parameters (3)

refund
object

This denotes the payment refund settings.

Show child parameters (1)

settlements
object

The Settlement settings object.

Show child parameters (3)

tnc_accepted
boolean

Pass this parameter to accept terms and conditions. Send this parameter along with the ip parameter when the tnc is accepted. Possible value:

  • true

ip
string

The IP address of the merchant while accepting the terms and conditions. Send this parameter along with the tnc_accepted parameter when the tnc is accepted.

payment_methods
object

Details of the payment method you want to enable for the product.

Show child parameters (6)

Response Parameters
id
string

The unique identifier of a product generated by Razorpay for a sub-merchant account. This id is used to fetch or update a product.

product_name
string

The product(s) to be configured. Possible values:

  • payment_gateway
  • payment_links

tnc
object

It consists of the configuration for the accepted terms and conditions by the merchant for the requested product. If the terms and conditions are accepted by the user for the requested product, it would consist of the following fields:

Show child parameters (3)

activation_status
string

The status of the

product activation

.
  • requested
  • needs_clarification
  • under_review
  • activated
  • suspended

active_configuration
object

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

Show child parameters (6)

requested_configuration
object

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

requirements
object

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

Show child parameters (5)

requested_at
integer

The Unix timestamp at which the product configuration is requested.

Update Settlement Account Details

PATCH
/v2/accounts/:account_id/products/:product_id

Click to copy

Use this endpoint to update a product's configuration. Update settlement account details and request for Payment Gateway and Payment Links products. In this sample, the payment methods object has not been used. Know about the

various error responses

for this API.


Check the

use cases

and

updates permitted for different product activation statuses

before using this API.

Watch Out!

Currently, we do not support making concurrent requests to the following Onboarding APIs including their combination on the same account_id:

Please wait for the response of these APIs before making subsequent requests.

Is this page helpful?

Path Parameters
account_id

*

string

The unique identifier of a sub-merchant account generated by Razorpay. For example, acc_HQVlm3bnPmccC0.

id

*

string

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

Request Parameters
notifications
object

This denotes the notifications settings.

Show child parameters (3)

checkout
object

The checkout form of the payment capture.

Show child parameters (3)

refund
object

This denotes the payment refund settings.

Show child parameters (1)

settlements
object

The Settlement settings object.

Show child parameters (3)

tnc_accepted
boolean

Pass this parameter to accept terms and conditions. Send this parameter along with the ip parameter when the tnc is accepted. Possible value:

  • true

ip
string

The IP address of the merchant while accepting the terms and conditions. Send this parameter along with the tnc_accepted parameter when the tnc is accepted.

payment_methods
object

Details of the payment method you want to enable for the product.

Show child parameters (6)

Response Parameters
id
string

The unique identifier of a product generated by Razorpay for a sub-merchant account. This id is used to fetch or update a product.

product_name
string

The product(s) to be configured. Possible values:

  • payment_gateway
  • payment_links

tnc
object

It consists of the configuration for the accepted terms and conditions by the merchant for the requested product. If the terms and conditions are accepted by the user for the requested product, it would consist of the following fields:

Show child parameters (3)

activation_status
string

The status of the

product activation

.
  • requested
  • needs_clarification
  • under_review
  • activated
  • suspended

active_configuration
object

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

Show child parameters (6)

requested_configuration
object

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

requirements
object

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

Show child parameters (5)

requested_at
integer

The Unix timestamp at which the product configuration is requested.

Curl

change language

change language

1
curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2
-X PATCH https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \
3
-d '{
4
  "notifications": {
5
    "email": [
6
      "gaurav.kumar@example.com",
7
      "acd@gmail.com"
8
    ]
9
  },
10
  "checkout": {
11
    "theme_color": "#528FFF"
12
  },
13
  "refund": {
14
    "default_refund_speed": "optimum"
15
  },
16
  "settlements": {
17
    "account_number": "1234567890",
18
    "ifsc_code": "HDFC0000317",
19
    "beneficiary_name": "Gaurav Kumar"
20
  },
21
  "tnc_accepted": true,
22
  "ip": "233.233.233.234"
23
}'

PL Success

PG Success

1
{
2
  "requested_configuration": [],
3
  "active_configuration": {
4
    "payment_capture": {
5
      "mode": "automatic",
6
      "refund_speed": "normal",
7
      "automatic_expiry_period": 7200
8
    },
9
    "settlements": {
10
      "account_number": "1234567890",
11
      "ifsc_code": "HDFC0000317",
12
      "beneficiary_name": "Gaurav Kumar"
13
    },
14
    "checkout": {
15
      "theme_color": "#528FFF",
16
      "flash_checkout": true
17
    },
18
    "refund": {
19
      "default_refund_speed": "optimum"
20
    },
21
    "notifications": {
22
      "whatsapp": true,
23
      "sms": false,
24
      "email": [
25
        "gaurav.kumar@example.com",
26
        "acd@gmail.com"
27
      ]
28
    }
29
  },
30
  "requirements": [
31
    {
32
      "field_reference": "individual_proof_of_address",
33
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders/sth_HVChECMdCsVR9D/documents",
34
      "status": "required",
35
      "reason_code": "document_missing"
36
    },
37
    {
38
      "field_reference": "individual_proof_of_identification",
39
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders/sth_HVChECMdCsVR9D/documents",
40
      "status": "required",
41
      "reason_code": "document_missing"
42
    },
43
    {
44
      "field_reference": "business_proof_of_identification",
45
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/documents",
46
      "status": "required",
47
      "reason_code": "document_missing"
48
    },
49
    {
50
      "field_reference": "contact_name",
51
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
52
      "status": "required",
53
      "reason_code": "field_missing"
54
    },
55
    {
56
      "field_reference": "customer_facing_business_name",
57
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
58
      "status": "required",
59
      "reason_code": "field_missing"
60
    },
61
    {
62
      "field_reference": "profile.address.operation.street1",
63
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
64
      "status": "required",
65
      "reason_code": "field_missing"
66
    },
67
    {
68
      "field_reference": "profile.address.operation.city",
69
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
70
      "status": "required",
71
      "reason_code": "field_missing"
72
    },
73
    {
74
      "field_reference": "profile.address.operation.postal_code",
75
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
76
      "status": "required",
77
      "reason_code": "field_missing"
78
    },
79
    {
80
      "field_reference": "profile.address.operation.state",
81
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
82
      "status": "required",
83
      "reason_code": "field_missing"
84
    }
85
  ],
86
  "tnc":{
87
    "id": "tnc_IgohZaDBHRGjPa",
88
    "accepted": true,
89
    "accepted_at": 1641550798
90
  },
91
  "id": "acc_prd_HEgNpywUFctQ9f",
92
  "account_id": "acc_HQVlm3bnPmccC0",
93
  "product_name": "payment_links",
94
  "activation_status": "needs_clarification",
95
  "requested_at": 1625478849
96
}