1. Build Integration

Follow these steps to integrate Custom Checkout in your site:

1.1

Create a Customer in Server

1.2

Create an Order in Server

1.3

Fetch Payment Methods

1.4

Invoke Checkout and Pass Order Id and Other Options to it

1.5

Store Fields in your Server

1.6

Verify Payment Signature

1.7

Verify Payment Status

1.1 Create a Customer in Server

Creating a customer generates a unique customer_id by collecting basic details such as name, email, and contact details. This customer_id must be included when creating a payment request to link the payment to the customer. Use the following API to create a customer.

You can try out our APIs on the Razorpay Postman Public Workspace. Fork the workspace and test the APIs with your

Test API Keys

POST

/customers

Request Parameters

name

mandatory

string Customer's name.

Character length: Between 5 and 50 characters.
Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), and spaces (not at the beginning).
Not allowed characters: Numbers, special characters (e.g., @, ", ,, ., etc.), Unicode characters, emojis, and non-Latin scripts or regional languages.
Prohibited names: Names must be meaningful and contextually appropriate.
- Avoid using repetitive patterns (e.g., aaa, xyz, kkk kk).
- Names like litri litri, Hfg Gh, or husi husi are not permitted.
- Curse words or offensive names are not prohibited.
Example: Gaurav Kumar.

contact

mandatory

string The customer's phone number. A maximum length of 15 characters including country code. For example, +919123456780.

mandatory

string The customer's email address. A maximum length of 64 characters for the username. For example, in "

gaurav.kumar@example.com

", "gaurav.kumar" must not exceed 64 characters.

fail_existing

optional

string Possible values:

0: If a customer with the same details already exists, fetches details of the existing customer.
1 (default): If a customer with the same details already exists, throws an error.

gstin

optional

string Customer's GST number, if available.
For example, 29XAbbA4369J1PA.

notes

optional

object Key-value pair used to store additional information about the entity. Holds 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

string Unique identifier of the customer. For example, cust_1Aa00000000004.

entity

string Indicates the type of entity.

name

string Customer's name.

Character length: Between 5 and 50 characters.
Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), and spaces (not at the beginning).
Not allowed characters: Numbers, special characters (e.g., @, ", ,, ., etc.), Unicode characters, emojis, and non-Latin scripts or regional languages.
Prohibited names: Names must be meaningful and contextually appropriate.
- Avoid using repetitive patterns (e.g., aaa, xyz, kkk kk).
- Names like litri litri, Hfg Gh, or husi husi are not permitted.
- Curse words or offensive names are not prohibited.
Example: Gaurav Kumar.

contact

string The customer's phone number. A maximum length of 15 characters including country code. For example, +919123456780.

string The customer's email address. A maximum length of 64 characters for the username. For example, in "

gaurav.kumar@example.com

", "gaurav.kumar" must not exceed 64 characters.

gstin

string GST number linked to the customer.
For example, 29XAbbA4369J1PA.

notes

object Key-value pair used to store additional information about the entity. Holds 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer UNIX timestamp, when the customer was created. For example, 1234567890.

Error Response Parameters

1.2 Create an Order in Server

After a customer is created, an order needs to be generated using the Orders API. This order contains details such as the payment amount, currency, customer details, tax-related information and other custom notes. After the order is created, an order_id is generated, for example, order_NGrgEcmYJsfUyl. You must pass this order_id in the checkout code to associate this order with the payment. Learn more about

Order and Payment states

POST

/orders

Watch Out!

The PAN object is necessary for transactions greater than 2.5 lakhs.

Request Parameters

amount

mandatory

integer The amount for which the order was created, in currency subunits. For example, for an amount of ₹295.00, enter 29500. Payment can only be made for this amount against the Order.

currency

mandatory

string ISO code for the currency in which you want to accept the payment. The default length is 3 characters. For example, INR.

receipt

optional

string Receipt number that corresponds to this order, set for your internal reference. Can have a maximum length of 40 characters and has to be unique.

customer_id

mandatory

string Unique identifier of the customer. For example, cust_1Aa00000000004.

customer_details

mandatory

object This contains details about the customer details of the order.

name

mandatory

string Customer's name.

Character length: Between 5 and 50 characters.
Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), and spaces (not at the beginning).
Not allowed characters: Numbers, special characters (e.g., @, ", ,, ., etc.), Unicode characters, emojis, and non-Latin scripts or regional languages.
Prohibited names: Names must be meaningful and contextually appropriate.
- Avoid using repetitive patterns (e.g., aaa, xyz, kkk kk).
- Names like litri litri, Hfg Gh, or husi husi are not permitted.
- Curse words or offensive names are not prohibited.
Example: Gaurav Kumar.

optional

string The customer's email address. A maximum length of 64 characters for the username. For example, in "

gaurav.kumar@example.com

", "gaurav.kumar" must not exceed 64 characters.

contact

optional

string The customer's phone number. A maximum length of 15 characters including country code. For example, +919123456780.

shipping_address

mandatory

object This contains the shipping address of the order.

line1

mandatory

string Address Line 1 of the address.

Character length: Must be between 3 and 100 characters.
Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), spaces, and special characters (*&/-()#_+[]:'".,.).
Not allowed characters: Regional languages.

line2

mandatory

string Address Line 2 of the address.

Character length: Must be between 3 and 100 characters.
Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), spaces, and special characters (*&/-()#_+[]:'".,.).
Not allowed characters: Regional languages.

city

mandatory

string Name of the city. Must be between 3 and 50 characters in length and can only include uppercase (A-Z) and lowercase (a-z) English letters, and spaces.

country

mandatory

string ISO3 country code of the billing address. Only IND is allowed.

state

mandatory

string Name of the state. It must be between 3 and 50 characters extended and can only include uppercase (A-Z) and lowercase (a-z) English letters and spaces. Please send the full name of the state, for example, Madhya Pradesh.

zipcode

mandatory

string The ZIP code must consist of 6-digit numeric characters. Only valid Indian ZIP codes will be accepted. Refer to the

list of supported ZIP codes

latitude

optional

float Latitude of the position expressed in decimal degrees (WSG 84), for example, 6.244203. A positive value denotes the northern hemisphere or the equator, and a negative value denotes the southern hemisphere. The number of digits to represent the precision of the coordinate.

longitude

optional

float Longitude of the position expressed in decimal degrees (WSG 84), for example, -75.581211. A positive value denotes east longitude or the prime meridian, and a negative value denotes west longitude. The number of digits to represent the precision of the coordinate.

identity

mandatory

array A list of identity objects containing customer identification details.

Watch Out!

The PAN object is necessary for transactions greater than 2.5 lakhs.

type

mandatory

string The type of identification document. For example, tax_id.

mandatory

string The identification number or value corresponding to the type provided. For example, ABCDE1234F.

notes

optional

json object Key-value pair used to store additional information about the entity. Holds 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty".

Response Parameters

amount

integer The amount for which the order was created, in currency subunits. For example, for an amount of ₹295.00, enter 29500.

amount_due

integer The amount pending against the order.

amount_paid

integer The amount paid against the order.

attempts

integer The number of payment attempts, successful and failed, that have been made against this order.

created_at

integer Indicates the Unix timestamp when this order was created.

currency

string ISO code for the currency in which you want to accept the payment. The default length is 3 characters.

entity

string Name of the entity. Here, it is order.

string The unique identifier of the order.

notes

object Key-value pair used to store additional information about the entity. Holds 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty".

offer_id

string The unique identifier of the offer. For example, offer_JHD834hjbxzhd38d.

receipt

string Receipt number that corresponds to this order. Can have a maximum length of 40 characters and has to be unique.

status

string The status of the order. Possible values:

created: When you create an order, it is in the created state. It stays in this state till a payment is attempted on it.
attempted: An order changes to the attempted state following the first payment attempt and remains in this state until at least one payment is successfully processed and captured.
paid: After the successful capture of the payment, the order moves to the paid state. No further payment requests are permitted once the order moves to the paid state.
The order stays in the paid state even if the payment associated with the order is refunded.

Error Response Parameters

1.3 Fetch Payment Methods

When creating a custom checkout form, display only the activated methods to the customer. Use the below methods to fetch all payments methods available to you:

var razorpay = new Razorpay({
  key: '<YOUR_KEY_ID>',
    // logo, displayed in the popup
  image: 'https://i.imgur.com/n5tjHFD.jpg',
});
razorpay.once('ready', function(response) {
  console.log(response.methods);
})

Know more about the various

payment methods

offered by Razorpay.

1.4 Invoke Checkout and Pass Order Id and Other Options to it

1.4.1 Include JavaScript code in your Webpage

Include the following script, preferably in the <head> section of your page:

<script type="text/javascript" src="https://checkout.razorpay.com/v1/razorpay.js"></script>

Handy Tips

Include the script from https://checkout.razorpay.com/v1/razorpay.js instead of entering a copy from your server. This allows the library's new updates and bug fixes to fit your application automatically.
We always maintain backward compatibility with our code.

1.4.2 Instantiate Custom Checkout

You can instantiate single instance or multiple instances of Custom Checkout on the same page.

var razorpay = new Razorpay({
  key: '<YOUR_KEY_ID>',
    // logo, displayed in the payment processing popup
  image: 'https://i.imgur.com/n5tjHFD.jpg',
});

Request Parameters

While building a custom UI for accepting payments from your customers, you should be familiar with the fields supported in the razorpay.js script.

Request parameters

key

mandatory

string API Key ID generated from Dashboard → Account & Settings →

API Keys

image

optional

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

1.4.3 Submit Payment Details

After creating an order and obtaining the customer's payment details, send the information to Razorpay to complete the payment. You can do this by invoking createPayment method. The data that needs to be submitted depends on the customer's payment method.

Know more about

sample codes for various payment methods

and

supported payment methods

var data = {
  amount: 1000, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10
  currency: "INR",// Default is INR. We support more than 90 currencies.
  email: 'gaurav.kumar@example.com',
  contact: '9123456780',
  customer_id: 'cust_MpINfSkdEvtdxb',
  notes: {
    "invoice_number": "IRS1245",
    "goods_description": "Digital Lamp",
  },
  order_id: 'order_NGrgEcmYJsfUyl',// Replace with Order ID generated in Step 4
  method: 'netbanking',

  // method specific fields
  bank: 'YESB'
};

var btn = document.querySelector('#btn');
btn.addEventListener('click', function(){
  // has to be placed within user initiated context, such as click, in order for popup to open.
  razorpay.createPayment(data);

  razorpay.on('payment.success', function(resp) {
    alert(resp.razorpay_payment_id),
    alert(resp.razorpay_order_id),
    alert(resp.razorpay_signature)}); // will pass payment ID, order ID, and Razorpay signature to success handler.

  razorpay.on('payment.error', function(resp){alert(resp.error.description)}); // will pass error object to error handler

})

Watch Out!

The invoice_number field is mandatory for all payment methods. Ensure each payment has a unique invoice number.
The createPayment method should be called within an event listener triggered by user action to prevent the popup from being blocked. For example:

$('button').click( function (){ razorpay.createPayment(...) })

Supported Payment Methods

Following payment methods are supported under the Import Flow:

Netbanking
UPI
Cards
Recurring

For recurring payments, additional integration is needed. Cards, UPI, and UPI with TPV are supported as a payment methods.

Handler Function or Callback URL

You can use Handler Function or Callback URL to send the payment details to us. Following is the difference between them.

When you use the handler function, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Checkout Form. You need to collect these and send them to your server.

Request Parameters

Following are the request parameters.

amount

mandatory

integer The amount to be paid by the customer in currency subunits. For example, if the amount is ₹100.00, enter 10000.

currency

mandatory

string The currency in which the payment should be made by the customer. For example, INR. See the list of

supported currencies

mandatory

string The customer's email address. A maximum length of 64 characters for the username. For example, in "

gaurav.kumar@example.com

", "gaurav.kumar" must not exceed 64 characters.

contact

mandatory

string The customer's phone number. A maximum length of 15 characters including country code. For example, +919123456780.

customer_id

mandatory

string Unique identifier of the customer.

description

optional

string Description of the product shown in the Checkout form. It must start with an alphanumeric character.

image

optional

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

order_id

mandatory

string Order ID generated via the

Orders API

method

mandatory

string The payment method used by the customer on Checkout.
Possible values:

card (default)
upi (default)
netbanking (default)
wallet (default)
emi (default)
cardless_emi (requires
approval
)
paylater (requires
approval
)
emandate (requires
approval
)

card

mandatory if method=card/emi

object The details of the card that should be entered while making the payment.

number

integer Unformatted card number.

name

string The name of the cardholder.

expiry_month

integer Expiry month for card in MM format.

expiry_year

integer Expiry year for card in YY format.

cvv

integer CVV printed on the back of the card.

Handy Tips

CVV is not required by default for tokenised cards across all networks.
CVV is optional for tokenised card payments. Do not pass dummy CVV values.
To implement this change, skip passing the cvv parameter entirely, or pass a null or empty value in the CVV field.
We recommend removing the CVV field from your checkout UI/UX for tokenised cards.
If CVV is still collected for tokenised cards and the customer enters a CVV, pass the entered CVV value to Razorpay.

emi_duration

integer Defines the number of months in the EMI plan.

bank_account

mandatory if method=emandate

The details of the bank account that should be passed in the request. These details include bank account number, IFSC code and the name of the customer associated with the bank account.

account_number

string Bank account number used to initiate the payment.

ifsc

string IFSC of the bank used to initiate the payment.

name

string Name associated with the bank account used to initiate the payment.

bank

mandatory if method=netbanking

string Bank code. List of available banks enabled for your account can be fetched via

methods

wallet

mandatory if method=wallet

string Wallet code for the wallet used for the payment. Possible values:

freecharge (default)
payzapp (default)
olamoney (requires
approval
)
phonepe (requires
approval
)
airtelmoney (requires
approval
)
mobikwik (requires
approval
)
jiomoney (requires
approval
)
amazonpay (requires
approval
)
paypal (requires
approval
)
phonepeswitch (requires
approval
)

provider

mandatory if method=cardless_emi/paylater

string Name of the cardless EMI provider partnered with Razorpay.

Available options for Cardless EMI (requires

approval

barb
cshe
hdfc
icic
idfb
kkbk
krbe
zestmoney
earlysalary
tvsc
walnut369

Available options for Pay Later:

rzpx_postpaid (
requires approval
)
getsimpl (default)
icic (default)
hdfc (
requires approval
)
lazypay

Watch Out!
LazyPay services are temporarily disabled.

vpa

mandatory if method=upi

string UPI ID used for making the payment on the UPI app.

callback_url

optional

string The URL to which the customer must be redirected upon completion of payment. The URL must accept incoming POST requests. The callback URL will have razorpay_payment_id, razorpay_order_id and razorpay_signature as the request parameters for a successful payment.

redirect

conditionally mandatory

boolean Determines whether customer should be redirected to the URL mentioned in the callback_url parameter. This is mandatory if callback_url parameter is used. Possible values:

true: Customer will be redirected to the callback_url.
false: Customer will not be redirected to the callback_url

notes

mandatory

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

invoice_number

mandatory

string Invoice number of the invoice generated. Ensure each payment has a unique invoice number.

goods_description

mandatory

string Description of the goods. For example, Digital Lamp.

1.5 Store Fields in your Server

A successful payment returns the following fields to the Checkout form.

You need to store these fields in your server.
You can confirm the authenticity of these details by verifying the signature in the next step.

razorpay_payment_id

string Unique identifier for the payment returned by Checkout only for successful payments.

razorpay_order_id

string Unique identifier for the order returned by Checkout.

razorpay_signature

string Signature returned by the Checkout. This is used to verify the payment.

A failed payment returns an error response.

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "Authentication failed due to incorrect otp",
    "field": null,
    "source": "customer",
    "step": "payment_authentication",
    "reason": "invalid_otp",
    "metadata": {
      "payment_id": "pay_EDNBKIP31Y4jl8",
      "order_id": "order_DBJKIP31Y4jl8"
    }
  }
}

