Create a UPI Payment Link

Create a UPI Payment Link using this endpoint.

POST /v1/payment_links

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payment_links/ \
-H 'Content-type: application/json' \
-d '{
  "upi_link": "true",
  "amount": 1000,
  "currency": "USD",
  "accept_partial": false,
  "first_min_partial_amount": 100,
  "expire_by": 1691097057,
  "reference_id": "TS1989",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "<name>",
    "contact": "<phone>",
    "email": "<email>"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  "notes": {
    "policy_name": "Life Insurance Policy"
  },
  "callback_url": "https://example-callback-url.com/",
  "callback_method": "get"
}'

Success

{
  "accept_partial": false,
  "amount": 1000,
  "amount_paid": 0,
  "cancelled_at": 0,
  "created_at": 1584524459,
  "currency": "USD",
  "customer": {
    "contact": "<phone>",
    "email": "<email>",
    "name": "<name>"
  },
  "description": "Payment for policy no #23456",
  "expire_by": 0,
  "expired_at": 0,
  "first_min_partial_amount": 0,
  "id": "plink_ETbyWrRHW2oXVt",
  "upi_link": "true",
  "notes": {
    "policy_name": "Life Insurance Policy"
  },
  "payments": null,
  "reference_id": "#456",
  "reminder_enable": true,
  "reminders": [],
  "short_url": "https://rzp.io/i/AiGGmnh",
  "status": "created",
  "updated_at": null,
  "user_id": "API"
}

Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States

Use this endpoint to create a UPI Payment Link using basic details such as amount, expiry date, reference id, description, customer details and so on.

• Basic Payment Links
  These are regular Payment Links, which are not customised.

• Customised Payment Links
  You can customise Payment Links as per your business requirements.

Handy Tips

As per Razorpay’s updated security policy, even if the customer’s email address and phone number are provided while creating the Payment Link, these details are not auto-populated on the Checkout section of the Payment Link hosted page. The customer will have to enter these details manually while making the payment.

• After successful completion of the payment, customers can be redirected to a specific URL using the callback_url and callback_method parameters. Know more about how to use these paramaters.

• Verify the razorpay_signature parameter to validate that it is authentic and sent from Razorpay servers. Know more about how to Verify Signature.

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payment_links/ \
-H 'Content-type: application/json' \
-d '{
  "upi_link": "true",
  "amount": 1000,
  "currency": "USD",
  "accept_partial": false,
  "first_min_partial_amount": 100,
  "expire_by": 1691097057,
  "reference_id": "TS1989",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "<name>",
    "contact": "<phone>",
    "email": "<email>"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  "notes": {
    "policy_name": "Life Insurance Policy"
  },
  "callback_url": "https://example-callback-url.com/",
  "callback_method": "get"
}'

Success

{
  "accept_partial": false,
  "amount": 1000,
  "amount_paid": 0,
  "cancelled_at": 0,
  "created_at": 1584524459,
  "currency": "USD",
  "customer": {
    "contact": "<phone>",
    "email": "<email>",
    "name": "<name>"
  },
  "description": "Payment for policy no #23456",
  "expire_by": 0,
  "expired_at": 0,
  "first_min_partial_amount": 0,
  "id": "plink_ETbyWrRHW2oXVt",
  "upi_link": "true",
  "notes": {
    "policy_name": "Life Insurance Policy"
  },
  "payments": null,
  "reference_id": "#456",
  "reminder_enable": true,
  "reminders": [],
  "short_url": "https://rzp.io/i/AiGGmnh",
  "status": "created",
  "updated_at": null,
  "user_id": "API"
}

Request Parameters

amount · integer · required

Amount to be paid using the Payment Link. Must be in the smallest unit of the currency. For example, if you want to receive a payment of , you must enter the value 30000. In the case of three decimal currencies, such as KWD, BHD and OMR, to refund a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to refund a payment of 295, pass the value as 295.

Watch Out!

As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to refund a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.

currency · string

A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. Refer to the list of supported currencies.

Handy Tips

Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about Currency Conversion (May 2024).

accept_partial · boolean

Indicates whether customers can make partial payments using the Payment Link. Possible values:

• true: Customer can make partial payments.
• false (default): Customer cannot make partial payments.

first_min_partial_amount · integer · required

Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. Default value is 100. Default currency is INR. For example, if an amount of is to be received from the customer in two installments of #1 - , #2 - , then you can set this value as 500000. Must be passed along with accept_partial parameter.

upi_link · boolean · required

Must be set to true for creating UPI Payment Link. If the upi_link parameter is not passed or passed with value as false, a Standard Payment Link will be created. Possible values:

