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
API to create a unique Razorpayorder_id
that is associated with the authorisation transaction. The following endpoint creates an order.
Authorisation transaction + auto-charge first payment
You can register a customer's mandate and charge them the first recurring payment as part of the same transaction. Know more about
.amount
mandatory
integer
Amount in currency subunits. For emandate, the amount should be 0
.
currency
mandatory
string
The 3-letter ISO currency code for the payment. Currently, we only support INR
.
payment_capture
mandatory
boolean
Determines whether tha payment status should be changed to captured
automatically or not. Possible values:
true
: Payments are captured automatically.false
: Payments are not captured automatically. You can manually capture payments using the .
method
mandatory
string
The authorisation method. Here, it is emandate
.
customer_id
mandatory
string
The unique identifier of the customer to be charged. For example, cust_D0cs04OIpPPU1F
.
receipt
optional
string
A user-entered unique identifier of the order. For example, rcptid #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 (maximum) each. For example, "note_key": "Beam me up Scotty”
.
token
Details related to the authorisation such as max amount and bank account information.
auth_type
optional
string
Emandate type used to make the authorisation payment. Possible values:
netbanking
debitcard
aadhaar
max_amount
optional
integer
The maximum amount in paise a customer can be charged in a transaction. Defaults to 9999900
(₹99,999). The maximum value you can set is 1000000000
(₹1,00,00,000)
expire_at
optional
integer
The Unix timestamp to indicate till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. Defaults to 30 years. The maximum value you can set is 30 years from the current date. Any value beyond this will throw an 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”
.
bank_account
Customer's bank account details that should be pre-filled on the checkout.
account_number
optional
string
Customer's bank account number.
account_type
optional
string
Customer's bank account type. Possible values:
savings
(default value)current
ifsc_code
optional
string
Customer's bank IFSC. For example UTIB0000001
.
beneficiary_name
optional
string
Name of the beneficiary. For example, Gaurav Kumar
.
Watch Out!
The beneficiary_name
should be between 4 to 120 characters.
id
string
A unique identifier of the order created. For example order_1Aa00000000001
.
entity
string
The entity that has been created. Here it is order
.
amount
integer
Amount in currency subunits. For emandate, the amount should be 0
.
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, rcptid #1
. You should map this parameter to the order_id
sent by Razorpay.
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.
token
Details related to the authorisation such as max amount and bank account information.
auth_type
string
Emandate type used to make the authorisation payment. Possible values:
netbanking
debitcard
aadhaar
max_amount
integer
The maximum amount in paise a customer can be charged in a transaction. The value can range from 500
to 100000000
. The default value is 9999900
(₹99,999).
expire_at
integer
The Unix timestamp to indicate till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. The default value is 10 years for emandate
. This value can range from the current date to 31-12-2099 (4102444799
).
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”
.
bank_account
Customer's bank account details that should be pre-filled on the checkout.
account_number
string
Customer's bank account number.
account_type
string
Customer's bank account type. Possible values:
savings
(default value)current
ifsc_code
string
Customer's bank IFSC. For example UTIB0000001
.
beneficiary_name
string
Name of the beneficiary. For example, Gaurav Kumar
.
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