1. Create an Authorisation Transaction
Create an authorisation transaction for UPI using Razorpay APIs and Registration Link.
You can create an authorisation transaction using
or .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.
Handy Tips
The subsequent payment frequency is displayed on your customer's PSP. They can select the required frequency while registering for the mandate.
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.
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.
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_valueparameter 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.
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 be paid.
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.
Given below is a list of possible errors you may face while creating 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.
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 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.
Given below is a list of possible errors you may face while making the authorisation payment.
Registration Link is an alternate way of creating an authorisation transaction. You can create a registration link using the
orHandy Tips
You do not have to create a customer if you choose the registration link method for creating an authorisation transaction.
- When you create a registration link, an is automatically issued to the customer. They can use this invoice to make the authorisation payment.
- A registration link should always have an order amount (in paise) the customer is charged when making the authorisation payment. For UPI, the amount must be a minimum of
₹1.
Handy Tips
You can
against a registration link.The following endpoint creates a registration link.
customer
object Details of the customer to whom the registration link is sent.
name
mandatory
string Customer's name.
mandatory
string Customer's email address.
contact
mandatory
integer Customer's contact number.
type
mandatory
string In this case, the value is link.
amount
mandatory
integer The payment amount in the smallest currency sub-unit.
currency
mandatory
string The 3-letter ISO currency code for the payment. Currently, only INR is supported.
description
mandatory
string A description that appears on the hosted page. For example, 12:30 p.m. Thali meals (Gaurav Kumar).
subscription_registration
Details of the authorisation transaction.
method
mandatory
string The payment method used to make authorisation transaction. Here, it is card.
max_amount
mandatory
integer Use to set the maximum amount (in paise) per debit request.
For other categories and MCCs, the minimum value is 100 (₹1) and maximum value is 9999900 (₹99,999).
expire_at
optional
integer The Unix timestamp till when you can use the token to charge the customer subsequent payments. 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.
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.before: recurring debit can happens any time before the specified date.after: recurring debit can happens 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.sms_notify
optional
boolean Indicates if SMS notifications are to be sent by Razorpay. Possible values:
0: Notifications are not sent by Razorpay.1: Notifications are sent by Razorpay (default value).
email_notify
optional
boolean Indicates if email notifications are to be sent by Razorpay. Possible values:
0: Notifications are not sent by Razorpay.1: Notifications are sent by Razorpay (default value).
expire_by
optional
integer The Unix timestamp indicates the expiry of the registration link.
receipt
optional
string A unique identifier entered by you for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.
notes
optional
object This is a key-value pair that is 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 invoice.
entity
string The entity that has been created. Here, it is invoice.
receipt
string A user-entered unique identifier of the invoice.
invoice_number
string Unique number you added for internal reference.
customer_id
string The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI.
customer_details
Details of the customer.
id
string The unique identifier associated with the customer to whom the invoice has been issued.
name
string The customer's name.
string The customer's email address.
contact
integer The customer's phone number.
billing_address
string Details of the customer's billing address.
shipping_address
string Details of the customer's shipping address.
order_id
string The unique identifier of the order associated with the invoice.
line_items
string Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed.
payment_id
string Unique identifier of a payment made against the invoice.
status
string The status of the invoice. Possible values:
draftissuedpartially_paidpaidcancelledexpireddeleted
expire_by
integer The Unix timestamp at which the invoice will expire.
issued_at
integer The Unix timestamp at which the invoice was issued to the customer.
paid_at
integer The Unix timestamp at which the payment was made.
cancelled_at
integer The Unix timestamp at which the invoice was cancelled.
expired_at
integer The Unix timestamp at which the invoice expired.
sms_status
string The delivery status of the SMS notification for the invoice sent to the customer. Possible values:
pendingsent
email_status
string The delivery status of the email notification for the invoice sent to the customer. Possible values:
pendingsent
date
integer Timestamp, in Unix format, that indicates the issue date of the invoice.
terms
string Any terms to be included in the invoice. Maximum of 2048 characters.
partial_payment
boolean Indicates whether the customer can make a partial payment on the invoice. Possible values:
true: The customer can make partial payments.false(default): The customer cannot make partial payments.
amount
integer Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is ₹299.95, pass the value as 29995.
amount_paid
integer Amount paid by the customer against the invoice.
amount_due
integer The remaining amount to be paid by the customer for the issued invoice.
currency
string The currency associated with the invoice. You should mandatorily pass this parameter if you are accepting international payments.
description
string A brief description of the invoice.
notes
object Any custom notes added to the invoice. Maximum of 2048 characters.
short_url
string The short URL that is generated. This is the link that can be shared with the customer to receive payments.
type
string Here, it is invoice.
comment
string Any comments to be added in the invoice. Maximum of 2048 characters.
The following endpoint sends/resends notifications with the short URL to the customer:
id
mandatory
string The unique identifier of the invoice linked to the registration link for which you want to send the notification. For example, inv_1Aa00000000001.
medium
mandatory
string Determines through which medium you want to resend the notification. Possible values:
smsemail
success
boolean Indicates whether the notifications were sent successfully. Possible values:
true: The notifications were successfully sent via SMS, email or both.false: The notifications were not sent.
The following endpoint cancels a registration link.
Handy Tips
You can only cancel registration link in the issued state.
id
mandatory
string The unique identifier for the invoice linked to the registration link that you want to cancel. For example, inv_1Aa00000000001.
id
string The unique identifier of the invoice.
entity
string The entity that has been created. Here, it is invoice.
receipt
string A user-entered unique identifier of the invoice.
invoice_number
string Unique number you added for internal reference.
customer_id
string The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI.
customer_details
Details of the customer.
id
string The unique identifier associated with the customer to whom the invoice has been issued.
name
string The customer's name.
string The customer's email address.
contact
integer The customer's phone number.
billing_address
string Details of the customer's billing address.
shipping_address
string Details of the customer's shipping address.
order_id
string The unique identifier of the order associated with the invoice.
line_items
string Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed.
payment_id
string Unique identifier of a payment made against the invoice.
status
string The status of the invoice. Possible values:
draftissuedpartially_paidpaidcancelledexpireddeleted
expire_by
integer The Unix timestamp at which the invoice will expire.
issued_at
integer The Unix timestamp at which the invoice was issued to the customer.
paid_at
integer The Unix timestamp at which the payment was made.
cancelled_at
integer The Unix timestamp at which the invoice was cancelled.
expired_at
integer The Unix timestamp at which the invoice expired.
sms_status
string The delivery status of the SMS notification for the invoice sent to the customer. Possible values:
pendingsent
email_status
string The delivery status of the email notification for the invoice sent to the customer. Possible values:
pendingsent
date
integer Timestamp, in Unix format, that indicates the issue date of the invoice.
terms
string Any terms to be included in the invoice. Maximum of 2048 characters.
partial_payment
boolean Indicates whether the customer can make a partial payment on the invoice. Possible values:
true: The customer can make partial payments.false(default): The customer cannot make partial payments.
amount
integer Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is ₹299.95, pass the value as 29995.
amount_paid
integer Amount paid by the customer against the invoice.
amount_due
integer The remaining amount to be paid by the customer for the issued invoice.
currency
string The currency associated with the invoice. You should mandatorily pass this parameter if you are accepting international payments.
description
string A brief description of the invoice.
notes
object Any custom notes added to the invoice. Maximum of 2048 characters.
short_url
string The short URL that is generated. This is the link that can be shared with the customer to receive payments.
type
string Here, it is invoice.
comment
string Any comments to be added in the invoice. Maximum of 2048 characters.
Was this page helpful?