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

Fetch Product Config

API Test keys

Api

Payments

Route

Linked Account Onboarding

Fetch Product Config

Fetch a Product Configuration

GET
/v1/accounts/:account_id/products/:product_id

Click to copy

Use this endpoint to fetch a product configuration.

Is this page helpful?

Curl

1
curl -X GET 'https://api.razorpay.com/v1/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/' \
2
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \

Success

Failure

1
{
2
   "requested_configuration":[
3
      
4
   ],
5
   "active_configuration":{
6
      "settlements":{
7
         "account_number":null,
8
         "ifsc_code":null,
9
         "beneficiary_name":null
10
      }
11
   },
12
   "requirements":[
13
      {
14
         "field_reference":"settlements.beneficiary_name",
15
         "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
16
         "reason_code":"field_missing",
17
         "status":"required"
18
      },
19
      {
20
         "field_reference":"settlements.account_number",
21
         "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
22
         "reason_code":"field_missing",
23
         "status":"required"
24
      },
25
      {
26
         "field_reference":"settlements.ifsc_code",
27
         "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
28
         "reason_code":"field_missing",
29
         "status":"required"
30
      }
31
   ],
32
   "tnc":{
33
      "id":"tnc_K1eopApuHyBE7D",
34
      "accepted":true,
35
      "accepted_at":1659638222
36
   },
37
   "id":"acc_prd_HEgNpywUFctQ9e",
38
   "product_name":"route",
39
   "activation_status":"needs_clarification",
40
   "account_id":"acc_HQVlm3bnPmccC0",
41
   "requested_at":1659638222
42
}
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.

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

The provided product config id doesn't exist for the merchant.

Error Status: 400

This error occurs when the provided product configuration does not belong to the Linked Account.

Solution

Fetch a Product Configuration

GET
/v1/accounts/:account_id/products/:product_id

Click to copy

Use this endpoint to fetch 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.

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

The provided product config id doesn't exist for the merchant.

Error Status: 400

This error occurs when the provided product configuration does not belong to the Linked Account.

Solution

Curl

1
curl -X GET 'https://api.razorpay.com/v1/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/' \
2
     -u [YOUR_KEY_ID]:[YOUR_SECRET] \

Success

Failure

1
{
2
   "requested_configuration":[
3
      
4
   ],
5
   "active_configuration":{
6
      "settlements":{
7
         "account_number":null,
8
         "ifsc_code":null,
9
         "beneficiary_name":null
10
      }
11
   },
12
   "requirements":[
13
      {
14
         "field_reference":"settlements.beneficiary_name",
15
         "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
16
         "reason_code":"field_missing",
17
         "status":"required"
18
      },
19
      {
20
         "field_reference":"settlements.account_number",
21
         "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
22
         "reason_code":"field_missing",
23
         "status":"required"
24
      },
25
      {
26
         "field_reference":"settlements.ifsc_code",
27
         "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
28
         "reason_code":"field_missing",
29
         "status":"required"
30
      }
31
   ],
32
   "tnc":{
33
      "id":"tnc_K1eopApuHyBE7D",
34
      "accepted":true,
35
      "accepted_at":1659638222
36
   },
37
   "id":"acc_prd_HEgNpywUFctQ9e",
38
   "product_name":"route",
39
   "activation_status":"needs_clarification",
40
   "account_id":"acc_HQVlm3bnPmccC0",
41
   "requested_at":1659638222
42
}