To create an authorisation transaction using Razorpay APIs, you need to:
- .
- .
- .
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.
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”.
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.
string The email ID 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.
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:
weeklymonthlyyearlyas_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”.
id
string A unique identifier of the order created. For example order_1Aa00000000002.
entity
string The entity that has been created. Here it is order.
amount
integer Amount in currency subunits. For cards, the amount should be 100 (₹1.00).
amount_paid
integer The amount that has been paid.
amount_due
integer The amount that is yet to pay.
currency
string The 3-letter ISO currency code for the payment. Currently, we only support INR.
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.
method
string Payment method used to make the authorisation transaction. Here, it is card.
customer_id
string The unique identifier of the customer. For example, cust_4xbQrmEoA5WJ01.
status
string The status of the order.
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 The Unix timestamp at which the order was created.
You can create a payment against the order_id after you create an order.
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 | 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. |
Watch Out!
The Callback URL is not supported for Recurring Payments created using the registration link.
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
order_id
mandatory
string Unique identifier of the order created in the
recurring
mandatory
string Indicates whether the recurring should be enabled or not. Possible values:
1: Recurring is enabled.0: Recurring is not enabled.preferred: Use this when you want to support recurring payments and one-time payment in the same flow.