1.1 Generate API Keys
Follow these steps to generate API keys: Watch this video to see how to generate API keys in the Test mode. Watch this video to see how to generate API keys in the Live mode.1
Log in to your Dashboard with the appropriate credentials.
Log in to your Dashboard with the appropriate credentials.
2
Select the mode (**Test** or **Live**) for which you want to genera...
Select the mode (Test or Live) for which you want to generate the API key.
- Test Mode: The test mode is a simulation mode that you can use to test your integration flow. Your customers will not be able to make payments in this mode.
- Live Mode: When your integration is complete, switch to live mode and generate live mode API keys. In the integration, replace test mode keys with live mode keys to accept customer payments.
3
Navigate to **Account & Settings** → **API Keys** (under **Website...
Navigate to Account & Settings → API Keys (under Website and app settings) → Generate Key to generate key for the selected mode.
1.2 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 to authenticate Orders 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.
Request Parameters
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. 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.
Response Parameters
amount
: integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of 299.35, the value of this field should be 29935.
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 The UNIX timestamp at which the order is created.
currency mandatory
: string The currency in which the transaction should be made. View the list of supported currencies. Length must be of 3 characters.
entity
: string Name of the entity. Here, it is order.
id
: string The unique identifier of the order.
notes
: 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”.
offer_id
: string The unique identifier of the offer.
receipt
: string Your receipt id for this order should be passed here. Maximum length is 40 characters.
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 on it.attempted: An order moves fromcreatedtoattemptedstate when a payment is first attempted on it. It remains in theattemptedstate till one payment associated with that order is captured.paid: After the successful capture of the payment, the order moves to thepaidstate. No further payment requests are permitted once the order moves to thepaidstate. The order stays in thepaidstate even if the payment associated with the order is refunded.
Error Response Parameters
The error response parameters are available in the API Reference Guide.1.3 Fetch Payment Methods
When creating a custom checkout form, display only the activated methods to the customer. Use the below methods to fetch all payments methods available to you:Request
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.
Checkout Parameters
key mandatory
: string API Key ID generated from Dashboard → Account & Settings → API Keys.
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. In the case of three decimal currencies, such as KWD, BHD and OMR, to accept a payment of 295.999, pass the value as 295999. And in the case of zero decimal currencies such as JPY, to accept a payment of 295, pass the value as 295.
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
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 Tips
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.