Fetch a Product Configuration

GET

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

Click to copy

Use this endpoint to retrieve the details of a product for a given sub-merchant's account. Know about the

various error responses

for this API.

Is this page helpful?

Curl

change language

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2- X GET https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \

PL Success

PG Success

1{
2  "requested_configuration": {
3    "payment_methods": []
4  },
5  "active_configuration": {
6    "payment_capture": {
7      "mode": "automatic",
8      "refund_speed": "normal",
9      "automatic_expiry_period": 7200
10    },
11    "settlements": {
12      "account_number": null,
13      "ifsc_code": null,
14      "beneficiary_name": null
15    },
16    "checkout": {
17      "theme_color": "#FFFFFF",
18      "flash_checkout": true
19    },
20    "refund": {
21      "default_refund_speed": "normal"
22    },
23    "notifications": {
24      "whatsapp": true,
25      "sms": false,
26      "email": [
27        "b963e252-1201-45b0-9c39-c53eceb0cfd6_load@gmail.com"
28      ]
29    },
30    "payment_methods": {
31      "netbanking": {
32        "enabled": true,
33        "instrument": [
34          {
35            "type": "retail",
36            "bank": [
37              "hdfc",
38              "sbin",
39              "utib",
40              "icic",
41              "scbl",
42              "yesb"
43            ]
44          }
45        ]
46      },
47      "wallet": {
48        "enabled": true,
49        "instrument": [
50          "airtelmoney",
51          "freecharge",
52          "jiomoney",
53          "olamoney",
54          "payzapp",
55          "mobikwik"
56        ]
57      },
58      "upi": {
59        "enabled": true,
60        "instrument": [
61          "upi"
62        ]
63      }
64    }
65  },
66  "requirements": [
67    {
68      "field_reference": "individual_proof_of_address",
69      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders/{stakeholderId}/documents",
70      "status": "required",
71      "reason_code": "document_missing"
72    },
73    {
74      "field_reference": "individual_proof_of_identification",
75      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders/{stakeholderId}/documents",
76      "status": "required",
77      "reason_code": "document_missing"
78    },
79    {
80      "field_reference": "business_proof_of_identification",
81      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/documents",
82      "status": "required",
83      "reason_code": "document_missing"
84    },
85    {
86      "field_reference": "settlements.beneficiary_name",
87      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
88      "status": "required",
89      "reason_code": "field_missing"
90    },
91    {
92      "field_reference": "settlements.account_number",
93      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
94      "status": "required",
95      "reason_code": "field_missing"
96    },
97    {
98      "field_reference": "settlements.ifsc_code",
99      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
100      "status": "required",
101      "reason_code": "field_missing"
102    },
103    {
104      "field_reference": "contact_name",
105      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
106      "status": "required",
107      "reason_code": "field_missing"
108    },
109    {
110      "field_reference": "name",
111      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders",
112      "status": "required",
113      "reason_code": "field_missing"
114    },
115    {
116      "field_reference": "customer_facing_business_name",
117      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
118      "status": "required",
119      "reason_code": "field_missing"
120    },
121    {
122      "field_reference": "kyc.pan",
123      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders",
124      "status": "required",
125      "reason_code": "field_missing"
126    }
127  ],
128  "tnc":{
129    "id": "tnc_IgohZaDBHRGjPv",
130    "accepted": true,
131    "accepted_at": 1641550798
132  },
133  "id": "acc_prd_HEgNpywUFctQ9f",
134  "account_id": "acc_HQVlm3bnPmccC0",
135  "product_name": "payment_links",
136  "activation_status": "needs_clarification",
137  "requested_at": 1625478849
138}

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.

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

configuration

object

The following are the possible configurations:

Show child parameters (6)

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.

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.

Fetch a Product Configuration

GET

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

Click to copy

Use this endpoint to retrieve the details of a product for a given sub-merchant's account. Know about the

various error responses

for this API.

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.

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

Show child parameters (3)

activation_status

string

The status of the

product activation

requested
needs_clarification
under_review
activated
suspended

configuration

object

The following are the possible configurations:

Show child parameters (6)

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.

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

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2- X GET https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \

PL Success

PG Success

1{
2  "requested_configuration": {
3    "payment_methods": []
4  },
5  "active_configuration": {
6    "payment_capture": {
7      "mode": "automatic",
8      "refund_speed": "normal",
9      "automatic_expiry_period": 7200
10    },
11    "settlements": {
12      "account_number": null,
13      "ifsc_code": null,
14      "beneficiary_name": null
15    },
16    "checkout": {
17      "theme_color": "#FFFFFF",
18      "flash_checkout": true
19    },
20    "refund": {
21      "default_refund_speed": "normal"
22    },
23    "notifications": {
24      "whatsapp": true,
25      "sms": false,
26      "email": [
27        "b963e252-1201-45b0-9c39-c53eceb0cfd6_load@gmail.com"
28      ]
29    },
30    "payment_methods": {
31      "netbanking": {
32        "enabled": true,
33        "instrument": [
34          {
35            "type": "retail",
36            "bank": [
37              "hdfc",
38              "sbin",
39              "utib",
40              "icic",
41              "scbl",
42              "yesb"
43            ]
44          }
45        ]
46      },
47      "wallet": {
48        "enabled": true,
49        "instrument": [
50          "airtelmoney",
51          "freecharge",
52          "jiomoney",
53          "olamoney",
54          "payzapp",
55          "mobikwik"
56        ]
57      },
58      "upi": {
59        "enabled": true,
60        "instrument": [
61          "upi"
62        ]
63      }
64    }
65  },
66  "requirements": [
67    {
68      "field_reference": "individual_proof_of_address",
69      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders/{stakeholderId}/documents",
70      "status": "required",
71      "reason_code": "document_missing"
72    },
73    {
74      "field_reference": "individual_proof_of_identification",
75      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders/{stakeholderId}/documents",
76      "status": "required",
77      "reason_code": "document_missing"
78    },
79    {
80      "field_reference": "business_proof_of_identification",
81      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/documents",
82      "status": "required",
83      "reason_code": "document_missing"
84    },
85    {
86      "field_reference": "settlements.beneficiary_name",
87      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
88      "status": "required",
89      "reason_code": "field_missing"
90    },
91    {
92      "field_reference": "settlements.account_number",
93      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
94      "status": "required",
95      "reason_code": "field_missing"
96    },
97    {
98      "field_reference": "settlements.ifsc_code",
99      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
100      "status": "required",
101      "reason_code": "field_missing"
102    },
103    {
104      "field_reference": "contact_name",
105      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
106      "status": "required",
107      "reason_code": "field_missing"
108    },
109    {
110      "field_reference": "name",
111      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders",
112      "status": "required",
113      "reason_code": "field_missing"
114    },
115    {
116      "field_reference": "customer_facing_business_name",
117      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0",
118      "status": "required",
119      "reason_code": "field_missing"
120    },
121    {
122      "field_reference": "kyc.pan",
123      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/stakeholders",
124      "status": "required",
125      "reason_code": "field_missing"
126    }
127  ],
128  "tnc":{
129    "id": "tnc_IgohZaDBHRGjPv",
130    "accepted": true,
131    "accepted_at": 1641550798
132  },
133  "id": "acc_prd_HEgNpywUFctQ9f",
134  "account_id": "acc_HQVlm3bnPmccC0",
135  "product_name": "payment_links",
136  "activation_status": "needs_clarification",
137  "requested_at": 1625478849
138}