1.1 Additional Offers🔗

By default, all those offers which had the 'Show Offer on Checkout' option enabled during creation will appear on the widget.
You can display a particular offer that did not have the 'Show Offer on Checkout' option enabled using the following code:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 400000,
  "features": {
    "offers": {
      "list": [
        "offer_ANZoaxsOww2X53"
      ]
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

features.offers

object Display a set of additional offers on the widget by passing the offer_id

list optional

array Display a list of offer_id of the offers.

1.2 Most Valuable Offer🔗

If you have special offers for your product or service, it is a good idea to highlight those on the widget. Highlighting the hero offer will attract more customers and influence their purchase decision.

To display the most valuable offer:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 400000,
  "display": {
    "offers": {
      "mostValuableOffer": "offer_ANZoaxsOww2X53"
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display.offers.mostValuableOffer optional

string Highlight the most valuable offer on the widget by passing the offer_id.

1.3 Limited Offers🔗

By default, all those offers which had the 'Show Offer on Checkout' option enabled during the offer creation will appear on the widget. In case you want to display limited offers on the widget, enter the offer_id of the offers of your choice.
To show limited offers:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 10000,
  "display": {
    "offers": {
      "offerIds": [
        "offer_ANZoaxsOww2X53"
      ]
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display.offers

object Display a set of limited offers.

offerIds optional

array Unique identifier of the offer.

1.4 Show Discount Amount on Offers🔗

Display the exact amount of discount on offers to help new customers compare and choose your products over your competitors, giving you a foot in the door.

To show the discount amount on offers:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 400000,
  "display": {
    "offers": {
      "showDiscount": true // default false
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display.offers

object Display various offers on widget.

showDiscount optional

boolean Indicates whether the discount amount on offers should be displayed. Possible values:

• true: Display the discount amount on offers.
• false(default): Do not display the discount amount on offers.

1.5 Disable the Offers🔗

If you disable the offers completely, they will not appear on the widget and the customers will not be able to view them.
To completely disable the offers:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 400000,
  "display": {
    "offers": false
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display

object Display various offers on the widget.

offers optional

boolean Indicates whether the offers should be displayed. Possible values:

• true (default): Display the offers on the widget.
• false: Disable the offers on the widget.

2.1 EMI🔗

2.1.1 Limited Providers for EMI🔗

Razorpay supports these providers for EMI options. By default, all EMI options satisfying the minimum transaction amount will appear on the widget. In case you want to display limited EMI options on the widget, enter the list of provider codes based on your requirement.
To show a limited set of providers:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 300000,
  "display": {
    "emi": {
      "issuers": [
        "KKBK"
      ]
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹3000, enter 300000.

display.emi.issuers optional

array<string> List of limited set of providers for EMI options.

2.1.2 Disable EMI Options🔗

If you disable the EMI options completely, they will not appear on the widget and the customers will not be able to view them.
To completely disable EMI options:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 400000,
  "display": {
    "emi": false
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display

object Display different payment method options on the widget.

emi optional

boolean Indicates whether the EMI options should appear on the widget. Possible values:

• true (default): Display the EMI options on the widget.
• false: Disable the EMI options on the widget.

2.2 Cardless EMI🔗

2.2.1 Limited providers for Cardless EMI🔗

Razorpay supports these providers for Cardless EMI options. By default, all Cardless EMI options satisfying the minimum transaction amount will appear on the widget. In case you want to display limited Cardless EMI options on the widget, enter the list of provider codes based on your requirement.
To show a limited set of providers:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 300000,
  "display": {
    "cardlessEmi": {
      "providers": [
        "zestmoney",
        "earlysalary"
      ]
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹3000, enter 300000.

display.cardlessEmi.providers optional

array<string> List of limited set of providers for Cardless EMI options.

2.2.2 Disable Cardless EMI Options🔗

If you disable the Cardless EMI options completely, they will not appear on the widget and the customers will not be able to view them.
To completely disable Cardless EMI options:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 400000,
  "display": {
    "cardlessEmi": false
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display

object Display different payment method options on the widget pages.

cardlessEmi optional

boolean Indicates whether the Cardless EMI options should appear on the widget. Possible values:

• true (default): Display the Cardless EMI options on the widget.
• false: Disable the Cardless EMI options on the widget.

2.3 Pay Later🔗

2.3.1 Limited Providers for Pay Later🔗

Razorpay supports these providers for Pay Later options. By default, all Pay Later options satisfying the minimum transaction amount will appear on the widget. In case you want to display limited Pay Later options on the widget, enter the list of provider codes based on your requirement.
To show a limited set of providers:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 10000,
  "display": {
    "paylater": {
      "providers": [
        "lazypay"
      ]
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹100, enter 10000.

display.paylater.providers optional

array<string> List of limited set of providers for Pay Later options.

2.3.2 Disable Pay Later Options🔗

If you disable the Pay Later options completely, they will not appear on the widget and the customers will not be able to view them.
To completely disable Pay Later options:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 10000,
  "display": {
    "paylater": false
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹100, enter 10000.

display

object Display different payment method options on the widget.

paylater optional

boolean Indicates whether the Pay Later options should appear on the widget. Possible values:

• true (default): Display the Pay Later options on the widget.
• false: Disable Pay Later options on the widget.

3. Themes and Colours🔗

Alter the appearance of the widget based on your website. Following are the customisations you can perform on the widget:

3.1 Customise the Theme Colour (Only Header)🔗

Customise the theme colour based on your requirement. For example, if the background colour of the header is blue, you can change the colour to purple.

To change the theme colour:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 400000,
  "theme": {
    "color": "#800080"
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

theme

object Thematic options to modify the appearance of the header.

color optional

string Enter the HEX code of your choice to alter the appearance of the header.

3.2 Change Heading Colour and Font Size🔗

You can customise the colour and font size of the headings on the widget. For example, if the colour of the heading is black and the font size is 10px you can change the colour to blue and the font size to 16px.

To change the heading colour and font size:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 10000,
  "display": {
    "widget": {
      "main": {
        "heading": {
          "color": "blue",
          "fontSize": "16px"
        }
      }
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display.widget.main.heading

object Customise the heading on the widget.

color optional

string Enter the colour of your choice.

fontSize optional

string Enter the font size of your choice.

3.3 Change Content Colour and Font Size🔗

You can customise the colour and font size of the content on the widget. For example, if the colour of the content is black and the font size is 10px you can change the colour to purple and the font size to 16px.

To change the content colour and font size:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 100000,
  "display": {
    "widget": {
      "main": {
        "content": {
          "color": "purple",
          "fontSize": "16px"
        }
      }
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display.widget.main.content

object Customise the content on the widget.

color optional

string Enter the colour of your choice.

fontSize optional

string Enter the font size of your choice.

3.4 Change Link Colour and Font Size🔗

You can customise the colour and font size of the link on the widget. For example, if the colour of the link is blue and the font size is 10px you can change the colour to black and the font size to 12px.

To change the link colour and font size:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 100000,
  "display": {
    "widget": {
      "main": {
        "link": {
          "color": "black",
          "fontSize": "12px"
        }
      }
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display.widget.main.link

object Customise the link on the widget.

color optional

string Enter the colour of your choice.

fontSize optional

string Enter the font size of your choice.

3.5 Change Footer Colour, Font Size and Logo🔗

You can customise the colour and font size of the footer on the widget. For example, if the colour of the link is black and the font size is 10px you can change the colour to brown and the font size to 12px.

Razorpay provides a customisation option for the logo in two variants:

• Light
• Dark (default)

To change the footer colour, font size and logo:

 Add Parameter
Copy{
  "key": "YOUR_KEY_ID",
  "amount": 100000,
  "display": {
    "widget": {
      "main": {
        "footer": {
          "color": "white",
          "fontSize": "12px",
          "darkLogo": false // true is default show black text rzp logo
        }
      }
    }
  }
}

Parameters🔗

key mandatory

string API Key ID generated from the Razorpay Dashboard.

amount mandatory

integer The amount to be paid by the customer in paise. For example, if the amount is ₹4000, enter 400000.

display.widget.main.footer

object Customise the footer of the widget.

color optional

string Enter the colour of your choice.

fontSize optional

string Enter the font size of your choice.

darklogo optional

boolean Indicates the colour of the Razorpay logo. Possible values:

• true (default): Display the default Razorpay logo on the widget.
• false: Display Razorpay logo on dark mode enabled websites or websites with a darker background colour.