1. Build Integration

Steps to integrate the Custom Checkout form on your website.

Follow the steps to integrate Custom Checkout in your site:

1.1

Create an Order in Server

1.2

Fetch Payment Methods

1.3

Invoke Checkout and Pass Order Id and Other Options to it

1.3.1

Include JavaScript code in your Webpage

1.3.2

Instantiate Custom Checkout

1.3.3

Submit Payment Details

1.4

Store Fields in your Server

1.5

Verify Payment Signature

1.6

Verify Payment Status

1.1 Create an Order in Server

Order is an important step in the payment process.

An order should be created for every payment.
You can create an order using the
Orders API
. It is a server-side API call. Know how to
authenticate
Orders API.
The order_id received in the response should be passed to the checkout. This ties the Order with the payment and secures the request from being tampered.

API Sample Code

The following is a sample API request and response for creating an order:

curl -X POST https://api.razorpay.com/v1/orders
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
    "amount": 50000,
    "currency": "INR",
    "receipt": "rcptid_11",
    "partial_payment": true,
    "first_payment_min_amount": 23000
}'

Request Parameters

Here is the list of parameters and their description for creating an order:

amount

mandatory

integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of ₹299.35, the value of this field should be 29935.

currency

mandatory

string The currency in which the transaction should be made. See the

list of supported currencies

. Length must be 3 characters.

receipt

optional

string Your receipt id for this order should be passed here. Maximum length is 40 characters.

notes

optional

json 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”.

partial_payment

optional

boolean Indicates whether the customer can make a partial payment. Possible values:

true: The customer can make partial payments.
false (default): The customer cannot make partial payments.

mandatory

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

Know more about

Orders API

Error Response Parameters

The error response parameters are available in the

API Reference Guide

1.2 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.3 Invoke Checkout and Pass Order Id and Other Options to it

1.3.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 serving 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.3.2 Instantiate Custom Checkout

Single Instance on a Page

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

Multiple Instances on Same Page

If you need multiple Razorpay instances on the same page, you can globally set some of the options:

Razorpay.configure({
  key: '<YOUR_KEY_ID>',
    // logo, displayed in the payment processing popup
  image: 'https://i.imgur.com/n5tjHFD.jpg',
})
new Razorpay({}); // will inherit key and image from above.

Checkout Options

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

key

mandatory

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

API Keys

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

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

notes

optional

object Set of key-value pairs that can be used to store additional information about the payment. It can hold a maximum of 15 key-value pairs, each 256 characters long (maximum).

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 Visa and Amex tokenised cards.
To enable CVV-less flow for Rupay and MasterCard, contact our
support team
.
CVV is mandatory for Diners tokenised cards.
CVV is an optional field. Skip passing the cvv parameter to Razorpay to implement this change.

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

1.3.3 Submit Payment Details

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

Know more about

sample codes for various 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',
  notes: {
    address: 'Ground Floor, SJR Cyber, Laskar Hosur Road, Bengaluru',
  },
  order_id: 'order_CuEzONfnOI86Ab',// Replace with Order ID generated in Step 4
  method: 'netbanking',

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

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 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(...) })

Handy Tips

Handler Function
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.
Callback URL
When you use a callback URL, Razorpay makes a post call to the callback URL, with the razorpay_payment_id, razorpay_order_id and razorpay_signature in the response object of the successful payment (razorpay_payment_id and razorpay_order_id).

1.4 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.5 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
  Razorpay 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.6 Verify Payment Status

You can track the payment status in three ways:

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
.
Subscribe to our webhooks or poll the Fetch a Payment API to track the payment status.

Verify Status from Dashboard

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

You can use Razorpay webhooks to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook's configured URL. Know how to

set up webhooks.

Example

If you have subscribed to the order.paid webhook event, you will receive a notification every time a customer pays you for an order.

Poll APIs

Poll Payment APIs

to check the payment status.

Next Steps

Step 2: Test Integration

Is this integration guide useful?