• true: Creates a UPI Payment Link.
• false: Creates a Standard Payment Link.

description · string

A brief description of the Payment Link. The maximum character limit supported is 2048.

reference_id · string

Reference number tagged to a Payment Link. Must be a unique number for each Payment Link. The maximum character limit supported is 40.

customer · json object

Customer details

name · string

The customer’s name.

email · string

The customer’s email address.

contact · string

The customer’s phone number.

expire_by · integer

Timestamp, in Unix, at which the Payment Link will expire. By default, a Payment Link will be valid for six months from the date of creation. Please note that the expire by date cannot exceed more than six months from the date of creation.

notify · array

Defines who handles Payment Link notification.

sms · boolean

Defines who handles the SMS notification. Possible values:

• true: Razorpay handles the notification.
• false: You handle the notification.

email · boolean

Defines who handles the email notification. Possible values:

• true: Razorpay handles the notification.
• false: You handle the notification.

notes · json 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": "Payment Link for Groceries.”.

callback_url · string

If specified, adds a redirect URL to the Payment Link. Once customers completes the payment, they are redirected to the specified URL.

Handy Tips

If the callback_url is passed, it must be passed in the correct format. That is, it should contain a URL.

callback_method · string · required

If callback_url parameter is passed, callback_method must be passed with the value get.

reminder_enable · boolean

Used to send reminders for the Payment Link. Possible values:

• true: To send reminders.
• false: To disable reminders.

Response Parameters

accept_partial · boolean

Indicates whether customers can make partial payments using the Payment Link. Possible values:

• true: Customer can make partial payments.
• false (default): Customer cannot make partial payments.

amount · integer

Amount to be paid using the Payment Link. Must be in the smallest unit of the currency. For example, if you want to receive a payment of , you must enter the value 30000. In the case of three decimal currencies, such as KWD, BHD and OMR, to refund a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to refund a payment of 295, pass the value as 295.

Watch Out!

As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to refund a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.

amount_paid · integer

Amount paid by the customer.

callback_url · string

If specified, adds a redirect URL to the Payment Link. Once the customer completes the payment, they are redirected to the specified URL.

callback_method · string

If callback_url parameter is passed, callback_method must be passed with the value get.

cancelled_at · integer

Timestamp, in Unix, at which the Payment Link was cancelled by you.

created_at · integer

Timestamp, in Unix, indicating when the Payment Link was created.

currency · string

Defaults to INR. We accept payments in international currencies.

Handy Tips

Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about Currency Conversion (May 2024).

customer · json object

Customer details.

name · string

The customer’s name.

email · string

The customer’s email address.

contact · string

The customer’s phone number.

description · string

A brief description of the Payment Link.

expire_by · integer

Timestamp, in Unix, when the Payment Link will expire. By default, a Payment Link will be valid for six months from the date of creation. Please note that the expire by date cannot exceed more than six months from the date of creation.

expired_at · integer

Timestamp, in Unix, at which the Payment Link expired.

first_min_partial_amount · integer

Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of is to be received from the customer in two installments of #1 - , #2 - , then you can set this value as 500000.

id · string

Unique identifier of the Payment Link. For example, plink_ERgihyaAAC0VNW.

upi_link · boolean

Indicates whether the Payment Link is a UPI Payment Link.

• true: A UPI Payment Link has been created.
• false: It is a Standard Payment Link.

notes · object

Set of key-value pairs that you can use to store additional information. You (Businesses) can enter a maximum of 15 key-value pairs, with each value having a maximum limit of 256 characters.

notify · array

Defines who handles Payment Link notification.

sms · boolean

Defines who handles the SMS notification.

• true: Razorpay handles the notification.
• false: Businesses handle the notification.

email · boolean

Defines who handles the email notification.

• true: Razorpay handles the notification.
• false: Businesses handle the notification.

payments · array

Payment details such as amount, payment id, Payment Link id and more are stored in this array. It is populated only after a payment is successfully captured by the customer. Only captured payments will be shown here. Until then, the value is null.

amount · integer

The amount paid by the customer using the Payment Link.

created_at · integer

Timestamp, in Unix, indicating when the payment was made.

method · string

The payment method used to make the payment. Possible values:

• netbanking
• card
• wallet
• upi
• emi
• bank_transfer

payment_id · string

Unique identifier of the payment made against the Payment Link.

plink_id · string

Unique identifier of the Payment Link. For example, plink_ERgihyaAAC0VNW.

status · string

The payment state. Possible value is captured.

updated_at · integer

Timestamp, in Unix, indicating when the payment was updated.

reference_id · string

Reference number tagged to a Payment Link. Must be a unique number for each Payment Link. The maximum character limit supported is 40.

