> ## Documentation Index > Fetch the complete documentation index at: https://razorpay-60c89f9a-mintlify-audit-missing-sections-1778528421.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # 1. Create the Authorisation Transaction > Given below are the steps to create an authorisation transaction using the Razorpay APIs. ## 1.1 Create a Customer Razorpay links recurring tokens to customers using a unique identifier generated through the Customer API. You can create [customers](/api/customers) with basic information such as `email` and `contact` and use them for various Razorpay offerings. The following endpoint creates a customer. /customers ### Sample Code ````cURL: Curl theme={null} curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \ -X POST https://api.razorpay.com/v1/customers \ -H "Content-Type: application/json" \ -d '{ "name": "Gaurav Kumar", "email": "gaurav.kumar@example.com", "contact": "+919876543210", "fail_existing": "0", "notes":{ "note_key_1": "September", "note_key_2": "Make it so." } }' ```java: Java RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"); JSONObject customerRequest = new JSONObject(); customerRequest.put("name","Gaurav Kumar"); customerRequest.put("contact","+919876543210"); customerRequest.put("email","gaurav.kumar@example.com"); customerRequest.put("fail_existing", "0"); JSONObject notes = new JSONObject(); notes.put("notes_key_1","Tea, Earl Grey, Hot"); notes.put("notes_key_2","Tea, Earl Grey… decaf."); customerRequest.put("notes",notes); Customer customer = razorpay.customers.create(customerRequest); ```python: Python import razorpay client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET")) client.customer.create({ 'name': 'Gaurav Kumar', 'email': 'gaurav.kumar@example.com', 'contact': '+919876543210', 'fail_existing': "0", 'notes': {'note_key_1': 'September', 'note_key_2': 'Make it so.'} }) ```go: Go import ( razorpay "github.com/razorpay/razorpay-go" ) client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET") data := map[string]interface{}{ "name": "Gaurav Kumar", "contact": +919876543210, "email": "gaurav.kumar@example.com", "fail_existing": "0", "notes": map[string]interface{}{ "notes_key_1": "Tea, Earl Grey, Hot", "notes_key_2": "Tea, Earl Grey… decaf.", }, } body, err := client.Customer.Create(data, nil) ```php: PHP $api = new Api($key_id, $secret); $api->customer->create(array('name' => 'Gaurav Kumar', 'email' => 'gaurav.kumar@example.com','contact'=>'+919876543210','fail_existing' => "0", 'notes'=> array('notes_key_1'=> 'Tea, Earl Grey, Hot','notes_key_2'=> 'Tea, Earl Grey… decaf')); ```csharp: .NET RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"); Dictionary options = new Dictionary(); options.Add("name", "Gaurav Kumar"); options.Add("contact", "+919876543210"); options.Add("email", "gaurav.kumar@example.com"); options.Add("fail_existing", "0"); Customer customer = Customer.Create(options); ```ruby: Ruby require "razorpay" Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET') para_attr = { "name": "Gaurav Kumar", "contact": "+919876543210", "email": "gaurav.kumar@example.com", "fail_existing": "0", "notes": { "notes_key_1": "Tea, Earl Grey, Hot", "notes_key_2": "Tea, Earl Grey… decaf." } } Razorpay::Customer.create(para_attr) ```javascript: Node.js var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' }) instance.customers.create({ name: "Gaurav Kumar", contact: "+919876543210", email: "gaurav.kumar@example.com", fail_existing: "0", notes: { notes_key_1: "Tea, Earl Grey, Hot", notes_key_2: "Tea, Earl Grey… decaf." } }) ```` ```json: Response theme={null} { "id":"cust_1Aa00000000001", "entity":"customer", "name":"Gaurav Kumar", "email":"gaurav.kumar@example.com", "contact":"+919876543210", "gstin":null, "notes":{ "note_key_1":"September", "note_key_2":"Make it so." }, "created_at ":1234567890 } ``` ### Request Parameters `name` : `string` The name of the customer. For example, `Gaurav Kumar`. `email` : `string` The email address of the customer. For example, `gaurav.kumar@example.com`. `contact` : `string` The phone number of the customer. For example, `9876543210`. `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. `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”`. ### Response Parameters `id` : `string` The unique identifier of the customer. For example `cust_1Aa00000000001`. `entity` : `string` The name of the entity. Here, it is `customer`. `name` : `string` The name of the customer. For example, `Gaurav Kumar`. `email` : `string` The email address of the customer. For example, `gaurav.kumar@example.com`. `contact` : `string` The phone number of the customer. For example, `9876543210`. `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”`. `created_at` : `integer` A Unix timestamp, at which the customer was created. You can create an order once you create a customer for the payment authorisation. ## 1.2 Create an Order The Orders API allows you to create a unique Razorpay `order_id`, for example, `order_1Aa00000000001`, that would be tied to the authorisation transaction. Refer to our detailed [Order documentation](/payments/orders) for more details. Use the below endpoint to create an order. /orders You can create a payment against the `order_id` once it is generated. ```cURL: Request theme={null} curl -u : \ -X POST https://api.razorpay.com/v1/orders \ -H "Content-Type: application/json" \ -d '{ "amount": 1000, "currency": "INR", "merchant_id": "D2eavTHExqy97j", "customer_id": "cust_N8fv8Nftx5hato", "method": "upi", "token": { "max_amount": 200000, "expire_at": 1709971120, "frequency": "monthly", "recurring_value": 8, "recurring_type": "on" }, "customer_details": { "name": "Gaurav Kumar", "email": "gaurav.kumar@example.com", "contact": "9000090000", "shipping_address": { "line1": "Mantri apartment", "line2": "Koramangala", "city": "Bengaluru", "country": "IND", "state": "Karnataka", "zipcode": "560032", "latitude": "123123", "longitude": "1231231" }, "insights": { "order_count": "22", "chargeback_count": "4", "tier": "gold", "booking_channel": "agent", "has_account": true, "registered_at": 1234567890 } }, "receipt": "Receipt No. 1", "notes": { "notes_key_1": "Tea, Earl Grey, Hot", "notes_key_2": "Tea, Earl Grey… decaf." } }' ``` ````json: Success theme={null} { "amount": 1000, "amount_due": 1000, "amount_paid": 0, "attempts": 0, "created_at": 1707391377, "currency": "INR", "entity": "order", "id": "order_NYMptG6ChGaFgj", "notes": { "notes_key_1": "Tea, Earl Grey, Hot", "notes_key_2": "Tea, Earl Grey… decaf." }, "offer_id": null, "receipt": "Receipt No. 1", "status": "created" } ```json: Failure { "error":{ "code":"BAD_REQUEST_ERROR", "description":"The api key provided is invalid", "source":"NA", "step":"NA", "reason":"NA", "metadata":{ } } } ```` ### Request Parameters `amount` *mandatory* : `integer` Amount in currency subunits. `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`. `method` *mandatory* : `string` The authorisation method. Here, it is `upi`. `token` : `object` Details related to the authorisation such as max amount, frequency and expiry information. `max_amount` *mandatory* : `integer` The maximum amount that can be debited in a single charge. ## MCC | Category | Min Value | Max Value ## 6211 | Financial Services | `100` (₹1) | `20000000` (₹2,00,000) ## 6300 | Financial Services | `100` (₹1) | `20000000` (₹2,00,000) ## 7322 | Financial Services | `100` (₹1) | `20000000` (₹2,00,000) ## 6529 | Financial Services | `100` (₹1) | `20000000` (₹2,00,000) 5960 | Services | `100` (₹1) | `20000000` (₹2,00,000) For other categories and MCCs, the minimum value is `100` (₹1) and maximum value is 9999900 (₹99,999). `expire_at` *mandatory* : `integer` The Unix timestamp that indicates when the authorisation transaction must expire. The default value is 10 years, and the maximum value allowed is 30 years. `frequency` *mandatory* : `string` The frequency at which you can charge your customer. Possible values: * `daily` * `weekly` * `fortnightly` * `bimonthly` * `monthly` * `quarterly` * `half_yearly` * `yearly` * `as_presented` `recurring_value` *optional* : `integer` Determines the exact date or range of dates for recurring debits. Possible values are: * 1-7 for `weekly` frequency * 1-31 for `fortnightly` frequency * 1-31 for `bimonthly` frequency * 1-31 for `monthly` frequency * 1-31 for `quarterly` frequency * 1-31 for `half_yearly` frequency * 1-31 for `yearly` frequency and is not applicable for the `as_presented` frequency. **Watch Out!** If the date entered for the recurring debit is not available for a month, then the last day of the month is considered by default. For example, if the date entered is 31 and the month has only 28 days, then the date 28 is considered. `recurring_type` *optional* : `string` Determines when the recurring debit can be done. Possible values are: * `on`: Recurring debit happens on the exact day of every month. **Handy Tips** For creating an order with `recurring_type`=`on`, set the `recurring_value` parameter to the current date. * `before`: Recurring debit can happen any time before the specified date. * `after`: Recurring debit can happen any time after the specified date. For example, if the `frequency` is `monthly`, `recurring_value` is `17`, and `recurring_type` is `before`, recurring debit can happen between the month's 1st and 17th. Similarly, if `recurring_type` is `after`, recurring debit can only happen on or after the 17th of the month. `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](mailto: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: * `standard` * `gold` * `platinum` `booking_channel` *optional* : `string` To share if the user is an agent, corporate, or individual. Possible values: * `agent` * `corporate` * `individual` `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 checkout. `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. `notes`*optional* : `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. ## 1.3 Create an Authorisation Payment **Handler Function vs Callback URL** * **Handler Function**: When you use the handler function, the response object of the successful payment (`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**: When you use a Callback URL, the response object of the successful payment (`razorpay_payment_id`, `razorpay_order_id` and `razorpay_signature`) is submitted to the Callback URL. ````html: Custom checkout with handler functions theme={null} Pay const btn = document.querySelector("#btn"); var razorpay = new Razorpay({ key: "", image: "https://i.imgur.com/n5tjHFD.jpg" }); razorpay.once("ready", function(response) { console.log(response.methods); }) var data = { "amount": 300, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10 "currency": "INR",// Default is INR. We support more than 90 currencies. "email": "gaurav.kumar@example.com", "contact": "9123456780", "notes": { "invoice_number": "IRS1245", "goods_description": "Digital Lamp" }, "order_id": "order_00000000000001", "customer_id": "cust_00000000000001", "recurring": "1", "method": "upi", "upi[vpa]": "afrodog@upi" //Payer VPA in case of collect request }; btn.addEventListener("click", function(){ // has to be placed within user initiated context, such as click, in order for popup to open. razorpay.createPayment(data); razorpay.on("payment.success", function(resp) { alert(resp.razorpay_payment_id), alert(resp.razorpay_order_id), alert(resp.razorpay_signature)}); // will pass payment ID, order ID, and Razorpay signature to success handler. razorpay.on("payment.error", function(resp){alert(resp.error.description)}); // will pass error object to error handler }) ```html: Custom checkout with Callback URL Pay const btn = document.querySelector("#btn"); var razorpay = new Razorpay({ key: "", image: "https://i.imgur.com/n5tjHFD.jpg" }); razorpay.once("ready", function(response) { console.log(response.methods); }) var data = { "callback_url": "www.example-callback-url.com", "amount": 300, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10 "currency": "INR",// Default is INR. We support more than 90 currencies. "email": "gaurav.kumar@example.com", "contact": "9123456780", "notes": { "invoice_number": "IRS1245", "goods_description": "Digital Lamp" }, "order_id": "order_00000000000001", "customer_id": "cust_00000000000001", "recurring": "1", "method": "upi", "upi[vpa]": "afrodog@upi" //Payer VPA in case of collect request }; btn.addEventListener("click", function(){ // has to be placed within user initiated context, such as click, in order for popup to open. razorpay.createPayment(data); }) ```` ### Additional Checkout Fields You should send the following additional parameters along with the existing checkout options as a part of the authorisation transaction. `customer_id` *mandatory* : `string` Unique identifier of the customer created in the [first step](#111-create-a-customer). `order_id` *mandatory* : `string` Unique identifier of the order created in the [second step](#112-create-an-order). `recurring` *mandatory* : `string` Determines if the recurring payment is enabled or not. Possible values: * `1`: Recurring payment is enabled. * `preferred`: Use this if you want to allow **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`. **Handy Tips** For the Authorisation Payment to be successful in a day (for example, 5th June), you should create an Order and the Authorisation Transaction on the same day (5th June) before 11:59 pm.