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
.1.2
.1.3
.1.3.1
.1.3.2
.1.3.3
.1.4
.1.5
.1.6
.Order is an important step in the payment process.
- An order should be created for every payment.
- You can create an order using the . It is a server-side API call. Know how to 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.
Here is the list of parameters and their description for creating an order:
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.
id
mandatory
string
Unique identifier of the customer. For example, cust_1Aa00000000004
.
Know more about
.The error response parameters are available in the
.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:
Know more about
offered by Razorpay.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.
var razorpay = new Razorpay({key: '<YOUR_KEY_ID>',// logo, displayed in the payment processing popupimage: 'https://i.imgur.com/n5tjHFD.jpg',});
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 popupimage: 'https://i.imgur.com/n5tjHFD.jpg',})new Razorpay({}); // will inherit key and image from above.
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 →
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
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).
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
.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
andrazorpay_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 therazorpay_payment_id
,razorpay_order_id
andrazorpay_signature
in the response object of the successful payment (razorpay_payment_id
andrazorpay_order_id
).
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
.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 theorder_id
from your server. Do not use therazorpay_order_id
returned by Checkout.razorpay_payment_id
: Returned by Checkout.key_secret
: Available in your server. Thekey_secret
that was generated from the .
-
Use the SHA256 algorithm, the
razorpay_payment_id
and theorder_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.
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);
After you have completed the integration, you can
, make test payments, replace the test key with the live key and integrate with other .Handy Tips
On the Razorpay Dashboard, ensure that the payment status is captured
. Refer to the payment capture settings page to know how to
You can track the payment status in three ways:
To verify the payment status from the Razorpay Dashboard:
- Log in to the Razorpay 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.
Is this integration guide useful?
ON THIS PAGE