short_url · string

The unique short URL generated for the Payment Link.

status · string

Displays the current state of the Payment Link. Possible values:

• created
• partially_paid
• expired
• cancelled
• paid

updated_at · integer

Timestamp, in Unix, indicating when the Payment Link was updated.

reminder_enable · boolean

Used to send reminders for the Payment Link. Possible values:

• true: To send reminders.
• false: To disable reminders.

user_id · string

A unique identifier for the user role through which the Payment Link was created. For example, HD1JAKCCPGDfRx.

options · array

Custom checkout options applied to this payment link (theme, prefill, etc.). Empty when none.

Errors

The {input field} is required

Code: 4xx

A mandatory field is empty.

Solution: Ensure all mandatory fields and values are present.

wrong input fields sent.

Code: 400

When wrong input fields are sent during Payment Link creation.

Solution: Ensure that the input fields are added correctly. Refer to these request parameters on how to add correct input fields.

payment link creation with reference ID already attempted

Code: 400

An existing reference id has been passed.

Solution: Ensure that a unique reference id is used for all Payment Links.

UPI Payment Links is not supported in Test Mode. Please experience the product in Live Mode.

Code: 400

The UPI link parameter has been passed with the Test API keys.

Solution: Ensure that you use Live API keys while passing UPI links.

upi is currently supported only in indian currency

Code: 400

Occurs when you try to create a UPI Payment Link using an international currency.

Solution: Ensure that you create a UPI payment link only in indian currency.

timestamp must be atleast 15 minutes in future

Code: 400

The epoch time passed is less than 15 minutes from the current time.

Solution: The close_by time should be more than 15 minutes from the current time.

Invalid access: Cannot create a payment link in live mode, as live mode is disabled for merchant.

Code: 400

Occurs when you try to create a Payment Link in Live mode, but live mode is disabled for you

Solution: Raise a request to our support team to get live mode enabled for you.

Invalid access: Cannot create a payment link, as Merchant is Suspended.

Code: 400

Occurs when you try to create a Payment Link when you have been been suspended.

Solution: Raise a request to our support team to be reinstated.

value: the length must not be greater than 255.

Code: 400

When the notes length is greater than 255 characters during Payment Link creation.

Solution: Please create a payment link with notes values less than 255 characters.

partial payment not supported in upi link.

Code: 400

accept_partial: true (or any first_min_partial_amount) was passed alongside upi_link: true. Partial payments are not supported for UPI links.

Solution: Either drop the partial-payment fields, or use a standard payment link instead of a UPI link.

amount: cannot be blank.

Code: 400

The request body is missing the amount field, or the body is empty.

Solution: Always include amount (in currency subunits) in the request body.

amount: amount should be minimum 100 for INR.

Code: 400

The amount value is below the per-currency minimum. For INR, the minimum is 100 (₹1.00) in currency subunits.

Solution: Pass amount greater than or equal to the per-currency minimum (100 for INR).

amount, should be a whole number for e.g. 2234 to create a payment link for INR 22.34.

Code: 400

A decimal value was passed for amount. Amounts must be integers in currency subunits.

Solution: Pass amount as an integer in currency subunits (paise for INR).

email: must be in a valid format for e.g. [e-mail].

Code: 400

The value passed for customer.email is not in a valid email format.

Solution: Pass customer.email as a valid email address.

contact: the length must be between 8 and 14.

Code: 400

The customer.contact value is shorter than 8 characters or longer than 14 characters.

Solution: Pass customer.contact as a phone number between 8 and 14 characters, including the country code prefix.

reference_id: the length must be no more than 40.

Code: 400

The reference_id value exceeds the 40-character limit.

Solution: Keep reference_id to 40 characters or fewer.

extra fields sent.

Code: 400

The request body contains fields that are not part of the Payment Links API schema.

Solution: Only include documented fields. Remove any unknown keys from the request body.

Cannot create UPI links as UPI payment method is disabled for the Merchant.

Code: 400

A UPI Payment Link was requested but UPI is not enabled as a payment method on the merchant account.

Solution: Enable UPI under Payment Methods in the Settings section of the Razorpay Dashboard, or contact Razorpay support to get it enabled.

customer name is a mandatory field.

Code: 400

The customer object is present in the request but the name field inside it is missing or empty. Some organisations enforce customer name as mandatory.

Solution: Pass customer.name as a non-empty string in the request body.

expires by is a mandatory field.

Code: 400

The expire_by field is missing from the request. Some organisations enforce expire_by as mandatory for payment-link creation.

Solution: Pass expire_by as a Unix-epoch integer at least 15 minutes in the future.