Partners

Aggregators

Partner Auth

Payment Gateway Import Flow Lrs

Payment Gateway (Import Flow - Liberalised Remittance Scheme)

Integrate Razorpay Payment Gateway using Partner Auth.

Follow these steps to integrate the standard checkout form on your website:

1.1

Create a customer in server


1.2

Create an order in server


1.3

Integrate with checkout on client-side


1.4

Handle payment success and failure


1.5

Store fields in server


1.6

Verify payment signature


1.7

Verify payment status

1.1 Create a Customer in Server

Creating a customer generates a unique customer_id by collecting basic details such as name, email and contact details. This customer_id must be included when creating a payment request to link the payment to the customer. Use the following API to create a customer.

You can try out our APIs on the Razorpay Postman Public Workspace. Fork the workspace and test the APIs with your

Test API Keys

.

POST
/customers

Request Parameters

name

mandatory

string Customer's name.

  • Character length: Between 5 and 50 characters.
  • Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z) and spaces (not at the beginning).
  • Not allowed characters: Numbers, special characters (For example, @, ", ,, . and so on.), Unicode characters, emojis and non-Latin scripts or regional languages.
  • Prohibited names: Names must be meaningful and contextually appropriate.
    • Avoid using repetitive patterns (For example, aaa, xyz, kkk kk).
    • Names like "litri litri", "Hfg Gh" or "husi husi" are not permitted.
    • Curse words or offensive names are not prohibited.
  • Example: Gaurav Kumar.

contact

mandatory

string The customer's phone number. A maximum length of 15 characters including country code. For example, +919000090000.

email

mandatory

string The customer's email address. A maximum length of 64 characters for the username. For example, in "

gaurav.kumar@example.com

", "gaurav.kumar" must not exceed 64 characters.

fail_existing

optional

string The request throws an exception by default if a customer with the exact details already exists. You can pass an additional parameter fail_existing to get the existing customer's details in the response. Possible values:

  • 1 (default): If a customer with the same details already exists, throws an error.
  • 0: If a customer with the same details already exists, fetches details of the existing customer.

gstin

optional

string Customer's GST number, if available.
For example, 29XAbbA4369J1PA.

notes

optional

object Key-value pair used to store additional information about the entity. Holds 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

id

string Unique identifier of the customer. For example, cust_1Aa00000000004.

entity

string Indicates the type of entity.

name

string Customer's name.

  • Character length: Between 5 and 50 characters.
  • Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z) and spaces (not at the beginning).
  • Not allowed characters: Numbers, special characters (For example, @, ", ,, . and so on.), Unicode characters, emojis and non-Latin scripts or regional languages.
  • Prohibited names: Names must be meaningful and contextually appropriate.
    • Avoid using repetitive patterns (For example, aaa, xyz, kkk kk).
    • Names like "litri litri", "Hfg Gh" or "husi husi" are not permitted.
    • Curse words or offensive names are not prohibited.
  • Example: Gaurav Kumar.

contact

string The customer's phone number. A maximum length of 15 characters including country code. For example, +919000090000.

email

string The customer's email address. A maximum length of 64 characters for the username. For example, in "

gaurav.kumar@example.com

", "gaurav.kumar" must not exceed 64 characters.

gstin

string GST number linked to the customer.
For example, 29XAbbA4369J1PA.

notes

object Key-value pair used to store additional information about the entity. Holds 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer UNIX timestamp, when the customer was created. For example, 1234567890.

Error Response Parameters

1.2 Create an Order in Server

After a customer is created, an order needs to be generated using the Orders API. This order contains details such as the payment amount, currency, customer details, tax-related information and other custom notes.
After the order is created, an order_id is generated, for example, order_NGrgEcmYJsfUyl. You must pass this order_id in the checkout code to associate this order with the payment. Learn more about

Order and Payment states

.

Use the API sample code given below to create an order.

POST
/orders

Watch Out!

  • Customer Information Collection: PAN, DOB and TCS declaration will be collected from customers at checkout.
  • TCS Calculation: Razorpay will automatically calculate TCS based on the line items passed in the Create Order API and apply the required TCS on customer payments according to the following slabs:

Request Parameters

amount

mandatory

integer The amount for which the order was created, in currency subunits. For example, for an amount of $295.00, enter 29500. Payment can only be made for this amount against the Order.

currency

mandatory

string The currency code. The default length is 3 characters. For example, INR.

receipt

optional

string Receipt number that corresponds to this order, set for your internal reference. Can have a maximum length of 40 characters and has to be unique.

customer_id

optional

string Unique identifier of customer.

customer_details

mandatory

object This contains details about the customer details of the order.

name

mandatory

string Customer's name.

  • Character length: Between 5 and 50 characters.
  • Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z) and spaces (not at the beginning).
  • Not allowed characters: Numbers, special characters (For example, @, ", ,, ., etc.), Unicode characters, emojis and non-Latin scripts or regional languages.
  • Prohibited names: Names must be meaningful and contextually appropriate.
    • Avoid using repetitive patterns (For example, aaa, xyz, kkk kk).
    • Names like "litri litri", "Hfg Gh" or "husi husi" are not permitted.
    • Curse words or offensive names are prohibited.
  • Example: Gaurav Kumar.

notes

optional

json object Key-value pair used to store additional information about the entity. Holds 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty".

line_items

mandatory

object Contains the details of the booking itinerary.

type

mandatory

string Contains the type of item of booking. Possible values:

  • lrs_travel
  • lrs_experience
  • lrs_hotel

name

optional

string Contains the name of the booking. For example, the name of the hotel, flight and so on.

description

optional

string Contains the description of the booking.

quantity

optional

integer Contains the quantity of the booking. For example, 1 flight or 2 rooms.

Response Parameters

amount

integer The amount for which the order was created, in currency subunits. For example, for an amount of $295.00, enter 29500.

amount_due

integer The amount pending against the order.

amount_paid

integer The amount paid against the order.

attempts

integer The number of payment attempts, successful and failed, that have been made against this order.

created_at

integer Indicates the Unix timestamp when this order was created.

currency

string ISO code for the currency in which you want to accept the payment. The default length is 3 characters.

entity

string Name of the entity. Here, it is order.

id

string The unique identifier of the order.

notes

object Key-value pair used to store additional information about the entity. Holds 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty".

offer_id

string The unique identifier of the offer. For example, offer_JHD834hjbxzhd38d.

receipt

string Receipt number that corresponds to this order. Can have a maximum length of 40 characters and has to be unique.

status

string The status of the order. Possible values:

  • created: When you create an order, it is in the created state. It stays in this state till a payment is attempted on it.
  • attempted: An order changes to the attempted state following the first payment attempt and remains in this state until at least one payment is successfully processed and captured.
  • paid: After the successful capture of the payment, the order moves to the paid state. No further payment requests are permitted once the order moves to the paid state.
    The order stays in the paid state even if the payment associated with the order is refunded.

Error Response Parameters

1.3 Integrate with Checkout on Client-Side

Add the Pay button on your web page using the checkout code, Handler Function or Callback URL.

Handler Function or Callback URL

Code to Add Pay Button

Copy-paste the parameters as options in your code:

<button id="rzp-button1">Pay</button>
<script src="https://checkout.razorpay.com/v1/checkout.js"></script>
<script>
var options = {
    "key": "YOUR_KEY_ID", // Enter the Key ID generated from the Partners Dashboard.
    "amount": "50000", // Amount is in currency subunits.
    "currency": "",
    "name": "Acme Corp", //your business name.
    "description": "Test Transaction",
    "image": "https://example.com/your_logo",
    "customer_id": "cust_MpINfSkdEvtdxb",
    "order_id": "order_NGrgEcmYJsfUyl", //This is a sample Order ID. Pass the `id` obtained in the response of Step 2.
    "callback_url": "https://eneqd3r9zrjok.x.pipedream.net/",
    "prefill": { //We recommend using the prefill parameter to auto-fill customer's contact information especially their phone number.
        "name": "John Smith", //your customer's name.
        "email": "john.smith@example.com",
        "contact": "+11234567890" //Provide the customer's phone number for better conversion rates.
    },
    "notes": {
        "invoice_number": "IRS1245",
    },
    "theme": {
        "color": "#3399cc"
    }
};
var rzp1 = new Razorpay(options);
document.getElementById('rzp-button1').onclick = function(e){
    rzp1.open();
    e.preventDefault();
}
</script>

Handy Tips

Test your integration using these

test cards

.

Watch Out!

  • The invoice_number field is mandatory for all payment methods. Ensure each payment has a unique invoice number.
  • The createPayment method should be called within an event listener triggered by user action to prevent the popup from being blocked. For example:
$('button').click( function (){ razorpay.createPayment(...) })

Supported Payment Methods

Following payment methods are supported under the Import Flow:

  • Netbanking
  • UPI
  • Cards

  • Recurring


    For recurring payments, additional integration is needed. Cards, UPI and UPI with TPV are supported as a payment methods.

Checkout Parameters

key

mandatory

string API Key ID generated from the Razorpay Dashboard.

amount

mandatory

integer The amount to be paid by the customer in currency subunits. For example, if the amount is $500.00, enter 50000.

name

mandatory

string Your Business/Enterprise name shown on the Checkout form. For example, Acme Corp.

description

optional

string Description of the purchase item shown on the Checkout form. It should start with an alphanumeric character.

image

optional

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.

order_id

mandatory

string Order ID generated via

Orders API

.

theme

object Thematic options to modify the appearance of Checkout.

color

optional

string Enter your brand colour's HEX code to alter the text, payment method icons and CTA (call-to-action) button colour of the Checkout form.

backdrop_color

optional

string Enter a HEX code to change the Checkout's backdrop colour.

modal

object Options to handle the Checkout modal.

backdropclose

optional

boolean Indicates whether clicking the translucent blank space outside the Checkout form should close the form. Possible values:

  • true: Closes the form when your customer clicks outside the checkout form.
  • false (default): Does not close the form when customer clicks outside the checkout form.

escape

optional

boolean Indicates whether pressing the escape key should close the Checkout form. Possible values:

  • true (default): Closes the form when the customer presses the escape key.
  • false: Does not close the form when the customer presses the escape key.

handleback

optional

boolean Determines whether Checkout must behave similar to the browser when back button is pressed. Possible values:

  • true (default): Checkout behaves similarly to the browser. That is, when the browser's back button is pressed, the Checkout also simulates a back press. This happens as long as the Checkout modal is open.
  • false: Checkout does not simulate a back press when browser's back button is pressed.

confirm_close

optional

boolean Determines whether a confirmation dialog box should be shown if customers attempts to close Checkout. Possible values:

  • true: Confirmation dialog box is shown.
  • false (default): Confirmation dialog box is not shown.

ondismiss

optional

function Used to track the status of Checkout. You can pass a modal object with ondismiss: function()\{\} as options. This function is called when the modal is closed by the user.

animation

optional

boolean Shows an animation before loading of Checkout. Possible values:

  • true(default): Animation appears.
  • false: Animation does not appear.

remember_customer

optional

boolean Determines whether to allow saving of cards. Can also be configured via the

Dashboard

. Possible values:
  • true: Enables card saving feature.
  • false (default): Disables card saving feature.

timeout

optional

integer Sets a timeout on Checkout, in seconds. After the specified time limit, the customer will not be able to use Checkout.

Watch Out!

Some browsers may pause JavaScript timers when the user switches tabs, especially in power saver mode. This can cause the checkout session to stay active beyond the set timeout duration.

readonly

object Marks fields as read-only.

contact

optional

boolean Used to set the contact field as readonly. Possible values:

  • true: Customer will not be able to edit this field.
  • false (default): Customer will be able to edit this field.

email

optional

boolean Used to set the email field as readonly. Possible values:

  • true: Customer will not be able to edit this field.
  • false (default): Customer will be able to edit this field.

name

optional

boolean Used to set the name field as readonly. Possible values:

  • true: Customer will not be able to edit this field.
  • false (default): Customer will be able to edit this field.

hidden

object Hides the contact details.

contact

optional

boolean Used to set the contact field as optional. Possible values:

  • true: Customer will not be able to view this field.
  • false (default): Customer will be able to view this field.

email

optional

boolean Used to set the email field as optional. Possible values:

  • true: Customer will not be able to view this field.
  • false (default): Customer will be able to view this field.

allow_rotation

optional

boolean Used to rotate payment page as per screen orientation. Applicable from Android SDK version 1.6.4 and above. Possible values:

  • true: Payment page can be rotated.
  • false (default): Payment page cannot be rotated.

notes

mandatory

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”.

invoice_number

mandatory

string Invoice number of the invoice generated. Ensure each payment has a unique invoice number.

Handy Tips

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.

Errors

Given below is a list of errors you may face while integrating with checkout on the client-side.

Configure Payment Methods (Optional)

Multiple payment methods are available on the Razorpay Web Standard Checkout.

  • The payment methods are fixed and cannot be changed.
  • You can configure the order or make certain payment methods prominent. Know more about

    configuring payment methods

    .

1.4 Handle Payment Success and Failure

The way the Payment Success and Failure scenarios are handled depends on the

Checkout Sample Code

you used in the last step.

Checkout with Handler Function

If you used the sample code with the handler function:

The customer sees your website page. The checkout returns the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature). Collect these and send them to your server.

Checkout with Callback URL

If you used the sample code with the 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. Only successful authorisations are auto-submitted.

1.5 Store Fields in Your Server

A successful payment returns the following fields to the Checkout form.

Success Callback

  • 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.

1.6 Verify Payment Signature

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:

  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

      .

  2. Use the SHA256 algorithm, the razorpay_payment_id and the order_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
      }

  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.

Generate Signature on Your Server

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);

Post Signature Verification

After you have completed the integration, you can

set up webhooks

, make test payments, replace the test key with the live key and integrate with other

APIs

.

Here are the links to our

SDKs

for the supported platforms.

1.7 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

.

You can track the payment status in three ways:

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.

Related information

Was this page helpful?

ON THIS PAGE