Request a Product Configuration | Payment Gateway

POST

/v2/accounts/:account_id/products

Click to copy

Use this endpoint to request a product configuration for Payment Gateway or Payment Links. You can even accept terms and conditions for the requested product using these APIs. 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 POST https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products \
3-H "Content-Type: application/json" \
4-d '{
5  "product_name": "payment_gateway",
6  "tnc_accepted": true,
7  "ip": "233.233.233.234"
8}'

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

Path Parameters

account_id

string

The unique identifier of the sub-merchant account generated by Razorpay. For example, acc_HQVlm3bnPmccC0. This id is used to fetch or update a product. The product is created for this sub-merchant account id.

Request Parameters

product_name

string

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

payment_gateway
payment_links

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.

Response Parameters

requested_configuration

object

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

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

Show child parameters (3)

active_configuration

object

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

Show child parameters (6)

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 (4)

id

string

The unique identifier of the sub-merchant product account generated by Razorpay. For example, acc_prd_HEgNpywUFctQ9e. The product is created for this sub-merchant account id.

account_id

string

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

product_name

string

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

payment_gateway
payment_links

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.

Request a Product Configuration | Payment Gateway

POST

/v2/accounts/:account_id/products

Click to copy

Use this endpoint to request a product configuration for Payment Gateway or Payment Links. You can even accept terms and conditions for the requested product using these APIs. Know about the

various error responses

for this API.

Is this page helpful?

Path Parameters

account_id

string

Request Parameters

product_name

string

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

payment_gateway
payment_links

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.

Response Parameters

requested_configuration

object

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

tnc

object

Show child parameters (3)

active_configuration

object

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

Show child parameters (6)

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 (4)

id

string

The unique identifier of the sub-merchant product account generated by Razorpay. For example, acc_prd_HEgNpywUFctQ9e. The product is created for this sub-merchant account id.

account_id

string

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

product_name

string

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

payment_gateway
payment_links

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.

Curl

change language

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2-X POST https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products \
3-H "Content-Type: application/json" \
4-d '{
5  "product_name": "payment_gateway",
6  "tnc_accepted": true,
7  "ip": "233.233.233.234"
8}'

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