Request Payment Methods

PATCH

/v2/accounts/:account_id/products/:product_id

Click to copy

Use this endpoint to update a product's configuration and request payment methods like UPI, netbanking and card. Know about the

various error responses

for this API.

Check the

use cases

and

updates permitted for different product activation statuses

before using this API.

Watch Out!

Currently, we do not support making concurrent requests to the following Onboarding APIs including their combination on the same account_id:

Please wait for the response of these APIs before making subsequent requests.

Given here is the Payment Gateway product sample code when you request for a specific payment method. Here the payment_method object is used. The example used is netbanking.

Watch Out!

You can send request for only one payment method at a time. For example, if you want to enable HDFC Netbanking and Rupay Domestic Card payment methods, you should send two separate API requests. You cannot send a consolidated request using this API.

Is this page helpful?

UPI

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2-X PATCH https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \
3-d' {
4  "notifications": {
5    "email": [
6      "gaurav.kumar@example.com",
7      "acd@gmail.com"
8    ]
9  },
10  "checkout": {
11    "theme_color": "#528FFF"
12  },
13  "refund": {
14    "default_refund_speed": "optimum"
15  },
16  "settlements": {
17    "account_number": "1234567890",
18    "ifsc_code": "HDFC0000317",
19    "beneficiary_name": "Gaurav Kumar"
20  },
21  "payment_methods": {
22    "upi": {
23      "enabled": true,
24      "instrument": "upi"
25    }
26  },
27  "tnc_accepted": true,
28  "ip": "233.233.233.234"
29}'

Success

1{
2  "requested_configuration": {
3    "payment_methods": {
4      "upi": {
5        "enabled": true,
6        "instrument": [
7          "upi"
8        ]
9      }
10    }
11  },
12  // already activated payment methods
13  "active_configuration": {
14    "payment_methods": {
15      "netbanking": {
16        "enabled": true,
17        "instrument": [
18          {
19            "type": "retail",
20            "bank": [
21              "hdfc",
22              "sbin"
23            ]
24          }
25        ]
26      },
27      "wallet": {
28        "enabled": true,
29        "instrument": [
30          "airtelmoney"
31        ]
32      }
33    }
34  }
35}

Path Parameters

account_id

string

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

id

string

The unique identifier of a product generated by Razorpay. For example, acc_prd_HEgNpywUFctQ9e.

Request Parameters

notifications

object

This denotes the notifications settings.

Show child parameters (3)

checkout

object

The checkout form of the payment capture.

Show child parameters (3)

refund

object

This denotes the payment refund settings.

Show child parameters (1)

settlements

object

The Settlement settings object.

Show child parameters (3)

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.

payment_methods

object

Details of the payment method you want to enable for the product.

Show child parameters (6)

Response Parameters

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.

Show child parameters (5)

requested_at

integer

The Unix timestamp at which the product configuration is requested.

Request Payment Methods

PATCH

/v2/accounts/:account_id/products/:product_id

Click to copy

Use this endpoint to update a product's configuration and request payment methods like UPI, netbanking and card. Know about the

various error responses

for this API.

Check the

use cases

and

updates permitted for different product activation statuses

before using this API.

Watch Out!

Currently, we do not support making concurrent requests to the following Onboarding APIs including their combination on the same account_id:

Please wait for the response of these APIs before making subsequent requests.

Given here is the Payment Gateway product sample code when you request for a specific payment method. Here the payment_method object is used. The example used is netbanking.

Watch Out!

Is this page helpful?

Path Parameters

account_id

string

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

id

string

The unique identifier of a product generated by Razorpay. For example, acc_prd_HEgNpywUFctQ9e.

Request Parameters

notifications

object

This denotes the notifications settings.

Show child parameters (3)

checkout

object

The checkout form of the payment capture.

Show child parameters (3)

refund

object

This denotes the payment refund settings.

Show child parameters (1)

settlements

object

The Settlement settings object.

Show child parameters (3)

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.

payment_methods

object

Details of the payment method you want to enable for the product.

Show child parameters (6)

Response Parameters

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.

Show child parameters (5)

requested_at

integer

The Unix timestamp at which the product configuration is requested.

UPI

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2-X PATCH https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \
3-d' {
4  "notifications": {
5    "email": [
6      "gaurav.kumar@example.com",
7      "acd@gmail.com"
8    ]
9  },
10  "checkout": {
11    "theme_color": "#528FFF"
12  },
13  "refund": {
14    "default_refund_speed": "optimum"
15  },
16  "settlements": {
17    "account_number": "1234567890",
18    "ifsc_code": "HDFC0000317",
19    "beneficiary_name": "Gaurav Kumar"
20  },
21  "payment_methods": {
22    "upi": {
23      "enabled": true,
24      "instrument": "upi"
25    }
26  },
27  "tnc_accepted": true,
28  "ip": "233.233.233.234"
29}'

Success

1{
2  "requested_configuration": {
3    "payment_methods": {
4      "upi": {
5        "enabled": true,
6        "instrument": [
7          "upi"
8        ]
9      }
10    }
11  },
12  // already activated payment methods
13  "active_configuration": {
14    "payment_methods": {
15      "netbanking": {
16        "enabled": true,
17        "instrument": [
18          {
19            "type": "retail",
20            "bank": [
21              "hdfc",
22              "sbin"
23            ]
24          }
25        ]
26      },
27      "wallet": {
28        "enabled": true,
29        "instrument": [
30          "airtelmoney"
31        ]
32      }
33    }
34  }
35}