Integrate With Razorpay Payment Gateway
Start accepting domestic and international payments from customers on your website using the Razorpay Payment Gateway.
Razorpay has developed the Standard Checkout method and manages it. You can configure payment methods, orders, company logo and also select custom colour based on your convenience.
Handy Tips
Razorpay supports these
and
.
Watch this video to know how to integrate Razorpay Payment Gateway on your PHP app.
Sample App
We recommend you check the
, created using the video tutorial.
GitHub Repository
Download the latest
file from GitHub. It is pre-compiled to include all dependencies.
Watch Out!
Handy Tips
Project Structure
Before you begin, we recommend you check the
Project Files
Before you proceed:
- Create a Razorpay account.
- Log in to the Razorpay Dashboard and generate the API keysin test mode.
- Know about the Razorpay Payment Flowand follow these integration steps:
1. Build Integration
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. It is a server-side API call. Know how toauthenticateOrders 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.
Handy Tips
You can capture payments automatically with one-time
on the Razorpay Dashboard.
1.1.1 Sample Code
In the sample app, the index.php file contains the code for order creation using Orders API.
$api->order->create(array('receipt' => '123', 'amount' => 5000, 'currency' => 'INR', 'notes'=> array('key1'=> 'value3','key2'=> 'value2')));
1.1.2 Request Parameters
Here is the list of parameters 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.00, 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
The currency in which the transaction should be made. See the
. Length must be 3 characters.
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
(May 2024).
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.00 is to be received from the customer in two installments of #1 - ₹5,000.00, #2 - ₹2,000.00 then you can set this value as 500000
. This parameter should be passed only if partial_payment
is true
.
Know more about
.
1.1.3 Response Parameters
Descriptions for the response parameters are present in the
table.
1.1.4 Error Response Parameters
The error response parameters are available in the
.
1.2 Add Checkout Options
Add the Razorpay Checkout options to your project. For example, if you are using HTML for your front-end, create a page called pay.html and add the Pay button on your web page using the checkout code and either the callback URL or handler function.
1.2.1 Callback URL or Handler Function
1.2.2 Code to Add Pay Button
Copy-paste the parameters as options
in your code:
$data = [
"key" => $YOUR_KEY_ID, // Enter the Key ID generated from the Dashboard
"amount" => $5000, // 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://cdn.razorpay.com/logos/GhRQcyean79PqE_medium.png",
"prefill" => [
"name" => "Gaurav Kumar",
"email" => "gaurav.kumar@example.com",
"contact" => "9000090000",
],
"notes" => [
"address" => "Razorpay Corporate Office",
"merchant_order_id" => "12312321",
],
"theme" => [
"color" => "#3399cc"
],
"order_id" => $order_IluGWxBm9U8zJ8, // This is a sample Order ID. Pass the `id` obtained in the response of Step 1
];
$json = json_encode($data);
require("checkout/{$checkout}.php");
Handy Tips
If you want to use this as your final code, follow the steps given below:
- Edit the
[KEY_ID]
inside the html file. Use the test keys while testing your application.
Know how togenerate API keys. - Edit the
[KEY_ID]
and[KEY_SECRET]
in config.php.
1.2.3 Checkout Options
key
mandatory
string
API Key ID generated from the Razorpay Dashboard.
amount
mandatory
integer
Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is ₹299.00, 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
The currency in which the payment should be made by the customer. See the list of
.
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
(May 2024).
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
.
prefill
object
You can prefill the following details at Checkout.
Boost Conversions and Minimise Drop-offs
- Autofill customer contact details, especially phone number to ease form completion. Include customer’s phone number in the
contact
parameter of the JSON request'sprefill
object. Format: +(country code)(phone number). Example: “contact": "+919000090000"). - This is not applicable if you do not collect customer contact details on your website before checkout, have Shopify stores or use any of the no-code apps.
name
optional
string
Cardholder's name to be pre-filled if customer is to make card payments on Checkout. For example, Gaurav Kumar.
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:
true
: Hides the top barfalse
(default): Displays the top bar.
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.
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
.
subscription_card_change
optional
boolean
Permit or restrict customer from changing the card linked to the subscription. You can also do this from the
. 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
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 allowlisted.
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 with the suggested next best option.
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.
remember_customer
optional
boolean
Determines whether to allow saving of cards. Can also be configured via the
. 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.
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.
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.
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.
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. We recommend you to set this to 4. Having a larger number here can cause loops to occur.
Watch Out!
Web Integration does not support the max_count
parameter. It is applicable only in Android and iOS SDKs.
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
: Englishben
: Bengalihi
: Hindimar
: Marathiguj
: Gujaratitam
: Tamiltel
: Telugu
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.
1.2.4 Handle Payment Success and Failure
The way the Payment Success and Failure scenarios are handled depends on the
you used in the last step.
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.
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.
Use the Success/Failure Handling code given below:
"handler": function (response){
alert(response.razorpay_payment_id);
alert(response.razorpay_order_id);
alert(response.razorpay_signature)}
1.2.5 Configure Payment Methods (Optional)
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. Know more about configuring payment methods.
1.3 Store Fields in 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.
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.4 Verify Payment Signature
This is a mandatory step that allows you to confirm the authenticity of the details returned to the checkout for successful payments.
To verify the razorpay_signature
returned to you by the checkout:
Create a signature in your server using the following attributes:
Use the SHA256 algorithm, the
razorpay_payment_id
and theorder_id
to construct an 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, the payment received is from an authentic source.Use the code given below to generate signature on your server:
$api = new Api($key_id, $secret);
$api->utility->verifyPaymentSignature(array('razorpay_order_id' => $razorpayOrderId, 'razorpay_payment_id' => $razorpayPaymentId, 'razorpay_signature' => $razorpaySignature));
1.5 Verify Payment Status
Handy Tips
On the Dashboard, ensure that the payment status is captured
. Refer to the payment capture settings page to know how to
.
You can track the payment status in three ways:
To verify the payment status from the Dashboard:
- Log in to the Dashboardand 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.
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 keysin the Checkout code.
- No real money is deducted due to the usage of test API keys. This is a simulated transaction.
Supported Payment Methods
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
to enable such payment methods.
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
.
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 list of
.
Handy Tips
You can use Test Mode to test UPI payments, and Live Mode for UPI Intent and QR payments.
Cards
You can use one of the following test cards to test transactions for your integration in Test Mode.
- Use any valid expiration date in the future in the MM/YY format.
- Use any random CVV to create a successful payment.
Check the list of
.
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
.
3. Go-live Checklist
Check the go-live checklist for Razorpay Web Standard Checkout integration. Consider these steps before taking the integration live.
3.1 Accept Live Payments
You can 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:
- Log in to the Razorpay Dashboardand switch to Live Mode on the menu.
- Navigate to Account & Settings → API Keys → Generate Key to generate the API Key for Live Mode.
- Download the keys and save them securely.
- Replace the Test API Key with the Live Key in the Checkout code and start accepting actual payments.
3.2 Payment Capture
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 APIor webhooks.
Authorized payments can be automatically captured. You can auto-capture all payments
Watch Out!
Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the
.
3.3 Set Up Webhooks
Ensure you have
in the live mode and configured the events for which you want to receive notifications.
Integrate With Other Razorpay Products
Razorpay offers a range of
Initialization
use Razorpay\Api\Api;
$api = new Api($api_key, $api_secret);