Integration Steps
Steps to integrate with Razorpay Quick Integration.
Follow these steps to integrate the standard checkout form on your website:
- : Use the sample codes to integrate the Razorpay Quick Integration on your website.
- : Make a test payment using the payment methods configured at checkout to ensure the integration is working as expected.
- : Check the go-live checklist before taking the integration live.
Follow the steps given below:
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.
You can create an order using:
Use this endpoint to create an order using the Orders API.
curl -X POST https://api.razorpay.com/v1/orders-U [YOUR_KEY_ID]:[YOUR_KEY_SECRET]-H 'content-type:application/json'-d '{"amount": 500,"currency": "INR","receipt": "qwsaq1","partial_payment": true,"first_payment_min_amount": 230}'
{"id": "order_IluGWxBm9U8zJ8","entity": "order","amount": 5000,"amount_paid": 0,"amount_due": 5000,"currency": "INR","receipt": "rcptid_11","offer_id": null,"status": "created","attempts": 0,"notes": [],"created_at": 1642662092}
amount
mandatory
integer
Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is ₹299.00, then pass 29900
in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to accept a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to accept a payment of 295, pass the value as 295.
Watch Out!
As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to charge a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990
and not 99991
.
currency
mandatory
string
The currency in which the transaction should be made. See the
Handy Tips
Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about
(May 2024).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.
first_payment_min_amount
optional
integer
Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of ₹7,000 is to be received from the customer in two installments of #1 - ₹5,000, #2 - ₹2,000, then you can set this value as 500000
. This parameter should be passed only if partial_payment
is true
.
Descriptions for the response parameters are present in the
parameters table.The error response parameters are available in the
.- This integration method provides a default Pay with Razorpay button that invokes the Checkout form.
- Pass Checkout form options as data attributes inside a
<script>
tag. You can add any additional hidden or visible fields to the form, which will be submitted along with the form. - Send Checkout options as form-data to the following URL in a POST request.
The following sample code passes the Razorpay checkout options as HTML data attributes:
<form action="https://www.example.com/success/" method="POST"><scriptsrc="https://checkout.razorpay.com/v1/checkout.js"data-key="YOUR_KEY_ID" // Enter the Test API Key ID generated from Dashboard → Settings → API Keysdata-amount="29935" // Amount is in currency subunits. Hence, 29935 refers to 29935 paise or ₹299.35.data-currency="INR"// You can accept international payments by changing the currency code. Contact our Support Team to enable International for your accountdata-order_id="order_CgmcjRh9ti2lP7"// Replace with the order_id generated by you in the backend.data-buttontext="Pay with Razorpay"data-name="Acme Corp"data-description="A Wild Sheep Chase is the third novel by Japanese author Haruki Murakami"data-image="https://example.com/your_logo.jpg"data-prefill.name="Gaurav Kumar"data-prefill.email="gaurav.kumar@example.com"data-theme.color="#F37254"></script><input type="hidden" custom="Hidden Element" name="hidden"/></form>
The way the payment success and failure scenarios are handled depends on the
you used in the previous step.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. Only successful authorisations are auto-submitted.
data-key
mandatory
string
API Key ID generated from the Razorpay Dashboard.
data-amount
mandatory
integer
The amount to be paid by the customer in cents. For example, if the amount is ₹500.00, enter 50000
.
data-currency
mandatory
string
The currency in which the payment should be made by the customer. See the
data-order_id
mandatory
string
Unique identifier of the Order generated in
data-buttontext
mandatory
string
The text you want to display on the button. For example, Buy Now!
.
data-name
mandatory
string
Your Business/Enterprise name shown on the Checkout form. For example, Acme Corp.
data-description
optional
string
Description of the purchase item shown on the Checkout form. It should start with an alphanumeric character.
data-image
mandatory
string
Link to an image (usually your business logo) shown on the Checkout form. Can also be a base64 string if you are not loading the image from a network.
data-prefill.name
optional
string
Cardholder's name to be pre-filled when the Checkout opens.
data-prefill.email
optional
string
Customer's email to be pre-filled when the Checkout opens.
data-prefill.contact
optional
string
Customer's phone number to be pre-filled when the Checkout opens.
data-theme.color
optional
string
Brand color to alter the appearance of Checkout form. For example, #F37254
.
Know more about the complete
.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.
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 .Here are the links to our
for the supported platforms.Handy Tips
On the 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 Dashboard:
- Log in to the 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](build/browser/assets/images/testpayment.jpg)
After the integration is complete, a Pay button appears on your webpage/app.
![Test integration on your webpage/app](build/browser/assets/images/test-int.gif)
Click the button and make a test transaction to ensure the integration is working as expected. You can start accepting actual payments from your customers once the test transaction is successful.
You can make test payments using one of the payment methods configured at the Checkout.
Watch Out!
This is a mock payment page that uses your test API keys, test card and payment details.
- Ensure you have entered only your in the Checkout code.
- No real money is deducted due to the usage of test API keys. This is a simulated transaction.
Following are all the payment modes that the customer can use to complete the payment on the Checkout. Some of them are available by default, while others require approval from us. Raise a request from the
to enable such payment methods.Payment Method | Code | Availability |
---|---|---|
debit | ✓ | |
credit | ✓ | |
netbanking | ✓ | |
upi | ✓ | |
EMI - , and | emi | ✓ |
wallet | ✓ | |
cardless_emi | Requires . | |
bank_transfer | Requires and Integration. | |
emandate | Requires and Integration. | |
paylater | Requires . |
You can select any of the listed banks. After choosing a bank, Razorpay will redirect to a mock page where you can make the payment success
or a failure
. Since this is Test Mode, we will not redirect you to the bank login portals.
Check the list of
.You can enter one of the following UPI IDs:
success@razorpay
: To make the payment successful.failure@razorpay
: To fail the payment.
Check the list of
.Handy Tips
UPI payments should be tested in Live Mode.
You can use one of the following test cards to test transactions for your integration in Test Mode.
- Use any valid expiration date in the future in the MM/YY format.
- Use any random CVV to create a successful payment.
Card Network | Domestic / International | Card Number |
---|---|---|
Mastercard | Domestic | 5267 3181 8797 5449 |
Visa | Domestic | 4111 1111 1111 1111 |
Mastercard | International | 5555 5555 5555 4444 5105 1051 0510 5100 |
Visa | International | 4012 8888 8888 1881 5104 0600 0000 0008 |
Check the list of
.You can select any of the listed wallets. After choosing a wallet, Razorpay will redirect to a mock page where you can make the payment success
or a failure
. Since this is Test Mode, we will not redirect you to the wallet login portals.
Check the list of
.Check the go-live checklist for Razorpay Web Standard Checkout integration. Consider these steps before taking the integration live.
You can perform an end-to-end simulation of funds flow in the Test Mode. Once confident that the integration is working as expected, switch to the Live Mode and start accepting payments from customers.
Watch Out!
Ensure you are switching your test API keys with API keys generated in Live Mode.
To generate API Keys in Live Mode on your Razorpay Dashboard:
- Log in to the and switch to Live Mode on the menu.
- Navigate to Account & Settings → API Keys → Generate Key to generate the API Key for Live Mode.
- Download the keys and save them securely.
- Replace the Test API Key with the Live Key in the Checkout code and start accepting actual payments.
After payment is authorized
, you need to capture it to settle the amount to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time.
Watch Out
- You should deliver the products or services to your customers only after the payment is captured. Razorpay automatically refunds all the uncaptured payments.
- You can track the payment status using our or webhooks.
- Auto-capture payments (recommended)
Authorized payments can be automatically captured. You can auto-capture all payments on the Razorpay Dashboard.
Watch Out!
Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the
.- Manually capture payments
Each authorized payment can also be captured individually. You can manually capture payments using:
Know more about
.Ensure you have
in the live mode and configured the events for which you want to receive notifications.Is this integration guide useful?