> ## 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. # 1. Build Integration > Steps to integrate the Custom Checkout form on your website.
Available in 🇮🇳 India 🇸🇬 Singapore 🇺🇸 United States
Follow the steps to integrate Custom Checkout in your site: **1.1** [Create an Order in Server](#1-1-create-an-order-in-server). **1.2** [Fetch Payment Methods](#1-2-fetch-payment-methods). **1.3** [Invoke Checkout and Pass Order Id and Other Options to it](#13-invoke-checkout-and-pass-order-id-and). **1.3.1** [Include JavaScript code in your Webpage](#1-3-1-include-javascript-code-in-your-webpage). **1.3.2** [Instantiate Custom Checkout](#1-3-2-instantiate-custom-checkout). **1.3.3** [Submit Payment Details](#1-3-3-submit-payment-details). **1.4** [Store Fields in Your Server](#1-4-store-fields-in-your-server). **1.5** [Verify Payment Signature](#1-5-verify-payment-signature). **1.6** [Verify Payment Status](#1-6-verify-payment-status). ## 1.1 Create an Order in Server 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/us/api/authentication#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. #### API Sample Code The following is a sample API request and response for creating an order: ```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": "USD", "receipt": "rcptid_11", "partial_payment": true, "first_payment_min_amount": 23000 }' ``` ```java Java theme={null} try { JSONObject orderRequest = new JSONObject(); orderRequest.put("amount", 50000); // amount in the smallest currency unit orderRequest.put("currency", "USD"); 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=("api_key", "api_secret")) DATA = { "amount": 100, "currency": "USD", "receipt": "receipt#1", "notes": { "key1": "value3", "key2": "value2" } } client.order.create(data=DATA) ``` ```php PHP theme={null} $order = $client->order->create([ 'receipt' => 'order_rcptid_11', 'amount' => 50000, // amount in the smallest currency unit 'currency' => 'USD'// See the list of supported currencies.) ]); ``` ```csharp .NET theme={null} Dictionary options = new Dictionary(); options.Add("amount", 50000); // amount in the smallest currency unit options.add("receipt", "order_rcptid_11"); options.add("currency", "USD"); Order order = client.Order.Create(options); ``` ```ruby Ruby theme={null} options = amount: 50000, currency: 'USD', receipt: '' order = Razorpay::Order.create ``` ```javascript Node.js theme={null} var options = { amount: 50000, // amount in the smallest currency unit currency: "USD", receipt: "order_rcptid_11" }; instance.orders.create(options, function(err, order) { console.log(order); }); ``` ```json Response theme={null} { "id": "order_DBJOWzybf0sJbb", "entity": "order", "amount": 50000, "amount_paid": 0, "amount_due": 50000, "currency": "USD", "receipt": "rcptid_11", "status": "created", "attempts": 0, "notes": [], "created_at": 1566986570 } ``` #### Request Parameters Here is the list of parameters and their description for creating an order: `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. `currency` *mandatory* : `string` Currency code for the currency in which you want to accept the payment. `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 [Orders API](/docs/us/api/orders). #### Error Response Parameters The error response parameters are available in the [API Reference Guide](/docs/us/api/orders#error-response-parameters). ## 1.2 Fetch Payment Methods 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 [the various payment methods](/docs/us/payments/payment-methods) offered by Razorpay. ## 1.3 Invoke Checkout and Pass Order Id and Other Options to it ### 1.3.1 Include JavaScript code in your Webpage Include the following script, preferably in the `` section of your page: ```html Index HTML theme={null} ``` **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. ### 1.3.2 Instantiate Custom Checkout * Single Instance on a Page: ```javascript Invoke a Single Instance theme={null} var razorpay = new Razorpay({ key: '', image: 'https://i.imgur.com/n5tjHFD.jpg', // logo, displayed in the payment processing popup redirect: true }); ``` * Multiple Instances on Same Page: If you need multiple Razorpay instances on the same page, you can globally set some of the options: ```javascript Invoke Multiple Instances theme={null} Razorpay.configure({ key: '', // logo, displayed in the payment processing popup image: 'https://i.imgur.com/n5tjHFD.jpg', redirect: true }); new Razorpay({}); // will inherit key and image from above ``` **Customer Fee Bearer (CFB) Requirements** For card payments with CFB enabled, set `redirect: true` and include `callback_url` during Razorpay instantiation. #### Checkout Options 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** → [API Keys](/docs/us/api/authentication#generate-api-keys). `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 [Orders API](/docs/us/api/orders). `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). `method` *mandatory* : `string` The payment method used by the customer on Checkout.
Possible values: * `card` (default) * `ach` `card` *mandatory if method=card* : `object` The details of the card that should be entered while making the payment. `number` : `integer` Unformatted card number. `name` : `string` The name of the cardholder. `expiry_month` : `integer` Expiry month for card in MM format. `expiry_year` : `integer` Expiry year for card in YY format. `cvv` : `integer` CVV printed on the back of the card. `bank_account` *mandatory if method=ach* : `object` Bank account details. `account_number` *mandatory* : `string` Customer's bank account number. `name` *mandatory* : `string` Account holder's name as per bank records. `bank_code` *mandatory* : `string` The ACH routing number of the bank account. `bank_code_category` *mandatory* : `string` The category of bank code. Must be `routing_number` for ACH payments. `account_type` *mandatory* : `string` Type of bank account. Possible values: * `personal_savings`: Individual savings account. * `personal_checking`: Individual current account. * `business_savings`: Business savings account. * `business_checking`: Business current account. `callback_url` *optional* : `string` Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is whitelisted. This parameter is mandatory for payments. `redirect` *optional* : `boolean` Determines whether to post a response to the event handler post payment completion or redirect to Callback URL. `callback_url` and `redirect` parameters are mandatory for these payments. Possible values: * `true`: Customer is redirected to the specified callback URL in case of payment failure. For payments, the `redirect` parameter should always be sent as `true`. * `false` (default): Customer is not redirected to the specified callback URL. ### 1.3.3 Submit Payment Details 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 [sample codes for various payment methods](/docs/us/payments/payment-gateway/web-integration/custom/payment-methods). ```javascript createPayment with callback URL theme={null} var data = { callback_url: 'https://www.examplecallbackurl.com/', amount: 1000, // in currency subunits. currency: "USD", email: '', contact: '', method: 'ach', billing_address: 'Block street, San Jose, California', bank_account: { account_number: "4649986523", account_type: "business_checking", bank_code_category: "routing_number", bank_code: "011000138", name: "" }, order_id: 'order_CuEzONfnOI86Ab', }; var btn = document.querySelector('#btn'); btn.addEventListener('click', function(){ // has to be placed within user initiated context, such as click, in order for popup to open. razorpay.createPayment(data); }) ``` ```javascript createPayment with handler function theme={null} var data = { amount: 1000, // in currency subunits. currency: "USD", email: '', contact: '', method: 'ach', billing_address: 'Block street, San Jose, California', bank_account: { account_number: "4649986523", account_type: "business_checking", bank_code_category: "routing_number", bank_code: "011000138", name: "" }, order_id: 'order_CuEzONfnOI86Ab', }; var btn = document.querySelector('#btn'); btn.addEventListener('click', function(){ // Ensure 'razorpay' is initialized before this point razorpay.createPayment(data); razorpay.on('payment.success', function(resp) { alert(resp.razorpay_payment_id); alert(resp.razorpay_order_id); alert(resp.razorpay_signature); }); razorpay.on('payment.error', function(resp){ alert(resp.error.description); }); }); ``` **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:
```javascript theme={null} $('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` and `razorpay_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 the `razorpay_payment_id`, `razorpay_order_id` and `razorpay_signature` in the response object of the successful payment (`razorpay_payment_id` and `razorpay_order_id`). ## 1.4 Store Fields in Your Server 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. A failed payment returns an error response. ```json Sample Error Response theme={null} { "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 [Error Codes](/docs/us/errors). ## 1.5 Verify Payment Signature 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/us/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 = "testWebhookSecret1234567"; 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_IEIaMR65cu6nz3"); options.Add("razorpay_payment_id", "pay_IH4NVgf4Dreq1l"); options.Add("razorpay_signature", "0d4e745a1838664ad6c9c9902212a32d627d68e917290b0ad5f08ff4561bc50f"); 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 := "testWebhookSecret1234567"; utils.VerifyPaymentSignature(params, signature, secret) ``` After you have completed the integration, you can [set up webhooks](/docs/us/webhooks/setup-edit-payments), make test payments, replace the test key with the live key and integrate with other [APIs](/docs/us/api). ## 1.6 Verify Payment Status **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/us/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/us/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/us/api/payments/fetch-all-payments) to check the payment status. ## Next Steps [Step 2: Test Integration](/docs/us/payments/payment-gateway/web-integration/custom/test-integration)