Request a Product Configuration

POST

/v1/accounts/:account_id/products

Click to copy

Use this endpoint to request a product configuration.

Is this page helpful?

Curl

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

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_K1em7bWYEiwmnc/products/acc_prd_K1eopFF8G21tux",
16         "reason_code":"field_missing",
17         "status":"required"
18      },
19      {
20         "field_reference":"settlements.account_number",
21         "resolution_url":"/accounts/acc_K1em7bWYEiwmnc/products/acc_prd_K1eopFF8G21tux",
22         "reason_code":"field_missing",
23         "status":"required"
24      },
25      {
26         "field_reference":"settlements.ifsc_code",
27         "resolution_url":"/accounts/acc_K1em7bWYEiwmnc/products/acc_prd_K1eopFF8G21tux",
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_K1eopFF8G21tux",
38   "product_name":"route",
39   "activation_status":"needs_clarification",
40   "account_id":"acc_K1em7bWYEiwmnc",
41   "requested_at":1659638222
42}

Path Parameters

account_id

string

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

Request Parameters

product_name

string

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

tnc_accepted

boolean

Determines whether the terms and conditions are accepted or not. Possible values:

true: Terms and conditions are accepted.
false: Terms and conditions are not accepted.

Response Parameters

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.

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.

Errors

Linked account does not exist.

Error Status: 400

This error occurs when the requester is not the parent of the child account, or the child account does not exist.

Solution

The product requested is invalid.

Error Status: 400

This error occurs when the provided data is invalid.

Solution

The selected tnc accepted is invalid.

Error Status: 400

This error occurs when the tnc.accepted value is false.

Solution

Request a Product Configuration

POST

/v1/accounts/:account_id/products

Click to copy

Use this endpoint to request a product configuration.

Is this page helpful?

Path Parameters

account_id

string

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

Request Parameters

product_name

string

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

tnc_accepted

boolean

Determines whether the terms and conditions are accepted or not. Possible values:

true: Terms and conditions are accepted.
false: Terms and conditions are not accepted.

Response Parameters

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.

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.

Errors

Linked account does not exist.

Error Status: 400

This error occurs when the requester is not the parent of the child account, or the child account does not exist.

Solution

The product requested is invalid.

Error Status: 400

This error occurs when the provided data is invalid.

Solution

The selected tnc accepted is invalid.

Error Status: 400

This error occurs when the tnc.accepted value is false.

Solution

Curl

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

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_K1em7bWYEiwmnc/products/acc_prd_K1eopFF8G21tux",
16         "reason_code":"field_missing",
17         "status":"required"
18      },
19      {
20         "field_reference":"settlements.account_number",
21         "resolution_url":"/accounts/acc_K1em7bWYEiwmnc/products/acc_prd_K1eopFF8G21tux",
22         "reason_code":"field_missing",
23         "status":"required"
24      },
25      {
26         "field_reference":"settlements.ifsc_code",
27         "resolution_url":"/accounts/acc_K1em7bWYEiwmnc/products/acc_prd_K1eopFF8G21tux",
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_K1eopFF8G21tux",
38   "product_name":"route",
39   "activation_status":"needs_clarification",
40   "account_id":"acc_K1em7bWYEiwmnc",
41   "requested_at":1659638222
42}