API ReferenceIntegrationsKnowledge Base

Standard Web Integration - Standard Checkout Form

Checkout form fields used in different integrations of Standard Checkout, that is Automatic and Manual, are tabulated as follows:

Field Name (Manual)

Field Name (Automatic)

Required

Description

key

data-key

Yes

Merchant Key-ID

amount

data-amount

Yes

Payment amount. Accepted datatype is integer. For example, if the amount is ₹100,data-amount="10000".

currency

data-currency

Yes

The currency in which the payment should be made by the customer. See the list of supported currencies.

If you are using Razorpay Orders, the currency in which the payment is made must match the Order currency.

name

data-name

Yes

The merchant/company name shown in the Checkout form.

description

data-description

No

Description of the purchase item shown in the Checkout form. Must start with an alphanumeric character.

image

data-image

No

Link to an image (usually merchant's logo) shown in the Checkout form. Can also be a base64 string, if loading the image from a network is not desirable.

order_id

data-order_id

Yes

Order ID generated via Razorpay Orders.

prefill.name

data-prefill.name

No

Cardholder's name to be pre-filled when the Checkout opens.

prefill.email

data-prefill.email

No

Customer's email to be pre-filled when the Checkout opens.

prefill.contact

data-prefill.contact

No

Customer's phone number to be pre-filled when the Checkout opens.

The expected format of the phone number is + {country code}{phone number}. If the country code is not specified, 91 will be used as the default value. This is particularly important while prefilling contact of customers with phone numbers issued outside India.

Examples:
● +14155552671 (a valid non-Indian number)
● +919977665544 (a valid Indian number).
If 9977665544 is entered, +91 is added to it as +919977665544.

prefill.method

data-prefill.method

No

Pre-selection of the payment method for the customer. Will only work if contact and email are also pre-filled. Possible values:
card
netbanking
wallet
emi
upi.

notes.fieldname

data-notes.fieldname

No

Any additional field you want to associate with the payment. For example, shipping address. Up to 15 note fields can be specified this way.

theme.hide_topbar

data-theme.hide_topbar

No

Used to display or hide the top bar on the Checkout form. This bar shows the selected payment method, phone number and gives the customer the option to navigate back to the start of the Checkout form. Possible values are:
true - Hides the top bar
false - Displays the top bar.

theme.color

data-theme.color

No

Brand color to alter the appearance of Checkout form.

modal.backdropclose

data-modal.backdropclose

No

Indicates whether clicking the translucent blank space outside the Checkout form should close the form. Possible values are:
true - Closes the form when your customer clicks outside the checkout form
false - Does not close the form when customer clicks outside the checkout form.

Defaults to false.

modal.escape

data-modal.escape

No

Indicates whether pressing the escape key should close the Checkout form. Possible values are:
true - Closes the form when the customer presses the escape key
false- Does not close the form when the customer presses the escape key.

Defaults to true.

modal.handleback

data-modal.handleback

No

When set as 'true', Checkout behaves similarly to the browser. That is, when the browser's back button is pressed, the Checkout also simulates a back press. This happens as long as the Checkout modal is open. By default, this is set to true.