1. Create the Authorization Transaction
Steps to create an authorization transaction for UPI one time mandate.
Create a one time mandate on UPI to let your customers block an amount and pay later. The amount gets blocked on the customer's bank account and can be debited once within the expiry of the mandate. A one time mandate on UPI can help charge customers post-delivery of products or services, helping make the customer experience delightful for businesses like E-commerce, Travel, Transport, Healthcare, and many more.
Example
Gaurav Kumar wants to reserve a room at Acme Hotel. However, he is still determining the travel plan. He wants to pay after check-in.
Using UPI One Time Mandate, Gaurav Kumar can consent to block the hotel booking amount and only let Acme Hotel debit the amount after check-in.
To create a one time mandate:
You can create an authorization transaction:
- Using the .
- Using a .
To create an authorization transaction using the Razorpay APIs, you need to:
- .
- .
- .
- .
Razorpay Curlec 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 Curlec offerings. The following endpoint creates a customer.
name
mandatory
string The name of the customer. For example, Nur Aisyah.
mandatory
string The email ID of the customer. For example, nur.aisyah@example.com.
contact
mandatory
string The phone number of the customer. For example, 60345675444.
fail_existing
optional
string 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:
1(default): If a customer with the same details already exists, throws an error.0: If a customer with the same details already exists, fetches details of the existing customer.
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 Razorpay Curlecorder_id that is associated with the authorisation transaction for a one time mandate. To create a one-time mandate, you should pass the value of the frequency parameter as one_time. The following endpoint creates an order.
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
object 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, and the maximum value allowed is 60 days.
frequency
mandatory
string The frequency at which you can charge your customer. The value should be one_time for one time mandate.
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.
After you create an order, you should create a payment. Use the endpoint below to create a payment. This is a dummy transaction that fails with an error BAD_REQUEST_DUMMY_PAYMENT when a customer tries to approve the mandate request from a PSP application. A token is created and marked as confirmed for the same.
Handy Tips
You will get the
webhook after the customer approves the mandate request.curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \-X POST https://api.razorpay.com/v1/payments/create/upi \-H "Content-Type: application/json" \-d '{"amount": 200,"currency": "INR","order_id": "order_Ee0biRtLOqzRjP","email": "gaurav.kumar@example.com","contact": "9000090000","customer_id": "cust_EIW4T2etiweBmG","recurring": "1","method": "upi","upi": {"flow": "collect","vpa": "gauravkumar@exampleupi","expiry_time": 5},"ip": "192.168.0.103","referer": "http","user_agent": "Mozilla/5.0","description": "Test flow","save": true,"notes": {"note_key": "value1"}}'
amount
mandatory
integer The amount associated with the payment in the 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 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.
method
mandatory
string The payment method selected by the customer. Here, the value must be upi.
upi
object 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 The 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:
true: Saves the VPA details.false(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
Registration Links are an alternate way of creating an authorization transaction. If you create a registration link, you need not create a customer or an order.
When you create a registration link, an
is automatically issued to the customer. The customer can use the invoice to make the Authorization Payment.Handy Tips
You can use
to get notifications about successful payments against a registration link. Do not use payment webhooks for Authorisation Payments.The following endpoint creates a registration link you can share with your customers to make one time mandate payments. This is a dummy transaction that fails with an error BAD_REQUEST_DUMMY_PAYMENT when a customer tries to approve the mandate request from a PSP application. A token is created and marked as confirmed for the same.
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 MYR is supported.
description
mandatory
string A description that appears on the hosted page.
subscription_registration
object 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. The value should be one_time for one time mandate.
sms_notify
optional
boolean Indicates if SMS notifications are to be sent by Razorpay Curlec. Possible values:
true(default): Notifications are sent by Razorpay Curlec .false: Notifications are not sent by Razorpay Curlec.
email_notify
optional
boolean Indicates if email notifications are to be sent by Razorpay Curlec. Possible values:
true(default): Notifications are sent by Razorpay Curlec .false: Notifications are not sent by Razorpay Curlec.
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 Curlec.
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”.
The following endpoint sends/resends notifications with the short URL to the customer:
The following endpoint cancels a registration link.
Handy Tips
You can only cancel registration link in the issued state.
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]-X POST https://api.razorpay.com/v1/invoices/inv_1Aa00000000001/cancel
{"id": "inv_FHrfRupD2ouKIt","entity": "invoice","receipt": "Receipt No. 1","invoice_number": "Receipt No. 1","customer_id": "cust_BMB3EwbqnqZ2EI","customer_details": {"id": "cust_BMB3EwbqnqZ2EI","name": "Nur Aisyah","email": "nur.aisyah@example.com","contact": "60345675444","gstin": null,"billing_address": null,"shipping_address": null,"customer_name": "Nur Aisyah","customer_email": "nur.aisyah@example.com","customer_contact": "60345675444"},"order_id": "order_FHrfRw4TZU5Q2L","line_items": [],"payment_id": null,"status": "cancelled","expire_by": 4102444799,"issued_at": 1595491479,"paid_at": null,"cancelled_at": 1595491488,"expired_at": null,"sms_status": "sent","email_status": "sent","date": 1595491479,"terms": null,"partial_payment": false,"gross_amount": 100,"tax_amount": 0,"taxable_amount": 0,"amount": 100,"amount_paid": 0,"amount_due": 100,"currency": "MYR","currency_symbol": "RM","description": "Registration Link for Nur Aisyah","notes": {"note_key 1": "Beam me up Scotty","note_key 2": "Tea. Earl Gray. Hot."},"comment": null,"short_url": "https://rzp.io/i/QlfexTj","view_less": true,"billing_start": null,"billing_end": null,"type": "link","group_taxes_discounts": false,"created_at": 1595491480,"idempotency_key": null}
Is this integration guide useful?
ON THIS PAGE