API Sample Code🔗

In the sample app, the rubysample.rb file contains the code for order creation using Orders API.

 Order creation
Copyrequire "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

order = Razorpay::Order.create amount: 50000, currency: 'INR', receipt: 'TEST'

Parameters🔗

Here is the list of parameters for creating the order:

amount mandatory

integer The transaction amount, expressed in the currency subunit, such as paise (in case of INR). For example, for an actual amount of ₹299.35, the value of this field should be 29935.

currency mandatory

string The currency in which the transaction should be made. See the list of supported currencies. Length must be of 3 characters.

receipt optional

string Pass the receipt id created for this order. Maximum length 40 characters.

notes optional

json object Optional notes for order. Key-value pair 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.

Handler Function or Callback URL🔗

Code to Add Pay Button🔗

Copy-paste the parameters as options in your code:

 Manual Checkout with Handler Functions (JavaScript) Manual Checkout with Callback URL (JavaScript)
Copy<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 Dashboard
    "amount": "50000", // Amount is in currency subunits. Default currency is INR. Hence, 50000 refers to 50000 paise
    "currency": "INR",
    "name": "Acme Corp",
    "description": "Test Transaction",
    "image": "https://example.com/your_logo",
    "order_id": "order_IluGWxBm9U8zJ8", //This is a sample Order ID. Pass the `id` obtained in the response of Step 1
    "handler": function (response){
        alert(response.razorpay_payment_id);
        alert(response.razorpay_order_id);
        alert(response.razorpay_signature)
    },
    "prefill": {
        "name": "Gaurav Kumar",
        "email": "gaurav.kumar@example.com",
        "contact": "9999999999"
    },
    "notes": {
        "address": "Razorpay Corporate Office"
    },
    "theme": {
        "color": "#3399cc"
    }
};
var rzp1 = new Razorpay(options);
rzp1.on('payment.failed', function (response){
        alert(response.error.code);
        alert(response.error.description);
        alert(response.error.source);
        alert(response.error.step);
        alert(response.error.reason);
        alert(response.error.metadata.order_id);
        alert(response.error.metadata.payment_id);
});
document.getElementById('rzp-button1').onclick = function(e){
    rzp1.open();
    e.preventDefault();
}
</script>
Copy<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 Dashboard
    "amount": "50000", // Amount is in currency subunits. Default currency is INR. Hence, 50000 refers to 50000 paise
    "currency": "INR",
    "name": "Acme Corp",
    "description": "Test Transaction",
    "image": "https://example.com/your_logo",
    "order_id": "order_IluGWxBm9U8zJ8", //This is a sample Order ID. Pass the `id` obtained in the response of Step 1
    "callback_url": "https://eneqd3r9zrjok.x.pipedream.net/",
    "prefill": {
        "name": "Gaurav Kumar",
        "email": "gaurav.kumar@example.com",
        "contact": "9999999999"
    },
    "notes": {
        "address": "Razorpay Corporate Office"
    },
    "theme": {
        "color": "#3399cc"
    }
};
var rzp1 = new Razorpay(options);
document.getElementById('rzp-button1').onclick = function(e){
    rzp1.open();
    e.preventDefault();
}
</script>

Checkout Options🔗

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 ₹100, enter 10000.

currency mandatory

string The currency in which the payment should be made by the customer. See the list of supported currencies.

name mandatory

string The business name shown on the Checkout form.

description optional

string Description of the purchase item shown on the Checkout form. Must 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 loading the image from a network is not desirable.

order_id mandatory

string Order ID generated via Razorpay Orders API.

prefill

object You can prefill the following details at Checkout.

name optional

string Cardholder's name to be pre-filled if customer is to make card payments on Checkout.

email optional

string Email address of the customer.

contact optional

string Phone number of the customer. The expected format of the phone number is + {country code}{phone number}. If the country code is not specified, 91 will be used as the default value. This is particularly important while prefilling contact of customers with phone numbers issued outside India. Examples:

• +14155552671 (a valid non-Indian number)
• +919977665544 (a valid Indian number).
  If 9977665544 is entered, +91 is added to it as +919977665544.

method optional

string Pre-selection of the payment method for the customer. Will only work if contact and email are also pre-filled. Possible values

• card
• netbanking
• wallet
• emi
• upi

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

