Integrate Razorpay Standard Checkout with your website to start accepting online payments from your customers. Razorpay supports a slew of payment methods such as netbanking, credit and debit cards, wallets and UPI. Our Standard Checkout library provides all the essential features for integrating Razorpay Checkout with the client-side of your application. This is available only for web-based integrations.
Integration Best Practices:
Learn about the best practices to follow while integrating Razorpay Standard Checkout on your website.
Note:
If your website is built on top of an ecommerce platform, such as WordPress or Shopify, please refer to Razorpay Ecommerce Plugins documentation.
If you want to add a pay button to your website without any integration, use Razorpay Payment Button.
Payments accepted from registered websites only:
You can accept payments only from those websites that you had registered with us at the time of signing up for an account. All payments received on the unregistered websites are failed by Razorpay. If you want to accept payments from multiple websites, contact our support team to register additional websites for your account.
Check if view port meta tag is added in the tag of your webpage HTML code. If not, add the following line. <meta name="viewport" content="width=device-width, initial-scale=1.0">Note: If this meta tag is not present, there will be overflow issues.
Copy$order = $client->order->create([
'receipt' => 'order_rcptid_11',
'amount' => 50000, // amount in the smallest currency unit'currency' => 'INR',// <a href="/docs/payment-gateway/payments/international-payments/#supported-currencies" target="_blank">See the list of supported currencies</a>.)
]);
CopyDictionary<string, object> options = new Dictionary<string,object>();
options.Add("amount", 50000); // amount in the smallest currency unit
options.add("receipt", "order_rcptid_11");
options.add("currency", "INR");
Order order = client.Order.Create(options);
Copyoptions = amount:50000, currency:'INR', receipt:'<order_rcptid_11>',
order = Razorpay::Order.create
Copyvar options = {
amount: 50000, // amount in the smallest currency unit
currency: "INR",
receipt: "order_rcptid_11"
};
instance.orders.create(options, function(err, order) {
console.log(order);
});
An order id (referred as order_id) is generated on the successful creation of an order. You should store this order id in your system against the order.
integer The transaction amount, expressed in the currency subunit, such as paise (in case of INR). For example, for an actual amount of ₹299.35, the value of this field should be 29935.
currencymandatory
string The currency in which the transaction should be made. See the list of supported currencies. Default is INR. Length must be of 3 characters.
receiptoptional
string Your receipt id for this order should be passed here. Maximum length of 40 characters.
notesoptional
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”.
The id obtained in the response should be passed as order_id along with other data attributes as described in the section below.
When you use this: ● On successful payment, customer will be shown your webpage. ● On payment failure, customer will be notified on the reason of failure and asked to retry the payment.
When you use this: ● On successful payment, customer will be redirected to the specified URL, for example, a payment success page. ● On payment failure, customer will be asked to retry payment on Checkout.
Copy-paste the form parameters as options in your HTML code:
Copy<buttonid="rzp-button1">Pay</button><scriptsrc="https://checkout.razorpay.com/v1/checkout.js"></script><script>var options = {
"key": "YOUR_KEY_ID", // Enter the Key ID generated from the Dashboard"amount": "50000", // Amount is in currency subunits. Default currency is INR. Hence, 50000 refers to 50000 paise"currency": "INR",
"name": "Acme Corp",
"description": "Test Transaction",
"image": "https://example.com/your_logo",
"order_id": "order_9A33XWu170gUtm", //This is a sample Order ID. Pass the `id` obtained in the response of Step 1"handler": function (response){
alert(response.razorpay_payment_id);
alert(response.razorpay_order_id);
alert(response.razorpay_signature)
},
"prefill": {
"name": "Gaurav Kumar",
"email": "gaurav.kumar@example.com",
"contact": "9999999999"
},
"notes": {
"address": "Razorpay Corporate Office"
},
"theme": {
"color": "#3399cc"
}
};
var rzp1 = new Razorpay(options);
rzp1.on('payment.failed', function (response){
alert(response.error.code);
alert(response.error.description);
alert(response.error.source);
alert(response.error.step);
alert(response.error.reason);
alert(response.error.metadata.order_id);
alert(response.error.metadata.payment_id);
});
document.getElementById('rzp-button1').onclick = function(e){
rzp1.open();
e.preventDefault();
}
</script>
Copy<buttonid="rzp-button1">Pay</button><scriptsrc="https://checkout.razorpay.com/v1/checkout.js"></script><script>var options = {
"key": "YOUR_KEY_ID", // Enter the Key ID generated from the Dashboard"amount": "50000", // Amount is in currency subunits. Default currency is INR. Hence, 50000 refers to 50000 paise"currency": "INR",
"name": "Acme Corp",
"description": "Test Transaction",
"image": "https://example.com/your_logo",
"order_id": "order_9A33XWu170gUtm", //This is a sample Order ID. Pass the `id` obtained in the response of Step 1"callback_url": "https://eneqd3r9zrjok.x.pipedream.net/",
"prefill": {
"name": "Gaurav Kumar",
"email": "gaurav.kumar@example.com",
"contact": "9999999999"
},
"notes": {
"address": "Razorpay Corporate Office"
},
"theme": {
"color": "#3399cc"
}
};
var rzp1 = new Razorpay(options);
document.getElementById('rzp-button1').onclick = function(e){
rzp1.open();
e.preventDefault();
}
</script>
Note:
The open method of Razorpay object (rzp1.open()) must be invoked by your site's JavaScript, which may or may not be a user-driven action such as a click.
Note:
You can also integrate the Razorpay Payment Gateway using the Automatic Checkout method. Learn more about it in our Quick Integration Document.
Razorpay Standard Checkout hosts a variety of payment methods for customers to make payments. The order of these payment methods on the Checkout is fixed and cannot be interchanged. There can be situations where you want certain payment methods to be shown more prominently or rearrange the order in which the payment methods are displayed on the Checkout.
Now, you can configure the payment methods of your choice on the Checkout to provide a highly personalized experience for your customers. This simple and accessible experience for them will not only increase your sales but also the success rates. Learn how to configure payment methods on Checkout.
If you used the sample code with the handler function, then:
On Payment Success:
Customer will be shown your page and the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is returned by Checkout. You need to collect these and send them to your server.
Copy"handler": function (response){
alert(response.razorpay_payment_id);
alert(response.razorpay_order_id);
alert(response.razorpay_signature)}
On Payment Failure:
On payment failure, customer will be notified on the reason of failure and asked to retry the payment.
If you used the sample code with the callback URL, then:
On Payment Success:
When you use a Callback URL, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Callback URL. Only successful authorizations are auto-submitted.
On Payment Failure:
In case of failed payments, the Checkout Form is displayed again to facilitate retry of the payments.
A successful payment returns the following fields to the Checkout Form. Make provisions to store these fields on your server. You can confirm the authenticity of these details by verifying the signature in the next step.
This is a mandatory step that allows you 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:
Copygenerated_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.
Copy/**
* This class defines common routines for generating
* authentication signatures for Razorpay Webhook requests.
*/publicclassSignature{
privatestaticfinal String HMAC_SHA256_ALGORITHM = "HmacSHA256";
/**
* Computes RFC 2104-compliant HMAC signature.
* * @param data
* The data to be signed.
* @param key
* The signing key.
* @return
* The Base64-encoded RFC 2104-compliant HMAC signature.
* @throws
* java.security.SignatureException when signature generation fails
*/publicstatic String calculateRFC2104HMAC(String data, String secret)throws java.security.SignatureException
{
String result;
try {
// get an hmac_sha256 key from the raw secret bytes
SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(), HMAC_SHA256_ALGORITHM);
// get an hmac_sha256 Mac instance and initialize with the signing key
Mac mac = Mac.getInstance(HMAC_SHA256_ALGORITHM);
mac.init(signingKey);
// compute the hmac on input data bytesbyte[] rawHmac = mac.doFinal(data.getBytes());
// base64-encode the hmac
result = DatatypeConverter.printHexBinary(rawHmac).toLowerCase();
} catch (Exception e) {
thrownew SignatureException("Failed to generate HMAC : " + e.getMessage());
}
return result;
}
}
After verifying the signature, fetch the order in your system that corresponds to the razorpay_order_id in your database. Mark it as successful and process the order.
Once authorized, you need to capture payments made by customers for them to get settled to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time period. You can:
Auto-capture payments (recommended) Authorized payments can be automatically captured. You can auto-capture all payments using global settings on the Dashboard.
Manually capture payments Each authorized payment can also be captured individually. You can manually capture payments:
Now that the integration is complete, you must ensure that your integration works as expected. You can make a test transaction using the test cards, verify the payment status from Dashboard, APIs or subscribe to related Webhook events to take appropriate actions at your end. After testing the integration in test mode, you can start accepting payments from your customers in real-time.
You can make test payments using any of the payment methods configured on the Checkout. No money is deducted from the customer's account as this is a simulated transaction. In the Checkout code, ensure that you have entered the API keys generated in the test mode.
You can use any of the test cards to make transactions in the test mode. Use any valid expiration date in the future and any random CVV to create a successful payment.
You can subscribe to a Webhook event that is generated when a certain event happens in our server. When one of those events is triggered, Razorpay sends the Webhook payload to the configured URL.
After testing the flow of funds end-to-end in test mode, you are now ready to take your integration live. Once you are confident that the integration is working fine, you can switch to the live mode and start accepting payments from customers. But first, you need to swap the test API keys with the live keys.
To generate API key in live mode:
Log into Dashboard and switch to Live mode on the menu.
Navigate to Settings → API Keys → Generate Key to generate API key for live mode.
Download the keys and save it securely.
Replace the test API key with the Live Key in the Checkout code and start accepting real-time payments.
The transaction timeout is applicable only when your customer attempts the payment.
The timeout is 3 to 15 minutes for an attempted payment. If there is a payment failure due to timeout, the customer is redirected to the Checkout page.