Check the API Endpoint
On this page, we have listed the sample codes with the S2S JSON V2 API. If you are using the Redirect API version, use the API endpoint as suggested below:API Version | Endpoint
Redirect | https://api.razorpay.com/v1/payments/create/redirect
JSON V1 and V2 | https://api.razorpay.com/v1/payments/create/jsonSupported Payment Fields
Understand the fields required to construct a payment request:key_id mandatory
: string The key id that you have generated from the API Keys tab in the Dashboard.
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. For example, INR. Refer to the list of supported currencies. Length must be of 3 characters.
order_id mandatory
: string Unique identifier of the Order.
Know more about Orders API.
ip mandatory
: string Customer’s IP address.
email mandatory
: string Email address of the customer. Maximum length supported is 40 characters.
contact mandatory
: string Phone number of the customer. Maximum length supported is 15 characters, inclusive of country code.
authentication optional
: object Details of the authentication channel.
authentication_channel
: string The authentication channel for the payment. Possible values:
browser(default)app
browser mandatory
: object Information regarding the customer’s browser. This parameter need not be passed when authentication_channel=app.
java_enabled
: boolean Indicates whether the customer’s browser supports Java. Obtained from the navigator HTML DOM object. Possible values:
true: Customer’s browser supports Java.false: Customer’s browser does not support Java.
javascript_enabled
: boolean Indicates whether the customer’s browser can execute JavaScript. Obtained from the navigator HTML DOM object. Possible values:
true: Customer’s browser can execute JavaScript.false: Customer’s browser cannot execute JavaScript.
timezone_offset
: integer Time difference between UTC time and the cardholder’s browser local time. Obtained from the getTimezoneOffset() method applied to the Date object.
screen_width
: integer Total width of the payer’s screen in pixels. Obtained from the screen.width HTML DOM property.
screen_height
: integer Obtained from the navigator HTML DOM object.
color_depth
: integer Obtained from the payer’s browser using the screen.colorDepth HTML DOM property.
language
: string Obtained from the payer’s browser using the navigator.language HTML DOM property. Maximum limit of 8 characters.
method mandatory
: string Name of the payment method. Possible values are:
cardnetbankingwalletemiupicardless_emipaylater
card
: object Details associated with the card. Required if the payment method is card.
number mandatory
: string Unformatted card number. Required if the method is card.
name mandatory
: string Name of the cardholder. Required if the method is card.
expiry_month mandatory
: integer Expiry month for card in MM format. Required if the method is card.
expiry_year mandatory
: string Expiry year for card in YY format. Required if the method is card.
cvv mandatory
: string CVV printed on the back of card. Required if the method is card.
Handy Tips
- CVV is not required by default for tokenised cards across all networks.
- CVV is optional for tokenised card payments. Do not pass dummy CVV values.
- To implement this change, skip passing the
cvvparameter entirely, or pass anullor empty value in the CVV field. - We recommend removing the CVV field from your checkout UI/UX for tokenised cards.
- If CVV is still collected for tokenised cards and the customer enters a CVV, pass the entered CVV value to Razorpay.
bank
: string Bank code of the bank used for the payment. Required if the method is netbanking.bank_account
: The details of the bank account that should be passed in the request. Required if the method is emandate.account_number mandatory
: string Bank account number used to initiate the payment.ifsc mandatory
: string IFSC of the bank used to initiate the payment.name mandatory
: string Name associated with the bank account used to initiate the payment.emi_duration
: string The EMI duration in months. Required if the method is emi.vpa
: string Virtual payment address of the customer. Required if the method is upi.wallet
: string Wallet code for the wallet used for the payment. Required if the method is wallet.notes optional
: object Key-value object used for passing tracking info. Refer to Notes for more details.callback_url optional
: string URL endpoint where Razorpay will submit the final payment status.referrer optional
: string Referrer header passed by the client’s browser.user_agent optional
: string Customer user-agent.Sample payloads for each of the payment methods are shown below in the JSON format.Debit and Credit Cards
Given below is the sample code for card payments:Curl
Supported Card Networks
List of supported card networks:- Visa
- Mastercard
- American Express
- Bajaj
- Maestro
- Rupay
- Diners
Netbanking
Given below is the sample code for netbanking payments. Pass the value for thebank parameter as shown below:
Curl
Supported Banks
Fetch the supported bank codes using the Methods API.EMI
Given below is the sample code for EMI payments. Pass the card details along with these parameters:methodemi_duration
Curl
EMI Plans
- Fetch the available EMI plans (for each supported bank) by invoking the Methods API. Extract the EMI plans from the response to be shown to your customers while making the payment.
- Know more about EMI plans offered by OneCard and HSBC.
Cardless EMI
Given below is the sample code for Cardless EMI payments.Handy TipsICICI Bank |
IDFC Bank |
HDFC Bank |
Kotak Bank|
axio |
Fibe |
ZestMoney |
- Contact our Support Team to get the Cardless EMI payment method enabled for your account.
- Customers should have accounts with the Cardless EMI payment partner.
Curl
Supported Providers
List of supported Cardless EMI providers:Banks | Provider Code | Minimum Order Amount
ICICI Bank | icic | ₹7000
IDFC Bank | idfb | ₹5000
HDFC Bank | hdfc | ₹5000
Kotak Bank| kkbk | ₹3000
axio | walnut369 | ₹900
Fibe | earlysalary | ₹3000
ZestMoney | zestmoney | ₹3000Wallet
Given below is the sample code for wallet payments. Pass the wallet provider name as shown:Curl
Supported Wallets
The table below lists the various wallets available to you. Some of them are available by default, while others require approval from us. Raise a request with our Support Team to enable such wallets.Wallet Provider | Availability | Wallet Code
PayZapp | Requires approval | payzapp
Airtel Money | ✓ | airtelmoney
MobiKwik | ✓ | mobikwik
JioMoney | ✓ | jiomoney
Ola Money | ✓ | olamoney
Bajaj Pay | Requires approval | bajajpay
PhonePe | Requires approval | phonepe
PhonePe Switch | For businesses registered with PhonePe Switch only | phonepeswitch
PayPal | International Payments Only.
Requires approval | paypal
Amazon Pay| Requires approval | amazonpay
.
Wallet Provider | Wallet Code | Availability
PayZapp | payzapp | Requires approval (Reach out to support team)
Airtel Money | airtelmoney | ✓
MobiKwik | mobikwik | ✓
JioMoney| jiomoney | ✓
Ola Money | olamoney | ✓
PhonePe | phonepe | Requires approval (Reach out to support team)
PhonePe Switch | phonepeswitch | For businesses registered with PhonePe Switch only
PayPal | paypal | International Payments Only
Requires approval (Reach out to support team)
Amazon Pay | amazonpay | Requires approval (Reach out to support team)
Handy TipsIntegrate your PayPal account with Razorpay Checkout to accept payments in international currencies.You can accept payments based on the transaction limit of your PayPal account.
UPI
Know about UPI Intent and UPI Collect.Pay Later
Given below is the sample code for Pay Later payments.Handy TipsLazyPay |
PayPal |
- Contact our Support Team to get this payment method enabled for your account.
- Customers should have accounts with the Pay Later service providers.
createPayment and passing method=paylater and provider=.Curl
Supported Providers
Provider | Provider Code | Availability | Minimum Transaction | Maximum Transaction
LazyPay | lazypay | Requires Approval | ₹1 | ₹10,000
PayPal | paypal | Requires Approval | ₹100 | Based on the customer’s approved limit.CRED
Your customers can pay via a combination of CRED Coins and Credit Cards saved on CRED. To add CRED Pay as a payment method, you need to:- Pass the
app_offerparameter in Orders API. - Pass the
methodandproviderparameters in Create Payments API.
Pass app_offer Parameter in Order
You must create an order using Orders API. In the response, you obtain anorder_id which you must pass to Checkout.
/orders
Curl
Request Parameters
amount mandatory
: integer The transaction amount, expressed in the currency sub-unit, 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. Default is INR.
app_offer optional
: boolean Allow/disallow customers from using CRED coins to make payments. This is used to prevent double discounting scenarios where customers have already availed discounts using voucher/coupon and you do not want them to redeem Coins as well. Possible values:
true: Customer not allowed to use CRED coins to make payment.false(default): Customer can use CRED coins to make payment.
receipt optional
: string Your receipt id for this order should be passed here. Maximum length is 40 characters.
notes optional
: 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”.
Pass method and provider Parameters in Create Payments API
Create Payment
Request Parameters
Along with the other Create Payment API request parameters, you must pass:method mandatory
: string The method used to make the payment. Here, it must be app.
provider mandatory if method=app
: string Name of the PSP app. Here, it must be cred.
app_present mandatory if app=cred
: boolean Sets the payment flow as collect. Possible values:
true: Opens CRED app on customer’s device.false(default): Sends a push notification to customer’s device.
Emandate
You can accept recurring payments from your customers usingemandate, card or upi as the method. Know more about Recurring Payments.
Feature RequestThis is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.to get this feature activated on your account.
Workflow
1
Step 1
2
Step 2
Create an Order with method as
emandate, nach or upi.3
Step 3
Collect authorisation transaction.
- Using custom checkout
- Using an authorization link
4
Step 4
Verify Tokens.
5
Step 5
Charge subsequent payments.
Sample Checkout Code to Collect Authorisation Transaction
Emandate (Netbanking)
Upload NACH File Using API
The current way to collect the NACH form is via Razorpay:- Checkout
- Merchant Dashboard
- Hosted Checkout page, where a customer signs and uploads the form via Checkout while attempting authorisation transaction.
Feature RequestThis is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.to get this feature activated on your account.Follow these steps to register a NACH mandate via S2S Image Transfer:Know more about steps 2,3,4 and 5 in Recurring Payments..PayZapp |
Airtel Money |
MobiKwik |
JioMoney|
Ola Money |
PhonePe |
PhonePe Switch |
PayPal |
Amazon Pay |
1
Step 1
Create a Customer
2
Step 2
Create an Order
3
Step 3
Upload the NACH file via API
4
Step 4
Fetch Token
5
Step 5
Create Subsequent Payments
Sample Server Request and Responses
Request
Wallet Provider | Wallet Code | Availability
PayZapp | payzapp | Requires approval (Reach out to support team)
Airtel Money | airtelmoney | ✓
MobiKwik | mobikwik | ✓
JioMoney| jiomoney | ✓
Ola Money | olamoney | ✓
PhonePe | phonepe | Requires approval (Reach out to support team)
PhonePe Switch | phonepeswitch | For businesses registered with PhonePe Switch only
PayPal | paypal | International Payments Only
Requires approval (Reach out to support team)
Amazon Pay | amazonpay | Requires approval (Reach out to support team)Handy TipsIntegrate your PayPal account with Razorpay Checkout to accept payments in international currencies.You can accept payments based on the transaction limit of your PayPal account.
UPI
Know about UPI Intent and UPI Collect.Pay Later
Given below is the sample code for Pay Later payments.Handy TipsLazyPay |
PayPal |
- Contact our Support Team to get this payment method enabled for your account.
- Customers should have accounts with the Pay Later service providers.
createPayment and passing method=paylater and provider=.Request
Supported Providers
Provider | Provider Code | Availability | Minimum Transaction | Maximum Transaction
LazyPay | lazypay | Requires Approval | ₹1 | ₹10,000
PayPal | paypal | Requires Approval | ₹100 | Based on the customer’s approved limit.CRED
Your customers can pay via a combination of CRED Coins and Credit Cards saved on CRED. To add CRED Pay as a payment method, you need to:- Pass the
app_offerparameter in Orders API. - Pass the
methodandproviderparameters in Create Payments API.
Pass app_offer Parameter in Order
You must create an order using Orders API. In the response, you obtain anorder_id which you must pass to Checkout.
/orders
Curl
Request Parameters
amount mandatory
: integer The transaction amount, expressed in the currency sub-unit, 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. Default is INR.
app_offer optional
: boolean Allow/disallow customers from using CRED coins to make payments. This is used to prevent double discounting scenarios where customers have already availed discounts using voucher/coupon and you do not want them to redeem Coins as well. Possible values:
true: Customer not allowed to use CRED coins to make payment.false(default): Customer can use CRED coins to make payment.
receipt optional
: string Your receipt id for this order should be passed here. Maximum length is 40 characters.
notes optional
: 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”.
Pass method and provider Parameters in Create Payments API
Create Payment
Request Parameters
Along with the other Create Payment API request parameters, you must pass:method mandatory
: string The method used to make the payment. Here, it must be app.
provider mandatory if method=app
: string Name of the PSP app. Here, it must be cred.
app_present mandatory if app=cred
: boolean Sets the payment flow as collect. Possible values:
true: Opens CRED app on customer’s device.false(default): Sends a push notification to customer’s device.
Emandate
You can accept recurring payments from your customers usingemandate, card or upi as the method. Know more about Recurring Payments.
Feature RequestThis is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.to get this feature activated on your account.
Workflow
1
Step 1
2
Step 2
Create an Order with method as
emandate, nach or upi.3
Step 3
Collect authorisation transaction.
- Using custom checkout
- Using an authorization link
4
Step 4
Verify Tokens.
5
Step 5
Charge subsequent payments.
Sample Checkout Code to Collect Authorisation Transaction
Emandate (Netbanking)
Upload NACH File Using API
The current way to collect the NACH form is via Razorpay:- Checkout
- Merchant Dashboard
- Hosted Checkout page, where a customer signs and uploads the form via Checkout while attempting authorisation transaction.
Feature RequestThis is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.to get this feature activated on your account.Follow these steps to register a NACH mandate via S2S Image Transfer:Know more about steps 2,3,4 and 5 in Recurring Payments..PayZapp |
Airtel Money |
MobiKwik |
JioMoney|
Ola Money |
PhonePe |
PhonePe Switch |
PayPal |
Amazon Pay |
1
Step 1
Create a Customer
2
Step 2
Create an Order
3
Step 3
Upload the NACH file via API
4
Step 4
Fetch Token
5
Step 5
Create Subsequent Payments
Sample Server Request and Responses
Request
Wallet Provider | Wallet Code | Availability
PayZapp | payzapp | Requires approval (Reach out to support team)
Airtel Money | airtelmoney | ✓
MobiKwik | mobikwik | ✓
JioMoney| jiomoney | ✓
Ola Money | olamoney | ✓
PhonePe | phonepe | Requires approval (Reach out to support team)
PhonePe Switch | phonepeswitch | For businesses registered with PhonePe Switch only
PayPal | paypal | International Payments Only
Requires approval (Reach out to support team)
Amazon Pay | amazonpay | Requires approval (Reach out to support team)Acceptable Image Formats and Sizes
The acceptable image formats and sizes are:- .jpeg
- .jpg
- .png
- Maximum accepted size is 6 MB.