theme

object Thematic options to modify the appearance of Checkout.

hide_topbar optional

boolean Used to display or hide the top bar on the Checkout form. This bar shows the selected payment method, phone number and gives the customer the option to navigate back to the start of the Checkout form. Possible values are:

• true: Hides the top bar
• false (default): Displays the top bar.

color optional

string Enter your brand colour's HEX code to alter the appearance of 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 are:

• 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 are:

• 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 when customers attempt 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 Show an animation before loading of Checkout.

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

subscription_id optional

string If you are accepting recurring payments using Razorpay Checkout, you should pass the relevant subscription_id to the Checkout. Know more about Subscriptions on Checkout.

subscription_card_change optional

boolean Permit or restrict customer from changing the card linked to the subscription. You can also do this from the hosted page. Possible values:

• true: Allow the customer to change the card from Checkout.
• false (default): Do not allow the customer to change the card from Checkout.

recurring optional

boolean Determines if you are accepting recurring (charge-at-will) payments on Checkout via instruments such as emandate, paper NACH and so on. Possible values:

• true: You are accepting recurring payments.
• false (default): You are not accepting recurring payments.

callback_url optional

string Customers will be redirected to this URL on successful payment. Ensure that the domain of the Callback URL is whitelisted.

redirect optional

boolean Determines whether to post a response to the event handler post payment completion or redirect to Callback URL. callback_url must be passed while using this parameter. Possible values:

• true: Customer is redirected to the specified callback URL in case of payment failure.
• false (default): Customer is shown the Checkout popup to retry the payment.

customer_id optional

string Unique identifier of customer. Used for:

• Local saved cards feature.
• Static bank account details on Checkout in case of Bank Transfer payment method.

timeout optional

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

remember_customer optional

boolean Determines whether to allow saving of cards. Can also be configured via the Razorpay Dashboard. Possible values:

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

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.

send_sms_hash optional

boolean Used to auto-read OTP for cards and net banking pages. Applicable from Android SDK version 1.5.9 and above. Possible values:

• true: OTP is auto-read.
• false (default): OTP is not auto-read.

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.

retry optional

object Parameters that enable retry of payment on the checkout.

enabled

boolean Determines whether the customers can retry payments on the checkout. Possible values:

• true (default): Enables customers to retry payments.
• false: Disables customers from retrying the payment.

max_count

integer The number of times the customer can retry the payment. Recommended to set this to 4. Having a larger number here can cause loops to occur.

config optional

object Parameters that enable configuration of checkout display language.

display

object Child parameter that enables configuration of checkout display language.

language

string The language in which checkout should be displayed. Possible values:

• en: English
• ben: Bengali
• hi: Hindi
• mar: Marathi
• guj: Gujarati
• tam: Tamil
• tel: Telugu

Configure Payment Methods🔗

Multiple payment methods are available on Razorpay 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.

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:

• On Payment Success

  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.

• On Payment Failure

  The customer is notified about payment failure and asked to retry the payment. Know about the error parameters.

Success/Failure Handling Code (Checkout with Handler Function)🔗

 Success Handling Code Failure Handling Code
Copy"handler": function (response){
    alert(response.razorpay_payment_id);
    alert(response.razorpay_order_id);
    alert(response.razorpay_signature)}
Copyrzp1.on('payment.failed', function (response){
    alert(response.error.code);
    alert(response.error.description);
    alert(response.error.source);
    alert(response.error.step);
    alert(response.error.reason);
    alert(response.error.metadata.order_id);
    alert(response.error.metadata.payment_id);
}

Checkout with Callback URL🔗

If you used the sample code with the callback URL:

• On Payment Success

  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.

• On Payment Failure

  In case of failed payments, the checkout is displayed again to facilitate payment retry.

Generate Signature on Your Server🔗

Use the code given below to generate signature on your server:

 Verify Payment Signature
Copyrequire "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

puts payment_response
# {
#   :razorpay_order_id   => "12122",
#   :razorpay_payment_id => "332",
#   :razorpay_signature  => "23233"
# }
Razorpay::Utility.verify_payment_signature(payment_response)

Verify Payment Status From Dashboard🔗

1. Log into the 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.

Subscribe to Webhook events🔗

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.

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 APIs🔗

Poll Payment APIs to check the payment status.