> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-881012b3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Integration Steps
> Steps to integrate with Razorpay Hosted Web Integration.
Available in🇮🇳 India
Watch this video to know how to integrate Razorpay Hosted Checkout on your website.
Follow these steps to integrate the Hosted Checkout form on your website:
1. [Build Integration](#1-build-integration): Use the sample codes to integrate the Razorpay Hosted Integration on your website.
2. [Test Integration](#2-test-integration): Make a test payment using the payment methods configured at checkout to ensure the integration is working as expected.
3. [Go-live Checklist](#3-go-live-checklist): Check the go-live checklist before taking the integration live.
## 1. Build Integration
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 [Orders API](#api-sample-code). It is a server-side API call. Know how to [authenticate](/docs/payments/dashboard/account-settings/api-keys#generate-api-keys) 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.
**Watch Out!**
Payments made without an `order_id` cannot be captured and will be automatically refunded. You must create an order before initiating payments to ensure proper payment processing.
You can create an order using:
Use this endpoint to create an order using the Orders API.
`POST /orders`
```bash Curl theme={null}
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": "qwsaq1",
"partial_payment": true,
"first_payment_min_amount": 230
}'
```
```java Java theme={null}
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
JSONObject orderRequest = new JSONObject();
orderRequest.put("amount", 50000); // amount in the smallest currency unit
orderRequest.put("currency", "INR");
orderRequest.put("receipt", "order_rcptid_11");
Order order = razorpay.Orders.create(orderRequest);
} catch (RazorpayException e) {
// Handle Exception
System.out.println(e.getMessage());
}
```
```python Python theme={null}
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
DATA = {
"amount": 50000,
"currency": "INR",
"receipt": "receipt#1",
"notes": {
"key1": "value3",
"key2": "value2"
}
}
client.order.create(data=DATA)
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->order->create(array('receipt' => '123', 'amount' => 50000, 'currency' => 'INR', 'notes'=> array('key1'=> 'value3','key2'=> 'value2')));
```
```csharp .NET theme={null}
RazorpayClient client = new RazorpayClient(your_key_id, your_secret);
Dictionary options = new Dictionary();
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);
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
options = amount: 50000, currency: 'INR', receipt: ''
order = Razorpay::Order.create
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.orders.create({
amount: 50000,
currency: "INR",
receipt: "receipt#1",
notes: {
key1: "value3",
key2: "value2"
}
})
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
data := map[string]interface{}{
"amount": 50000,
"currency": "INR",
"receipt": "some_receipt_id"
}
body, err := client.Order.Create(data)
```
```json Success Response theme={null}
{
"id": "order_IluGWxBm9U8zJ8",
"entity": "order",
"amount": 50000,
"amount_paid": 0,
"amount_due": 50000,
"currency": "INR",
"receipt": "rcptid_11",
"offer_id": null,
"status": "created",
"attempts": 0,
"notes": [],
"created_at": 1642662092
}
```
```json Failure Response theme={null}
{
"error": {
"code": "BAD_REQUEST_ERROR",
"description": "Order amount less than minimum amount allowed",
"source": "business",
"step": "payment_initiation",
"reason": "input_validation_failed",
"metadata": {},
"field": "amount"
}
}
```
You can use the Postman workspace below to create an order:
**Handy Tips**
Under the **Authorization** section in Postman, select **Basic Auth** and add the Key Id and secret as the Username and Password, respectively.
You can create an order manually by integrating the API sample codes on your server.
`amount` *mandatory*
: `integer` The transaction amount, expressed in the currency subunit. For example, for an actual amount of , the value of this field should be `22225`.
`currency` *mandatory*
: `string` The currency in which the transaction should be made. See the [list of supported currencies](/docs/payments/international-payments#supported-currencies). Length must be of 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.
`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 [Orders Entity](/docs/api/orders/entity) parameters table.
The error response parameters are available in the [API Reference Guide](/docs/api/orders/create).
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:
```html Hosted Checkout theme={null}
```
* For every successful payment, `razorpay_payment_id`, `razorpay_order_id` and `razorpay_signature` are submitted via a POST request to the `callback_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 [Dashboard](/docs/payments/dashboard/account-settings/api-keys#generate-api-keys).
`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.
`order_id` *mandatory*
: `string` Unique identifier of the Order, created using the Orders API.
`amount` *mandatory*
: `integer` Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is ₹299, 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` Currency code for the currency in which you want to accept the payment. For example, `INR`. Refer to the [supported currencies](/docs/payments/international-payments#supported-currencies) for a list of supported international currencies.
**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 [Currency Conversion](/docs/payments/international-payments/currency-conversion) (May 2024).
`method` *optional*
: `string` Use this parameter to display 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.
`email` *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`.
**Handy Tips**
Callback URL is not required if you are using the native SDK for Android/iOS.
`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.
```json Success Callback theme={null}
{
"razorpay_payment_id": "pay_29QQoUBi66xm2f",
"razorpay_order_id": "order_9A33XWu170gUtm",
"razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d"
}
```
`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.
1. 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](/docs/payments/dashboard/account-settings/api-keys#generate-api-keys).
2. Use the SHA256 algorithm, the `razorpay_payment_id` and the `order_id` to construct a HMAC hex digest as shown below:
```html HMAC Hex Digest theme={null}
generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);
if (generated_signature == razorpay_signature) {
payment is successful
}
```
3. 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:
```java Java theme={null}
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);
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->utility->verifyPaymentSignature(array('razorpay_order_id' => $razorpayOrderId, 'razorpay_payment_id' => $razorpayPaymentId, 'razorpay_signature' => $razorpaySignature));
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
payment_response = {
razorpay_order_id: 'order_IEIaMR65cu6nz3',
razorpay_payment_id: 'pay_IH4NVgf4Dreq1l',
razorpay_signature: '0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f'
}
Razorpay::Utility.verify_payment_signature(payment_response)
```
```python Python theme={null}
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.utility.verify_payment_signature({
'razorpay_order_id': razorpay_order_id,
'razorpay_payment_id': razorpay_payment_id,
'razorpay_signature': razorpay_signature
})
```
```c .NET theme={null}
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
Dictionary options = new Dictionary();
options.Add("razorpay_order_id", "order_IEIaMR65");
options.Add("razorpay_payment_id", "pay_IH4NVgf4Dreq1l");
options.Add("razorpay_signature", "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50");
Utils.verifyPaymentSignature(options);
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
var { validatePaymentVerification, validateWebhookSignature } = require('./dist/utils/razorpay-utils');
validatePaymentVerification({"order_id": razorpayOrderId, "payment_id": razorpayPaymentId }, signature, secret);
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
params := map[string]interface{}{
"razorpay_order_id": "order_IEIaMR65cu6nz3",
"razorpay_payment_id": "pay_IH4NVgf4Dreq1l",
}
signature := "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f";
secret := "EnLs21M47BllR3X8PSFtjtbd";
utils.VerifyPaymentSignature(params, signature, secret)
```
After you have completed the integration, you can [set up webhooks](/docs/webhooks/setup-edit-payments), make test payments, replace the test key with the live key and integrate with other [APIs](/docs/api).
Here are the links to our [SDKs](/docs/payments/payment-gateway/web-integration/standard#github-and-documentation-links-for-sdks) for the supported platforms.
**Handy Tips**
On the Razorpay Dashboard, ensure that the payment status is `captured`. Refer to the payment capture settings page to know how to [capture payments automatically](/docs/payments/payments/capture-settings).
To verify the payment status from the Razorpay Dashboard:
1. Log in to the Razorpay Dashboard and navigate to **Transactions** → **Payments**.
2. 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 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.](/docs/webhooks/setup-edit-payments)
#### 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 Payment APIs](/docs/api/payments/fetch-all-payments) to check the payment status.
## 2. Test Integration
After the integration is complete, a **Pay** button appears on your webpage/app.
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 [Test Mode API keys](/docs/payments/dashboard/account-settings/api-keys#generate-api-keys) in the Checkout code.
* Test mode features a mock bank page with **Success** and **Failure** buttons to replicate the live payment experience.
* 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 Dashboard to enable such payment methods.
| Payment Method | Code | Availability |
| ------------------------------------------------------- | ------------ | -------------------------------------------------- |
| [Debit Card](/docs/payments/payment-methods/cards) | `debit` | ✓ |
| [Credit Card](/docs/payments/payment-methods/cards) | `credit` | ✓ |
| [Netbanking](/docs/payments/payment-methods/netbanking) | `netbanking` | ✓ |
| [UPI](/docs/payments/payment-methods/upi) | `upi` | ✓ |
| [Wallet](/docs/payments/payment-methods/wallets) | `wallet` | ✓ |
| [Pay Later](/docs/payments/payment-methods/pay-later) | `paylater` | Requires [Approval](https://razorpay.com/support). |
### Netbanking
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 [supported banks](/docs/payments/payment-methods/netbanking#supported-banks).
### UPI
You can enter one of the following UPI IDs:
* `success@razorpay`: To make the payment successful.
* `failure@razorpay`: To fail the payment.
Check the following lists:
* [Supported UPI Flows](/docs/payments/payment-methods/upi).
* [UPI Error Codes](/docs/errors/payments/upi).
**Handy Tips**
You can use **Test Mode** to test UPI payments, and **Live Mode** for UPI Intent and QR payments.
### Cards
You can use the following test cards to test transactions for your integration in Test Mode.
#### Domestic Cards
Use the following test cards for Indian payments:
| Network | Card Number | CVV & Expiry Date |
| ---------- | ------------------- | ------------------------------------------ |
| Visa | 4100 2800 0000 1007 | Use a random CVV and any future date ^^^^^ |
| Mastercard | 5500 6700 0000 1002 | |
| RuPay | 6527 6589 0000 1005 | |
| Diners | 3608 280009 1007 | |
| Amex | 3402 560004 01007 | |
Check the following lists:
* [Supported Card Networks](/docs/payments/payment-methods/cards).
* [Cards Error Codes](/docs/errors/payments/cards).
* [Test Error Scenarios](/docs/payments/payments/test-card-details#error-scenario-test-cards).
#### International Cards
Use the following test cards to test international payments. Use any valid expiration date in the future in the MM/YY format and any random CVV to create a successful payment.
| Card Network | Card Number | CVV & Expiry Date |
| ------------ | --------------------------------------------------------------------- | --------------------------------------- |
| Mastercard | 5555 5555 5555 4444 5105 1051 0510 5100 5104 0600 0000 0008 | Use a random CVV and any future date ^^ |
| Visa | 4012 8888 8888 1881 | |
### Wallet
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 [supported wallets](/docs/payments/payment-methods/wallets#supported-wallets).
## 3. Go-live Checklist
Check the go-live checklist for Razorpay Hosted Checkout integration. Consider these steps before taking the integration live.
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:
1. Log in to the Razorpay Dashboard and switch to **Live Mode** on the menu.
2. Navigate to **Account & Settings** → **API Keys** → **Generate Key** to generate the API Key for Live Mode.
3. Download the keys and save them securely.
4. 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 [Fetch a Payment API](/docs/api/payments#fetch-a-payment) or webhooks.
Authorized payments can be automatically captured. You can auto-capture all payments [using global settings](/docs/payments/payments/capture-settings#auto-capture-all-payments) on the Razorpay Dashboard. Know more about [capture settings for payments](/docs/payments/payments/capture-settings).
**Watch Out!**
Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the [Orders API](/docs/api/orders/create).
Each authorized payment can also be captured individually. You can manually capture payments using [Payment Capture API](/docs/api/payments/capture) or [Dashboard](/docs/payments/payments/dashboard#manually-capture-payments). Know more about [capture settings for payments](/docs/payments/payments/capture-settings).
Ensure you have [set up webhooks](/docs/webhooks/setup-edit-payments) in the live mode and configured the events for which you want to receive notifications.
**Implementation Considerations**
Webhooks are the primary and most efficient method for event notifications. They are delivered asynchronously in near real-time. For critical user-facing flows that need instant confirmation (like showing "Payment Successful" immediately), supplement webhooks with API verification.
**Recommended approach**
* Rely on webhooks for all automation, which can be asynchronous.
* If a critical user-facing flow requires instant status, but the webhook notification has not arrived within the time mandated by your business needs, perform an immediate API Fetch call ([Payments](/docs/api/payments/fetch-with-id), [Orders](/docs/api/orders/fetch-with-id) and [Refunds](/docs/api/refunds/fetch-specific-refund-payment)) to verify the status.