Know more about

Error Codes

1.6 Verify Payment Signature

This is a mandatory step to confirm the authenticity of the details returned to the Checkout form for successful payments.

To verify the razorpay_signature returned to you by the Checkout form:

Create a signature in your server using the following attributes:
- order_id: Retrieve the order_id from your server. Do not use the razorpay_order_id returned by Checkout.
- razorpay_payment_id: Returned by Checkout.
- key_secret: Available in your server. The key_secret that was generated from the
  Dashboard
  .

Use the SHA256 algorithm, the razorpay_payment_id and the order_id to construct a HMAC hex digest as shown below:

generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);

  if (generated_signature == razorpay_signature) {
    payment is successful
  }

If the signature you generate on your server matches the razorpay_signature returned to you by the Checkout form, the payment received is from an authentic source.

Generate Signature on Your Server

Given below is the sample code for payment signature verification:

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");


String secret = "EnLs21M47BllR3X8PSFtjtbd";


JSONObject options = new JSONObject();
options.put("razorpay_order_id", "order_IEIaMR65cu6nz3");
options.put("razorpay_payment_id", "pay_IH4NVgf4Dreq1l");
options.put("razorpay_signature", "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f");


boolean status =  Utils.verifyPaymentSignature(options, secret);

Post Signature Verification

After you have completed the integration, you can

set up webhooks

, make test payments, replace the test key with the live key and integrate with other

APIs

1.7 Verify Payment Status

Handy Tips

On the Dashboard, ensure that the payment status is captured. Refer to the payment capture settings page to know how to

capture payments automatically

You can track the payment status in three ways:

To verify the payment status from the Dashboard:

Log in to the Dashboard and navigate to Transactions → Payments.
Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.

Check if the payment id is generated and the status is captured

Next Steps

Step 2: Test Integration