3.1 Create an Order to Charge the Customer
You have to create a new order every time you want to charge your customers. This order is different from the one created during the authorisation transaction. The following endpoint creates an order. /ordersRequest
Success
Request Parameters
amount mandatory
: integer Amount in currency subunits. For cards, the amount should be 100 (1).
currency mandatory
: string The 3-letter ISO currency code for the payment. Currently, we only support INR.
merchant_id mandatory
: string This is the Razorpay merchant ID for your Razorpay account. You can find this by logging in to the Dashboard and clicking the user icon in the top right corner.
customer_id mandatory
: string The unique identifier of the customer. For example, cust_4xbQrmEoA5WJ01.
bank_account mandatory
: object Details of the bank account of the customer.
account_number mandatory
: string The bank account number of the customer. For example, 123456789012345.
ifsc mandatory
: string The IFSC of the bank. For example, HDFC0000053.
name mandatory
: string The name of the bank account holder.
customer_details mandatory
: object This contains details about the customer details of the order.
name mandatory
: 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 (e.g., @, ”, ,, ., etc.), Unicode characters, emojis, and non-Latin scripts or regional languages.
- Prohibited names: Names must be meaningful and contextually appropriate.
- Avoid using repetitive patterns (e.g., 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.
email optional
: 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.
contact optional
: string The customer’s phone number. A maximum length of 15 characters including country code. For example, +919000090000.
shipping_address mandatory
: object This contains the shipping address of the order.
line1 mandatory
: string Address Line 1 of the address.
- Character length: Must be between 3 and 100 characters.
- Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), spaces, and special characters (*&/-()#_+[]:’”.,.).
- Not allowed characters: Regional languages.
line2 mandatory
: string Address Line 2 of the address.
- Character length: Must be between 3 and 100 characters.
- Allowed characters: Uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), spaces, and special characters (*&/-()#_+[]:’”.,.).
- Not allowed characters: Regional languages.
city mandatory
: string Name of the city. Must be between 3 and 50 characters in length and can only include uppercase (A-Z) and lowercase (a-z) English letters, and spaces.
country mandatory
: string ISO3 country code of the billing address. Only IND is allowed.
state mandatory
: string Name of the state. It must be between 3 and 50 characters extended and can only include uppercase (A-Z) and lowercase (a-z) English letters and spaces. Please send the full name of the state, for example, Madhya Pradesh.
zipcode mandatory
: string The ZIP code must consist of 6-digit numeric characters. Only valid Indian ZIP codes will be accepted. Refer to the list of supported ZIP codes.
latitude optional
: float Latitude of the position expressed in decimal degrees (WSG 84), for example, 6.244203. A positive value denotes the northern hemisphere or the equator, and a negative value denotes the southern hemisphere. The number of digits to represent the precision of the coordinate.
longitude optional
: float Longitude of the position expressed in decimal degrees (WSG 84), for example, -75.581211. A positive value denotes east longitude or the prime meridian, and a negative value denotes west longitude. The number of digits to represent the precision of the coordinate.
insights optional
: json object Additional details of the customer, including past transaction data.
order_count optional
: integer Total orders placed by the account so far on the business platform. For example, 22.
chargeback_count optional
: integer Total chargeback received for the customer account on the business platform. For example, 4.
tier optional
: string Your company’s passenger classification, such as with a frequent flyer program. In this case, you might use values such as:
standardgoldplatinum
booking_channel optional
: string To share if the user is an agent, corporate, or individual. Possible values:
agentcorporateindividual
has_account optional
: boolean To denote if the buyer is on guest checkout or has logged into the account. Possible values:
- 1: If the user is logged into the account.
0: If the user is on guest
registered_at optional
: integer UNIX timestamp when the customer account was created. For example, 1234567890.
receipt optional
: string A user-entered unique identifier for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.
notesoptional
: object Key-value pair you can use to store additional information about the entity. Maximum 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”.
Response Parameters
amount
: integer Amount in currency subunits. For cards, the amount should be 100 (1).
amount_due
: integer The amount that the customer has yet to pay.
amount_paid
: integer The amount that has been paid.
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 was created.
currency
: string The 3-letter ISO currency code for the payment. Currently, we only support INR.
entity
: string Name of the entity. Here, it is order.
id
: string A unique identifier of the order created. For example order_1Aa00000000002.
notes
: 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”.
receipt
: string A user-entered unique identifier of the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.
status
: string The status of the order.
You can create a payment against the order_id after you create an order.
Error Response Parameters
Given below is a list of possible errors you may face while creating an Order.Error | Cause | Solution
The api key provided is invalid | This error occurs when you enter the wrong API key or secret. | Make sure to enter the valid API key and secret.
The amount must be at least INR 1.00. | This error occurs when you enter an amount less than INR 1. | Make sure the entered amount is atleast INR 1.00.
The currency should be INR when method is upi | This error occurs when you enter a currency other than INR | Make sure the currency is INR.
3.2 Create a Recurring Payment
Once you have generated anorder_id, use it to create a payment and charge the customer. The following endpoint creates a payment to charge the customer.
/payments/create/recurring
Request
Success
UPI Payments
- We recommend sending a pre-debit notification to the customer 48 hours before the debit date.
- For UPI, it may take between 24-36 hours for the subsequent payment to reflect on your Dashboard.
- This is because of the failure of pre-debit notification and/or any retries that we attempt for the payment.
- Do not create another subsequent payment until you get the status of the previous one.
Request Parameters
amount mandatory
: integer The amount associated with the payment in smallest unit of the supported currency. For example, 2000 means ₹20. Must match the amount in Create an order to charge the customer.
currency mandatory
: string The 3-letter ISO currency code for the payment. Currently, we only support INR.
order_id mandatory
: string The unique identifier of the order created in Create an order to charge the customer.
email mandatory
: string The customer’s email address. For example, gaurav.kumar@example.com.
contact mandatory
: string The customer’s contact number. For example, 9000090000.
customer_id mandatory
: string Unique identifier of the customer, obtained from the response of Customer API.
token mandatory
: string The token_id generated when the customer successfully completes the authorisation payment. Different payment instruments for the same customer have different token_id.
recurring mandatory
: string Possible values:
1: Recurring payment is enabled.preferred: Use this when you want to support recurring payments and one-time payment in the same flow.
notes mandatory
: 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”.
invoice_number mandatory
: string Invoice number of the generated invoice. Ensure that each payment has a unique invoice number, with a length of fewer than 40 characters.
goods_description optional
: string Description of the goods. For example, Digital Lamp.