1. Build Integration
List of steps to build the integration.
Follow these steps to integrate the hosted checkout form on your website:
1.1
.1.2 .
1.3 .
1.4 .
1.5
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.
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": 100,"currency": "MYR","receipt": "qwsaq1","partial_payment": true,"first_payment_min_amount": 230,"notes": {"key1": "value3","key2": "value2"}}'
amount
mandatory
integer
The transaction amount, expressed in the currency subunit, such as Ringgit (in case of MY). For example, for an actual amount of RM 299.35 , the value of this field should be 29935
.
currency
mandatory
string
The currency in which the transaction should be made. Length must be of 3 characters. For example, MYR
.
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 RM 7,000.00 is to be received from the customer in two installments of #1 - RM 5,000, #2 - RM 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
.Add the Pay button on your web page using the checkout code given below. The hosted checkout page is displayed when the customers click the Pay button.
The Checkout options are sent as form-data to the following URL in a POST request.
POST: https://api.razorpay.com/v1/checkout/embedded
The sample code is given below:
<form method="POST" action="https://api.razorpay.com/v1/checkout/embedded"><input type="hidden" name="key_id" value="YOUR_KEY_ID"/><input type="hidden" name="amount" value=1001/><input type="hidden" name="order_id" value="razorpay_order_id"/><input type="hidden" name="name" value="Acme Corp"/><input type="hidden" name="description" value="A Wild Sheep Chase"/><input type="hidden" name="image" value="https://cdn.razorpay.com/logos/BUVwvgaqVByGp2_large.jpg"/><input type="hidden" name="prefill[name]" value="Gaurav Kumar"/><input type="hidden" name="prefill[contact]" value="9123456780"/><input type="hidden" name="prefill[email]" value="gaurav.kumar@example.com"/><input type="hidden" name="notes[shipping address]" value="L-16, The Business Centre, 61 Wellfield Road, New Delhi - 110001"/><input type="hidden" name="callback_url" value="https://example.com/payment-callback"/><input type="hidden" name="cancel_url" value="https://example.com/payment-cancel"/><button>Submit</button></form>
- For every successful payment,
razorpay_payment_id
,razorpay_order_id
andrazorpay_signature
are submitted via a POST request to thecallback_url
passed in payment options. - If your customer cancels the transaction or clicks the back button, they are redirected to the
cancel_url
via a GET request. - If the payment fails, a POST request is made to the
callback_url
, with the error fields as payload.
key_id
mandatory
string
Enter [YOUR_Key_ID] generated from the
name
mandatory
string
The business name to be shown in the checkout form.
description
optional
string
Description of the item purchased shown in the checkout form.
image
optional
string
URL of the logo that must appear on the checkout form. It is recommended to
order_id
mandatory
string
Unique identifier of the Order, created using the Orders API.
amount
mandatory
integer
Enter the amount to charge the customer in currency subunits. For example, if charging the customer INR 200, enter 20000.
currency
mandatory
string
Enter the currency to be used in the payment. Ensure that currency of the payment matches the Order currency. Defaults to INR. We support more than
method
optional
string
Use this parameter to show a specific payment method in Checkout. Possible values:
card
netbanking
wallet
upi
paylater
prefill
The fields that can be pre-populated in the Checkout form.
name
optional
string
Name of the cardholder.
mandatory
string
Email address of the customer.
contact
mandatory
string
Customer's phone number.
notes
optional
object
An additional set of fields that you want to associate with the payment. For example, you can add "shipping address" and "alternate contact" in the Notes field. You can specify up to 15 note fields.
[Shipping address]
string
106, Razorpay, Bangalore
[Alternate contact]
string
9000090000
callback_url
mandatory
string
Page to which the customers are redirected to after a successful payment. razorpay_payment_id
, razorpay_order_id
and razorpay_signature
are sent as form-data through a POST
request to the callback_url
.
cancel_url
optional
string
The URL customers are redirected to after the cancellation of a payment.
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 .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 . - Subscribe to our webhooks or poll the Fetch a Payment API to track the payment status.
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.
You can use Curlec 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
If you have subscribed to the order.paid
webhook event, you will receive a notification every time a customer pays you for an order.
to check the payment status.
Is this integration guide useful?