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.
amount
mandatory
integer
Amount in currency subunits. For cards, the amount should be 100
(₹1.00).
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
optional
string
Payment method used to make the authorisation transaction. Here, it is card
.
token
Details related to the authorisation such as max amount, frequency and expiry information.
max_amount
mandatory
integer
The maximum amount that can be auto-debited in a single charge. The minimum value is 100
(₹1), and the maximum value is 100000000
(₹10,00,000). For an amount higher than this or the RBI limit of ₹15,000 (1500000
), the cardholder should provide an Additional Factor of Authentication (AFA) as per RBI guidelines.
expire_at
mandatory
integer
The Unix timestamp that indicates when the authorisation transaction must expire. The card's expiry year is considered a default value.
frequency
mandatory
string
The frequency at which you can charge your customer. Possible values:
weekly
monthly
yearly
as_presented
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”
.
Once an order is created, your next step is to create a payment. Use the below endpoint to create a payment with payment method card
.
Handy Tips
- To process recurring transactions, customer card details will need to be secured/tokenised in accordance with the applicable laws. The merchant will be solely responsible for obtaining informed consent from customers for the processing of e-mandates and such consent shall be explicit and not by way of a forced/default/automatic selection of check box, radio button etc.
- When the merchant is sharing
recurring: 1
orpreferred
, it is for tokenising the card as per applicable rules for recurring mandate creation. If such consent is not shared during the payment flow, then Razorpay will not tokenise the card or process the e-mandate/ recurring transaction.
amount
mandatory
integer
Amount in currency subunits. For cards, the minimum value is 100
(₹1).
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
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.
mandatory
string
The customer's email address. For example, gaurav.kumar@example.com
.
contact
mandatory
string
The customer's contact number. For example, 9123456780
.
method
mandatory
string
The payment method selected by the customer. Here, the value must be card
.
card
The attributes associated with a card.
number
mandatory
integer
Unformatted card number. This field is required if value of method
is card
. Use one of our
name
mandatory
string
The name of the cardholder.
expiry_month
mandatory
integer
The expiry month of the card in MM
format. For example, 01
for January and 12
for December.
expiry_year
mandatory
integer
Expiry year for card in the YY
format. For example, 2025 will be in format 25
.
cvv
mandatory
integer
CVV printed on the back of the card.
Handy Tips
- CVV is not required by default for Visa and Amex tokenised cards.
- To enable CVV-less flow for Rupay and MasterCard, contact our .
- CVV is mandatory for Diners tokenised cards.
- CVV is an optional field. Skip passing the
cvv
parameter to Razorpay to implement this change.
If the payment request is valid, the response contains the following fields. Refer to the
for more details.razorpay_payment_id
string
Unique identifier of the payment. Present for all responses.
next
array
A list of action objects available to you to continue the payment process. Present when the payment requires further processing.
action
string
An indication of the next step available to you to continue the payment process. Possible values:
otp_generate
- Use this URL to allow the customer to generate OTP and complete the payment on your webpage.redirect
- Use this URL to redirect the customer to submit the OTP on the bank page.
url
string
URL to be used for the action indicated.