Request Payment Methods

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

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:

• Update Account API
• Update Stakeholder API
• Update Product Configuration API

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.

Request

Curl

curl -X PATCH https://api.razorpay.com/v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/ \
-u  \
-d' {
  "notifications": {
    "email": [
      "[e-mail]",
      "[e-mail]"
    ]
  },
  "checkout": {
    "theme_color": "#528FFF"
  },
  "refund": {
    "default_refund_speed": "optimum"
  },
  "settlements": {
    "account_number": "1234567890",
    "ifsc_code": "HDFC0000317",
    "beneficiary_name": "Gaurav Kumar"
  },
  "payment_methods": {
    "upi": {
      "enabled": true,
      "instrument": "upi"
    }
  },
  "tnc_accepted": true,
  "ip": "233.233.233.234"
}'

```php: PHP
$api = new Api(null, null, "");

$accountId = "acc_GP4lfNA0iIMn5B";
$productId = "acc_prd_HEgNpywUFctQ9e";

$products = $api->account->fetch($accountId)->products();

$products->edit($productId, array(
   "notifications" => array(
       "email" => array(
           "[e-mail]",
           "[e-mail]"
       )
   ),
   "checkout" => array(
       "theme_color" => "#528FFF"
   ),
   "refund" => array(
       "default_refund_speed" => "optimum"
   ),
   "settlements" => array(
       "account_number" => "1234567890",
       "ifsc_code" => "HDFC0000317",
       "beneficiary_name" => "Gaurav Kumar"
   ),
   "payment_methods" => array(
     "upi" => array(
       "enabled" => true,
       "instrument" => "upi"
     )
   ),
   "tnc_accepted" => true,
   "ip" => "233.233.233.234"
));

Response

Success

{
  "requested_configuration": {
    "payment_methods": {
      "upi": {
        "enabled": true,
        "instrument": [
          "upi"
        ]
      }
    }
  },
  // already activated payment methods
  "active_configuration": {
    "payment_methods": {
      "netbanking": {
        "enabled": true,
        "instrument": [
          {
            "type": "retail",
            "bank": [
              "hdfc",
              "sbin"
            ]
          }
        ]
      },
      "wallet": {
        "enabled": true,
        "instrument": [
          "airtelmoney"
        ]
      }
    }
  }
}

Parameters

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

id mandatory : string The unique identifier of a product generated by Razorpay. For example, acc_prd_HEgNpywUFctQ9e.

Parameters

notifications optional : object This denotes the notifications settings.

email : string The email addresses that will receive notifications regarding payments, settlements, daily payment reports, webhooks, and so on.

whatsapp : boolean The WhatsApp notifications you receive regarding payments, settlements, daily payment reports, webhooks, etc.

sms : boolean The SMS notifications you receive regarding payments, settlements, daily payment reports, webhooks, etc. This attribute will be set to false.

checkout optional : object The checkout form of the payment capture.

theme_color : string The theme color for sub-merchant’s checkout page

logo : string The logo of the sub-merchant’s business on the checkout page.

flash_checkout : boolean The flagging options Enable or Disable for Razorpay’s Flash Checkout to securely save the card details of your customers.

refund optional : object This denotes the payment refund settings.

default_refund_speed : string Speed at which the refund is to be processed. Possible values:

• normal: Indicates that the refund will be processed at normal speed. By default, the refund will take 5-7 working days.
• optimum: Indicates that the refund will be processed at an optimal speed based on Razorpay’s internal fund transfer logic. That is:
  • If the refund can be processed instantly, Razorpay will initiate the process irrespective of the payment method used to make the payment.
  • If an instant refund is not made, Razorpay will initiate a refund that is processed at the normal speed. For example, payments made using debit cards, netbanking or unsupported credit cards.

settlements conditional : object The Settlement settings object.

account_number : string The bank account number to which settlements are made. Account details can be found on the Dashboard. For example, 7878780080316316.

ifsc_code : string The IFSC associated with the bank account. For example, RATN0VAAPIS.

beneficiary_name : string The name of the beneficiary associated with the bank account.

tnc_accepted optional : boolean Pass this parameter to accept terms and conditions. Send this parameter along with the ip parameter when the tnc is accepted. Possible value is true which indicates acceptance of terms and conditions.

ip optional : 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 optional : object Details of the payment method you want to enable for the product.

netbanking : object The payment method to be enabled.

enabled : boolean Enables or disables the payment method. Possible values:

• true: Enables the netbanking payment method.
• false: Does not enable the netbanking payment method.

instrument : object Details regarding the bank.

type : string The type of bank. Possible values:

• retail
• corporate.

bank : string The bank code. Refer to the list of bank codes.

card : object The payment method to be enabled.

enabled : boolean Enables or disables the payment method. Possible values:

• true: Enables the card payment method.
• false: Does not enable the card payment method.

instrument : object Details regarding the card.

type : string Possible value is domestic.

issuer : string The card issuer. Possible values:

• amex
• dicl
• maestro
• mastercard
• rupay
• visa

wallet : object The payment method to be enabled.

enabled : boolean Enables or disables the payment method. Possible values:

• true: Enables the wallet payment method.
• false: Does not enable the wallet payment method.

instrument : string The wallet issuer. Possible values:

• airtelmoney
• amazonpay
• jiomoney
• mobiwik
• mpesa
• olamoney
• paytm
• payzapp
• payumoney
• phonepe
• phonepeswitch
• sbibuddy

upi : object The payment method to be enabled.

enabled : boolean Enables or disables the payment method. Possible values:

• true: Enables the upi payment method.
• false: Does not enable the upi payment method.

instrument : string The UPI service provider. Possible values:

• google_pay
• upi

paylater : object The payment method to be enabled.

enabled : boolean Enables or disables the payment method. Possible values:

• true: Enables the paylater payment method.
• false: Does not enable the paylater payment method.

instrument : string The Paylater service provider. Possible values:

• epaylater
• getsimpl

emi : object The payment method to be enabled.

enabled : boolean Enables or disables the payment method. Possible values:

• true: Enables the paylater payment method.
• false: Does not enable the paylater payment method.

instrument : object The EMI instrument object.

type : string The type of EMI payment method. Possible values:

• card_emi
• cardless_emi

partner : string The list of EMI partners requested or enabled. Possible values:

• For card_emi: debit and credit.
• For cardless_emi: zestmoney and earlysalary.

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:

id : string The unique identifier representing the acceptance of terms and conditions for a product by a user.

accepted : boolean The flag that represents whether the terms and conditions are accepted by the user.

• true: Terms and conditions are accepted by user.
• false: Terms and conditions are not accepted by user.

accepted_at : integer The Unix timestamp at which the terms and conditions were accepted by the user for the requested product.

activation_status : string The status of the product activation.

• requested
• needs_clarification
• under_review
• activated
• suspended

configuration : object The following are the possible configurations:

payment_methods : object The payment methods configured, such as, netbanking, UPI, Wallet and EMI.

upi : object The UPI type payment method.

status : string The status of UPI payment method.

instrument : array The list of UPI instruments requested or enabled.

netbanking : object The netbanking type payment method.

status : string The status of the netbanking payment method.

instrument : array The netbanking instrument object.

type : string The type of netbanking payment method. Possible values:

• Retail

• Corporate

bank : array The list of netbanking banks requested or enabled. Refer the Appendix page for netbanking bank codes.

wallet : object The Wallet type payment method.

status : string The status of the Wallet payment method.

instrument : array The list of Wallet instruments requested or enabled.

emi : string The EMI type payment method.

status : string The status of EMI payment method.

instrument : array The EMI instrument object.

type : string The type of EMI payment method. Possible values:

• card_emi
• cardless_emi

partner : array The list of EMI partners requested or enabled. Possible values:

• For card_emi: debit and credit.
• For cardless_emi: zestmoney and earlysalary.

paylater : object The payment method to be enabled.

enabled : boolean Enables or disables the payment method. Possible values:

• true: Enables the paylater payment method.
• false: Does not enable the paylater payment method.

instrument : string The Paylater service provider. Possible values are:

• epaylater
• getsimpl

payment_capture : object The payment capture settings object.

mode : string The mode through which payment capture is done. Possible values:

• automatic: Payments are auto-captured (default)
• manual: You have to manually capture payments using our Capture API or from the Partner’s Dashboard.

automatic_expiry : numeric This denotes the time in minutes when the payment is in the authorized state. This is auto-captured.

manual_expiry : numeric This denotes the time in minutes until you can manually capture payments in the authorized state.

• Must be equal to or greater than the automatic_expire_period value.
• The default and the maximum value is 7200 minutes.
• The payments in the authorized state after the manual_expiry_period are auto-refunded.

settlements : object The Settlement settings object.

account_number : string The bank account number to which settlements are made. Account details can be found on the Dashboard. For example, 7878780080316316.

ifsc_code : string The IFSC associated with the bank account. For example, RATN0VAAPIS.

beneficiary_name : string The name of the beneficiary associated with the bank account. This API parameter is needed complete the KYC process. However, it is optional for this API.

refund : object This denotes the payment refund settings.

default_refund_speed : string Speed at which the refund is to be processed. Possible values are:

• normal: Indicates that the refund will be processed at the normal speed. By default, the refund will take 5-7 working days.
• optimum: Indicates that the refund will be processed at an optimal speed based on Razorpay’s internal fund transfer logic. That is:
  • If the refund can be processed instantly, Razorpay will initiate the process irrespective of the payment method used to make the payment.
  • If an instant refund is not made, Razorpay will initiate a refund that is processed at the normal speed. For example, payments made using debit cards, netbanking or unsupported credit cards.

checkout : object The checkout form of the payment capture.

theme_color : string The theme color for sub-merchant’s checkout page

logo : string The logo of the sub-merchant’s business on the checkout page.

flash_checkout : boolean The flagging options Enable or Disable for Razorpay’s Flash Checkout to securely save the card details of your customers.

notifications : object This denotes the notifications settings.

email : string The email addresses that will receive notifications regarding payments, settlements, daily payment reports, webhooks, and so on.

whatsapp : boolean The WhatsApp notifications you receive regarding payments, settlements, daily payment reports, webhooks, etc.

sms : boolean The SMS notifications you receive regarding payments, settlements, daily payment reports, webhooks, etc. This attribute will be set to false.

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.

field_reference : string The field which is in issue or missing. The JSON key path in resolution URL.

resolution_url : string The URL to address the requirement. The API endpoint to be used for updating missing fields or documents.

status : string The status of the requirement.

reason_code : string The reason code for showing in the requirement. Description will be sent only when reason code is "". Possible values are:

• field_missing
• needs_clarification
• document_missing

description : string This parameter is displayed when the reason_code is needs_clarification.

requested_at : integer The Unix timestamp at which the product configuration is requested.