API Test Keys

Product Configuration Entity

The Product Configuration entity has the following parameters.

Is this page helpful?

Entity

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      "field_reference":"settlements.account_number",
15      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
16      "reason_code":"field_missing",
17      "status":"required"
18    },
19    {
20      "field_reference":"settlements.ifsc",
21      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
22      "reason_code":"field_missing",
23      "status":"required"
24    },
25    {
26      "field_reference":"kyc.pan",
27      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
28      "reason_code":"kyc_failed",
29      "status":"required"
30    },
31    {
32      "field_reference":"settlements.beneficiary_name",
33      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
34      "reason_code":"field_missing",
35      "status":"required"
36    }
37  ],
38  "tnc":{
39    "id":"tnc_IgohZaDBHRGjPv",
40    "accepted":true,
41    "accepted_at":1641550798
42  },
43  "id":"acc_prd_HEgNpywUFctQ9e",
44  "account_id":"acc_HQVlm3bnPmccC0",
45  "product_name":"route",
46  "activation_status":"needs_clarification",
47  "requested_at":1605181524
48}

id

string

The unique identifier of a product generated by Razorpay. This id is used to fetch or update a product.

product_name

string

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

Route

tnc_accepted

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 following fields:

Show child parameters (3)

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.

Show child parameters (4)

id

string

The unique identifier of the account generated by Razorpay. For example, acc_prd_K1eopFF8G21tux. The product is created for this account id.

account_id

string

The unique identifier generated by Razorpay. For example, acc_K1em7bWYEiwmnc.

product_name

string

The product(s) to be configured. Here it is route.

activation_status

string

The status of the product activation.

requested
needs_clarification
under_review
activated
suspended

requested_at

integer

The Unix timestamp at which the product configuration has been requested.

Product Configuration Entity

The Product Configuration entity has the following parameters.

Is this page helpful?

id

string

The unique identifier of a product generated by Razorpay. This id is used to fetch or update a product.

product_name

string

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

Route

tnc_accepted

object

Show child parameters (3)

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.

Show child parameters (4)

id

string

The unique identifier of the account generated by Razorpay. For example, acc_prd_K1eopFF8G21tux. The product is created for this account id.

account_id

string

The unique identifier generated by Razorpay. For example, acc_K1em7bWYEiwmnc.

product_name

string

The product(s) to be configured. Here it is route.

activation_status

string

The status of the product activation.

requested
needs_clarification
under_review
activated
suspended

requested_at

integer

The Unix timestamp at which the product configuration has been requested.

Entity

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      "field_reference":"settlements.account_number",
15      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
16      "reason_code":"field_missing",
17      "status":"required"
18    },
19    {
20      "field_reference":"settlements.ifsc",
21      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
22      "reason_code":"field_missing",
23      "status":"required"
24    },
25    {
26      "field_reference":"kyc.pan",
27      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
28      "reason_code":"kyc_failed",
29      "status":"required"
30    },
31    {
32      "field_reference":"settlements.beneficiary_name",
33      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
34      "reason_code":"field_missing",
35      "status":"required"
36    }
37  ],
38  "tnc":{
39    "id":"tnc_IgohZaDBHRGjPv",
40    "accepted":true,
41    "accepted_at":1641550798
42  },
43  "id":"acc_prd_HEgNpywUFctQ9e",
44  "account_id":"acc_HQVlm3bnPmccC0",
45  "product_name":"route",
46  "activation_status":"needs_clarification",
47  "requested_at":1605181524
48}