API Test Keys

Product Configuration Entity

The Product Configuration entity has the following parameters:

Is this page helpful?

PG Entity

PL Entity

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      "logo": "https://example.com/your_logo"
18    },
19    "refund": {
20      "default_refund_speed": "optimum"
21    },
22    "notifications": {
23      "whatsapp": false,
24      "sms": false,
25      "email": [
26        "gaurav.kumar@example.com",
27        "acd@example.com"
28      ]
29    }
30  },
31  "requirements": [
32    {
33      "field_reference": "settlements.account_number",
34      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
35      "reason_code": "field_missing",
36      "status": "required"
37    },
38    {
39      "field_reference": "settlements.ifsc",
40      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
41      "reason_code": "field_missing",
42      "status": "required"
43    },
44    {
45      "field_reference": "settlements.beneficiary_name",
46      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
47      "reason_code": "field_missing",
48      "status": "required"
49    }
50  ],
51  "tnc":{
52    "id": "tnc_IgohZaDBHRGjPv",
53    "accepted": true,
54    "accepted_at": 1641550798
55  },
56  "id": "acc_prd_HEgNpywUFctQ9e",
57  "account_id": "acc_HQVlm3bnPmccC0",
58  "product_name": "payment_gateway",
59  "activation_status": "needs_clarification",
60  "requested_at": 1605181524
61}

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. It is classified into two types:

Required document: field_reference: "proof_type.document_type". For example: business_proof_of_identification.business_pan_url. The sub-merchant needs to upload the business_pan_url document to get the requirement fulfilled.
Selected required document: field_reference : "proof_type". For example: individual_proof_of_address. The sub-merchant can upload ONE of the following groups, that is, submit [aadhar_front ,aadhar_back] or [voter_id_front, voter_id_back] or [passport_front, passport_back]. Once all the documents of any ONE of the groups are uploaded, the requirement gets fulfilled.

Show child parameters (5)

requested_at

integer

The Unix timestamp at which the product configuration is 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 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. It is classified into two types:

Required document: field_reference: "proof_type.document_type". For example: business_proof_of_identification.business_pan_url. The sub-merchant needs to upload the business_pan_url document to get the requirement fulfilled.
Selected required document: field_reference : "proof_type". For example: individual_proof_of_address. The sub-merchant can upload ONE of the following groups, that is, submit [aadhar_front ,aadhar_back] or [voter_id_front, voter_id_back] or [passport_front, passport_back]. Once all the documents of any ONE of the groups are uploaded, the requirement gets fulfilled.

Show child parameters (5)

requested_at

integer

The Unix timestamp at which the product configuration is requested.

PG Entity

PL Entity

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      "logo": "https://example.com/your_logo"
18    },
19    "refund": {
20      "default_refund_speed": "optimum"
21    },
22    "notifications": {
23      "whatsapp": false,
24      "sms": false,
25      "email": [
26        "gaurav.kumar@example.com",
27        "acd@example.com"
28      ]
29    }
30  },
31  "requirements": [
32    {
33      "field_reference": "settlements.account_number",
34      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
35      "reason_code": "field_missing",
36      "status": "required"
37    },
38    {
39      "field_reference": "settlements.ifsc",
40      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
41      "reason_code": "field_missing",
42      "status": "required"
43    },
44    {
45      "field_reference": "settlements.beneficiary_name",
46      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
47      "reason_code": "field_missing",
48      "status": "required"
49    }
50  ],
51  "tnc":{
52    "id": "tnc_IgohZaDBHRGjPv",
53    "accepted": true,
54    "accepted_at": 1641550798
55  },
56  "id": "acc_prd_HEgNpywUFctQ9e",
57  "account_id": "acc_HQVlm3bnPmccC0",
58  "product_name": "payment_gateway",
59  "activation_status": "needs_clarification",
60  "requested_at": 1605181524
61}