1.1 Fetch Forex Rates
Use the following API to fetch the real-time conversion rate Razorpay will charge to facilitate the transaction. This includes additional charges within the LRS flow. /forex_chargesCurl
Success
Query Parameters
amount mandatory
: integer The amount which needs to be converted in currency subunits. For example, for an amount of ₹295.00, enter 29500.
base_currency mandatory
: string Currency ISO code for the given amount. The default length is 3 characters. Refer to the list of supported currencies.
conversion_currency mandatory
: string ISO code for the currency to which the given amount should be converted, specified in currency subunits. If left blank, the conversion amount is provided for all supported currencies as a list. Otherwise, provides the conversion amount only for the requested currency. Refer to the list of supported currencies.
Response Parameters
amount
: string The amount which needs to be converted in currency subunits.
base_currency
: string Currency ISO code for the given amount.
converted_amount
: string Converted amount in the requested currency.
conversion_currency
: string ISO code for the currency to which the given amount should be converted, specified in currency subunits.
expiry_time
: integer Unix timestamp at which the conversion rate will expire.
fee
: integer Fee charged by the bank.
type
: string Type of identity information collected. Possible value is bank.
amount
: string The amount which needs to be converted in currency subunits.
taxes
: integer Taxes collected for the remittance.
type
: string Type of identity information collected. Possible value is tcs.
amount
: string The amount which needs to be converted in currency subunits.
Error Response Parameters
Error | Cause | Solution
“ is missing. | A mandatory field is missing. | Ensure all mandatory fields and values are present.1.2 Create an Order
Create an order using the following API and send additional information such as customer details, identity and bank account details.Prerequisites
- The Bank Account of the Payer/Remitter is mandatory as TPV (Third Party Validation) needs to be done.
- You must provide the PAN details of the payer (PAN number of the payer from whose bank account the amount will be debited).
- Debit Card TPV is mandatory.
- Partial payments are not permitted.
Curl
Success
Request Parameters
amount mandatory
: integer The amount for which the order is created, in currency subunits. For example, for an amount of 295, enter 29500. Payment can only be made for this amount against the Order.
currency mandatory
: string ISO code for the currency in which you want to accept the payment. The default length is 3 characters. Refer to the list of supported currencies.
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_details mandatory
: json_object Contains the customer details of the order.
name mandatory
: string Customer’s name. Alphanumeric, with period (.), apostrophe (’) and parentheses allowed. The name must be between 3-50 characters in length. For example, Gaurav Kumar.
contact mandatory
: string The customer’s phone number. A maximum length of 15 characters including country code. For example, +919876543210.
email mandatory
: string The customer’s email address. A maximum length of 64 characters. For example, gaurav.kumar@example.com.
identity mandatory
: array Collect identity-related information from the customer.
Response Parameters
amount
: integer The amount for which the order was created, in currency subunits. For example, for an amount of 295, 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 thecreatedstate. It stays in this state till a payment is attempted.attempted: An order changes to theattemptedstate following the first payment attempt and remains in this state until at least one payment is successfully processed and captured.paid: After successfully capturing the payment, the order moves to thepaidstate. No further payment requests are permitted once the order moves to this state. The order stays in thepaidstate even if the payment associated with the order is refunded.
Error Response Parameters
Error | Cause | Solution
“ is missing. | A mandatory field is missing. | Ensure all mandatory fields and values are present.
The beneficiary id provided does not exist. | The beneficiary id provided is incorrect. | Use the correct beneficiary_id.
The API “ provided is invalid. | The API credentials passed in the API call differ from the ones generated on the Dashboard. Possible reasons: - Different keys for test mode and live modes.
- Expired API key. | The API keys must be active and entered correctly with no whitespace before or after the keys.
The amount must be at least INR 1.00. | The amount specified is less than the minimum amount. Currency subunits, such as paise (in the case of INR), should always be greater than 100. | Enter an amount equal to or greater than the minimum amount, that is 100.
The field name is required. | A mandatory field is missing. | Ensure all mandatory fields and values are present.1.3 Collect Documents
Collect the necessary documents in the LRS flow to facilitate the processing and settlement of payments by our AD Partner Bank. /order/:id/documentsCurl
Success
Request Parameters
document_type mandatory
: string Type of document corresponding to the flow of LRS, that is Education or Travel. For example, it is admission_letter when the student’s admission letter is uploaded. Possible values:
admission_letterpassport_frontpassport_backloan_sanction_letterbooking_invoice
purpose mandatory
: string The reason you are uploading this document. Possible values:
lrs_educationlrs_travel
Response Parameters
id
: string The unique identifier of the document.
entity
: string Name of the entity. Here, it is document.
purpose
: string The reason you are uploading this document. Here, it is lrs_education. Possible values:
lrs_educationlrs_travel
size
: integer Indicates the size of the document in bytes.
mime_type
: string Indicates the nature and format in which the document is uploaded. Possible values include:
image/jpgimage/jpegimage/pngapplication/pdf
created_at
: integer Unix timestamp at which the document was uploaded.
Error Response Parameters
Error | Cause | Solution
“ is missing. | A mandatory field is missing. | Ensure all mandatory fields and values are present.
The id provided does not exist. | The Order id provided is incorrect. | Use the correctorder_id.
1.4 Invoke Checkout and Pass Order Id and Other Options to it
1.4.1 Include JavaScript code in your Webpage
Include the following script, preferably in the “ section of your page:Index HTML
Handy Tips
- Include the script from
https://checkout.razorpay.com/v1/razorpay.jsinstead 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.4.2 Instantiate Custom Checkout
Single Instance on a Page
Invoke a Single Instance
Multiple Instances on Same Page
If you need multiple Razorpay instances on the same page, you can globally set some of the options:Invoke Multiple Instances
Checkout Options
While building a custom UI for accepting payments from your customers, you should be familiar with the fields supported in therazorpay.js script.
key mandatory
: string API Key ID generated from Dashboard → Account & Settings → API Keys.
amount mandatory
: integer The amount to be paid by the customer in currency subunits. For example, if the amount is 100, enter 10000. 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.
Handy TipsRazorpay 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 Currency Conversion (May 2024).
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.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)upi(default)netbanking(default)wallet(default)emi(default)cardless_emi(requires approval)paylater(requires approval)emandate(requires approval)
card mandatory if method=card/emi
: 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.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.
emi_duration:integerDefines the number of months in the EMI plan.
bank_account mandatory if method=emandate
: The details of the bank account that should be passed in the request. These details include bank account number, IFSC code and the name of the customer associated with the bank account.account_number
: string Bank account number used to initiate the payment.ifsc
: string IFSC of the bank used to initiate the payment.name
: string Name associated with the bank account used to initiate the payment.bank mandatory if method=netbanking
: string Bank code. List of available banks enabled for your account can be fetched via methods.wallet mandatory if method=wallet
: string Wallet code for the wallet used for the payment. Possible values:payzapp(default)olamoney(requires approval)phonepe(requires approval)airtelmoney(requires approval)mobikwik(requires approval)jiomoney(requires approval)amazonpay(requires approval)paypal(requires approval)phonepeswitch(requires approval)
provider mandatory if method=cardless_emi/paylater
: string Name of the cardless EMI provider partnered with Razorpay.Available options for Cardless EMI (requires approval):hdfcicicidfbkkbkzestmoneyearlysalarywalnut369
lazypaypaypal
vpa mandatory if method=upi
: string UPI ID used for making the payment on the UPI app.1.4.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 invokingcreatePayment method.
Know more about sample codes for various payment methods.
createPayment with handler function
Handy Tips
- Handler Function
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
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.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.
Success Callback
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.
Failure Response
A failed payment returns an error response.Sample Error Response
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:
-
Create a signature in your server using the following attributes:
order_id: Retrieve theorder_idfrom your server. Do not use therazorpay_order_idreturned by Checkout.razorpay_payment_id: Returned by Checkout.key_secret: Available in your server. Thekey_secretthat was generated from the Dashboard.
-
Use the SHA256 algorithm, the
razorpay_payment_idand theorder_idto construct a HMAC hex digest as shown below:HMAC Hex Digest -
If the signature you generate on your server matches the
razorpay_signaturereturned 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:Java
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.1.7 Verify Payment Status
Handy TipsOn 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:- Log in to the Razorpay Dashboard and 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.
Example
If you have subscribed to theorder.paid webhook event, you will receive a notification every time a customer pays you for an order.
Poll Payment APIs to check the payment status.