1.1 Create a Customer
Razorpay links recurring tokens to customers using a unique identifier generated through the Customer API. You can create customers with basic information such asemail and contact and use them for various Razorpay offerings. The following endpoint creates a customer.
/customers
Sample Code
Curl
Response
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
Use the Orders API to create a unique Razorpayorder_id that is associated with the authorisation transaction. The following endpoint creates an order.
/orders
Request
Success
Handy Tips
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:
dailyweeklyfortnightlybimonthlymonthlyquarterlyhalf_yearlyyearlyas_presented
recurring_value optional
: integer Determines the exact date or range of dates for recurring debits. Possible values are:
- 1-7 for
weeklyfrequency - 1-31 for
fortnightlyfrequency - 1-31 for
bimonthlyfrequency - 1-31 for
monthlyfrequency - 1-31 for
quarterlyfrequency - 1-31 for
half_yearlyfrequency - 1-31 for
yearlyfrequency and is not applicable for theas_presentedfrequency.
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.
Error Response Parameters
Given below is a list of possible errors you may face while creating an Order.Error | Cause | Solution
The id provided does not exist | This error occurs when you enter an incorrect customer_id. | Make sure to enter a valid customer_id.
The api key provided is invalid | This error occurs when you enter the wrong API key or secret. | Make sure to enter a 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.
The amount field is required. | This error occurs when you have not entered the amount or the max_amount value. | Make sure to enter the max_amount value.
The minimum transaction amount allowed is Re. 5. | This error occurs when you enter the maximum amount less than the minimum amount. | Make sure the max_amount value is more than the min_amount value.
The order amount cannot be greater than the token max amount for upi recurring. | This error occurs when the order amount exceeds the token_max amount passed in the API request payload. | Ensure the order amount is lesser than the token_max account.
1.3 Create an Authorisation Payment
Create a payment checkout form for customers to make Authorisation Transaction and register their mandate. You can use the Handler Function or Callback URL.Handler Function or Callback URL
Handler Function | Callback URL
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. | 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.
Sample Code
Checkout with handler functions
customer_id mandatory
: string Unique identifier of the customer created in the first step.
order_id mandatory
: string Unique identifier of the order created in the second step.
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.
Error Response Parameters
Given below is a list of possible errors you may face while making the authorisation payment.Error | Cause | Solution
transaction_limit_exceeded | The customers have exceeded their account’s credit or debit limit. This error usually occurs during high-value transactions. | You have reached the maximum transaction limit for this account. You can try again with a lower amount or use a different bank account.
payment_invalid_account | This error occurs when the customer’s bank account is either closed or no longer valid. The customer or bank may have closed the account. | The payment could not be completed as the entered bank account details are incorrect. Try again with another account.
account_closed | This error occurs when the customer’s bank account is either closed or no longer valid. The customer or bank may have closed the account. | The payment could not be completed as your bank account is closed. You can try again with another account or contact your bank for details.
invalid_withdrawer_data | This error occurs when the customer’s bank account is either closed or no longer valid. The customer or bank may have closed the account. | The payment could not be completed as the customer’s bank account is closed or blocked. You can try again with another account.
validation_failure | The bank could not validate the customer registration for debiting the customer. | The payment is declined due to a mismatch in account details. Try again with the account registered with the business only.
payment_account_withdrawal_frozen | The bank has temporarily blocked withdrawals on the customer’s account. | The payment could not be completed as withdrawal for your bank account is locked. You can try again with another account or contact your bank for details.
No_DR_allowed | The bank has temporarily blocked withdrawals on the customer’s account. | The payment could not be completed as withdrawal for your bank account is locked. You can try again with another account or contact your bank for details.
Payment_duplicate _request | A payment initiation request with the same parameters was passed to the gateway. The gateway is blocking duplicate requests. | You should retry after 30 minutes.
Registration already in progress | A payment initiation request with the same parameters was passed to the gateway. The gateway is blocking duplicate requests. | Your mandate registration is already in progress. Check the status in some time.
payment_risk_check_failed | Payment declined due to risk checks. Razorpay, Gateway and issuer bank perform these risk checks. The source parameter would give additional clarity on where the risk check failed. | The payment could not be completed due to a temporary technical issue. You can try again in sometime.
Handy Tips