To create an authorization transaction using the Razorpay APIs, you need to:
- .
- .
- .
- .
Razorpay links recurring tokens to customers via a unique identifier. You can generate this identifier using the Customer API.
You can create
with basic information such asemail
and contact
and use them for various Razorpay offerings. The following endpoint creates a customer.
name
mandatory
string
The name of the customer. For example, Gaurav Kumar
.
mandatory
string
The email ID of the customer. For example, gaurav.kumar@example.com
.
contact
mandatory
string
The phone number of the customer. For example, 9876543210
.
fail_existing
optional
boolean
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:
0
: Retrieve details of the existing customer.1
(default): Throws an exception error.
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”
.
You can use the
to create a unique Razorpayorder_id
that is associated with the authorisation transaction. The following endpoint creates an order.
Supported Frequency
-
Currently, UPI Recurring Payment only supports
as_presented
andmonthly
frequency. -
The frequency is displayed on your customer's PSP while attempting the mandate registration.
amount
mandatory
integer
Amount in currency subunits.
currency
mandatory
string
The 3-letter ISO currency code for the payment. Currently, we only support INR
.
customer_id
mandatory
string
The unique identifier of the customer. For example, cust_4xbQrmEoA5WJ01
.
method
mandatory
string
The authorisation method. Here, it is upi
.
receipt
optional
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.
notes
optional
object
Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”
.
token
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 theas_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 therecurring_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.
Use the below endpoint to validate the customer's UPI ID.
curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \-X POST https://api.razorpay.com/v1/payments/validate/vpa \-H "Content-Type: application/json" \-d '{"vpa": "gauravkumar@exampleupi"}'
vpa
mandatory
string
The UPI ID you want to validate. For example, gauravkumar@exampleupi
.
Once an order is created, your next step is to create a payment. Use the below endpoint to create a payment with payment method upi
.
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
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
mandatory
string
The customer's email address. For example, gaurav.kumar@example.com
.
contact
mandatory
string
The customer's contact number. For example, 9123456780
.
customer_id
mandatory
string
Unique identifier of the customer, obtained from the response of
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.
method
mandatory
string
The payment method selected by the customer. Here, the value must be upi
.
upi
Details of the expiry of the UPI link
flow
mandatory
string
Specify the type of the UPI payment flow.
Possible values are:
collect
(default)intent
vpa
mandatory
string
VPA of the customer where the collect request will be sent.
expiry_time
mandatory
integer
Period of time (in minutes) after which the link will expire. The default value is 5.
ip
mandatory
string
Client's browser IP address. For example, 117.217.74.98.
referer
mandatory
string
Value of referer
header passed by the client's browser. For example,
user_agent
mandatory
string
Value of user_agent
header passed by the client's browser.
For example, Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36
description
optional
string
Descriptive text of the payment.
save
optional
boolean
Specifies if the VPA should be stored as a token. Possible values:
1
- Saves the VPA details.0
(default) - Does not save the VPA details.
notes
optional
json object
Key-value pairs that can hold additional information about the payment.
Refer to the
If the payment request is valid, the response contains the following fields. Refer to the
for more details.razorpay_payment_id
string
Unique reference for the payment created. For example, pay_EAm09NKReXi2e0
.