1.1 Create a Customer in Server
Request Parameters
name mandatory
: string Customer’s name.
- Name must be unique.
- Character length: Between 5 and 50 characters.
- Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), and spaces (not at the beginning).
- Not allowed characters: Numbers, special characters (For example, @, ”, ,, ., etc.), Unicode characters, emojis, and non-Latin scripts or regional languages.
- Prohibited names: Names must be meaningful and contextually appropriate.
- Avoid using repetitive patterns (For example, aaa, xyz, kkk kk).
- Names like litri litri, Hfg Gh, or husi husi are not permitted.
- Curse words or offensive names are prohibited.
- Example:
Gaurav Kumar.
contact mandatory
: string The customer’s phone number. A maximum length of 15 characters including country code. For example, +919000090000.
email mandatory
: string The customer’s email address. A maximum length of 64 characters for the username. For example, in “gaurav.kumar@example.com”, “gaurav.kumar” must not exceed 64 characters.
fail_existing optional
: string The request throws an exception by default if a customer with the exact details already exists. You can pass an additional parameter fail_existing to get the existing customer’s details in the response. Possible values:
1(default): If a customer with the same details already exists, throws an error.0: If a customer with the same details already exists, fetches details of the existing customer.
gstin optional
: string Customer’s GST number, if available.
For example, 29XAbbA4369J1PA.
notes optional
: 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”.
Response Parameters
id
: string Unique identifier of the customer. For example, cust_1Aa00000000004.
entity
: string Indicates the type of entity.
name
: string Customer’s name.
- Character length: Between 5 and 50 characters.
- Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), and spaces (not at the beginning).
- Not allowed characters: Numbers, special characters (For example, @, ”, ,, ., etc.), Unicode characters, emojis, and non-Latin scripts or regional languages.
- Prohibited names: Names must be meaningful and contextually appropriate.
- Avoid using repetitive patterns (For example, aaa, xyz, kkk kk).
- Names like litri litri, Hfg Gh, or husi husi are not permitted.
- Curse words or offensive names are not prohibited.
- Example:
Gaurav Kumar.
contact
: string The customer’s phone number. A maximum length of 15 characters including country code. For example, +919000090000.
email
: string The customer’s email address. A maximum length of 64 characters for the username. For example, in “gaurav.kumar@example.com”, “gaurav.kumar” must not exceed 64 characters.
gstin
: string GST number linked to the customer.
For example, 29XAbbA4369J1PA.
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”.
created_at
: integer UNIX timestamp, when the customer was created. For example, 1234567890.
Error Response Parameters
Error | Cause | Solution
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. Know how to Generate API keys.
Contact number should be at least 8 digits, including country code. | The contact number is less than 8 digits. | Enter contact number that meets the validation criteria. It should have at least 8 digits, including the country code. For example, “+919000090000”.
1.2 Create an Order in Server
After a customer is created, an order needs to be generated using the Orders API. This order contains details such as the payment amount, currency, customer details and other custom notes. After the order is created, anorder_id is generated, for example, order_NGrgEcmYJsfUyl. You must pass this order_id in the checkout code to associate this order with the payment. Know more about Order and Payment states.
Use the API sample code given below to create an order.
/orders
Curl
Success
1.3 Integrate with Checkout on Client-Side
Add the Pay button on your web page using the checkout code, Handler Function or Callback URL.Handler Function or Callback URL
Handler Function | Callback URL
When you use this: - On successful payment, the customer is shown your web page.- On failure, the customer is notified of the failure and asked to retry the payment. | When you use this: - On successful payment, the customer is redirected to the specified URL, for example, a payment success page.
- On failure, the customer is asked to retry the payment.
Code to Add Pay Button
Copy-paste the parameters asoptions in your code:
Callback URL (JS) Checkout Code
Handy TipsTest your integration using these test cards.
Checkout Parameters
key mandatory
: string API Key ID generated from the Dashboard.
amount mandatory
: integer The amount to be paid by the customer in currency subunits. For example, if the amount is 500, enter 50000.
currency mandatory
: string The currency code. The default length is 3 characters. For example, INR.
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 Orders API.
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
contactparameter of the JSON request’sprefillobject. 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.
nameoptional :stringCardholder’s name to be pre-filled if customer is to make card payments on Checkout. For example, Gaurav Kumar.emailoptional :stringEmail address of the customer.contactoptional :stringPhone number of the customer. The expected format of the phone number is+ {country code}{phone number}. If the country code is not specified,91will be used as the default value. This is particularly important while prefillingcontactof customers with phone numbers issued outside India. Examples:- +14155552671 (a valid non-Indian number)
- +919977665544 (a valid Indian number).
If 9977665544 is entered,
+91is added to it as +919977665544.
methodoptional :stringPre-selection of the payment method for the customer. Will only work ifcontactandemailare also pre-filled. Possible values:cardnetbankingwalletemiupi
theme
: object Thematic options to modify the appearance of Checkout.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 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 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 Dashboard. 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.Handy TipsThe 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.Errors
Given below is a list of errors you may face while integrating with checkout on the client-side.Error | Cause | Solution
The id provided does not exist. | Occurs when there is a mismatch between the API keys used while creating the order_id/customer_id and the API key passed in the checkout. | Make sure that the API keys passed in the checkout are the same as the API keys used while creating the order_id/customer_id.
Blocked by CORS policy. | Occurs when the server-to-server request is hit from the front end instead. | Make sure that the API calls are made from the server side and not the client side.
Configure Payment Methods (Optional)
Multiple payment methods are available on the Razorpay Web 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.
1.4 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: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. The customer is notified about payment failure and asked to retry the payment. Know about the error parameters.Failure Handling Code
Checkout with Callback URL
If you used the sample code with the callback URL: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. In case of failed payments, the checkout is displayed again to facilitate payment retry.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.
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. Here are the links to our SDKs for the supported platforms.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.
Additional APIs
Fetch Payment Details With ID
Use this API to retrieve the details of a specific payment using itsrazorpay_payment_id.
Curl
Success
Query Parameter
id mandatory
: string Unique identifier of the payment to be retrieved.
Response Parameter
id
: string Unique identifier of the payment.
entity
: string Indicates the type of entity.
amount
: integer The payment amount in currency subunits. For example, for an amount of 1 enter 100.
currency
: string The currency in which the payment is made. Refer to the list of international currencies that we support.
method
: string The payment method used for making the payment. Possible values:
cardnetbankingwalletemiupipaylater
fee
: integer Fee (including GST) charged by Razorpay.
tax
: integer GST charged for the payment.
error_code
: string Error that occurred during payment. For example, BAD_REQUEST_ERROR.
error_description
: string Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP
error_source
: string The point of failure. For example, customer.
error_step
: string The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication.
error_reason
: string The exact error reason. For example, incorrect_otp.
notes
: json object Contains user-defined fields, stored for reference purposes.
invoice_number
: string Invoice number of the invoice generated. Ensure each payment has a unique invoice number.
tcs_amount
: integer The TCS (Tax Collected at Source) amount in the smallest currency unit.
tcs_percentage
: integer The TCS percentage rate applied to the payment.
created_at
: integer Timestamp, in UNIX format, on which the payment was created.
card_id
: string The unique identifier of the card used by the customer to make the payment.
card
: object Details of the card used to make the payment.
id
: string The unique identifier of the card used by the customer to make the payment.
entity
: string The name of the entity. Here, it is card.
name
: string Name of the cardholder.
last4
: integer The last 4 digits of the card number.
network
: string The card network. Possible values:
American ExpressDiners ClubMaestroMasterCardRuPayUnknownVisa
type
: string The card type. Possible values:
creditdebitprepaidunknown
issuer
: string The card issuer. The 4-character code denotes the issuing bank. This attribute will not be set for the card issued by a foreign bank.
emi
: boolean Indicates whether the card can be used for EMI payment method. Possible values:
true: Card can be used for EMI payments.false: Card cannot be used for EMI payments.
sub_type
: string The sub-type of the customer’s card. Possible values:
customerbusiness
upi
: object Details of the UPI payment received. Only applicable if method is upi.
payer_account_type
: string The payment method used for making the payment. Possible values:
bank_accountcredit_cardwalletcredit_line
vpa
: string The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.
flow
: string The type of UPI flow. Possible values:
intent: When a UPI app is selected and user is redirected to it.collect: The user enters their UPI ID and receives a notification from the UPI app. They open the app and complete the payment.in_app: In case of Turbo UPI Payments.
bank
: string The 4-character bank code which the customer’s account is associated with. For example, UTIB for Axis Bank.
vpa
: string The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.
wallet
: string The name of the wallet used by the customer to make the payment. For example, payzapp.
acquirer_data
: array A dynamic array consisting of a unique reference numbers.
rrn
: string A unique bank reference number provided by the banking partner when a refund is processed. This reference number can be used by the customer to track the status of the refund with the bank.
authentication_reference_number
: string A unique reference number generated for RuPay card payments.
bank_transaction_id
: string A unique reference number provided by the banking partner in case of netbanking payments.
Error Response Parameter
Error | Cause | Solution
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.