> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-881012b3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a UPI Payment Link

> Create a UPI Payment Link using this endpoint.

<div style={{display:"flex",flexWrap:"wrap",alignItems:"center",gap:"0.35rem 0.9rem",border:"1px solid rgba(128,128,128,0.28)",borderRadius:"0.5rem",padding:"0.45rem 0.75rem",margin:"0 0 1.25rem",fontSize:"0.875rem"}}>
  <span style={{fontWeight:600}}>Available in</span>
  <span>🇮🇳 India</span>
  <span>🇸🇬 Singapore</span>
  <span>🇺🇸 United States</span>
</div>

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** <br />
  These are regular Payment Links, which are not customised.

* **Customised Payment Links** <br />
  You can [customise Payment Links](/docs/us/payments/payment-links/customise) as per your business requirements.

<Info>
  **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.
</Info>

* 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](/docs/us/api/payments/payment-links#using-callback-url-parameter).

* Verify the `razorpay_signature` parameter to validate that it is authentic and sent from Razorpay servers. Know more about how to [Verify Signature](/docs/us/api/payments/payment-links#verify-signature).

<RequestExample>
  ```bash Curl theme={null}
  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"
  }'
  ```

  ```go Go theme={null}
  import ( razorpay "github.com/razorpay/razorpay-go" )
  client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

  data := map[string]interface{}{
      "upi_link": "true",
      "amount": 1000,
      "currency": "USD",
      "accept_partial": false,
      "expire_by": 1691097057,
      "reference_id": "TS1989",
      "description": "Payment for policy no #23456",
      "customer": map[string]interface{}{
          "name": "<name>",
          "contact": "<phone>",
          "email": "<email>",
      },
      "notify": map[string]interface{}{
          "sms": true,
          "email": true,
      },
      "reminder_enable": true,
      "notes": map[string]interface{}{
          "policy_name": "Life Insurance Policy",
      },
  }
  body, err := client.PaymentLink.Create(data, nil)
  ```

  ```php PHP theme={null}
  $api = new Api($key_id, $secret);

  $api->paymentLink->create(array('upi_link'=>true,'amount'=>500, 'currency'=>'USD', 'accept_partial'=>false,'first_min_partial_amount'=>100, 'description' => 'For XYZ purpose', 'customer' => array('name'=>'<name>','email' => '<email>', 'contact'=>'<phone>'),  'notify'=>array('sms'=>true, 'email'=>true) ,
  'reminder_enable'=>true ,'notes'=>array('policy_name'=> 'Life Insurance Policy')));
  ```

  ```javascript Node.js theme={null}
  var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

  instance.paymentLink.create({
    upi_link: true,
    amount: 500,
    currency: "USD",
    accept_partial: false,
    first_min_partial_amount: 100,
    description: "For XYZ purpose",
    customer: {
      name: "<name>",
      email: "<email>",
      contact: "<phone>"
    },
    notify: {
      sms: true,
      email: true
    },
    reminder_enable: true,
    notes: {
      policy_name: "Life Insurance Policy"
    }
  })
  ```

  ```python Python theme={null}
  import razorpay
  client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

  client.payment_link.create({
    "upi_link": true,
    "amount": 500,
    "currency": "USD",
    "accept_partial": false,
    "first_min_partial_amount": 100,
    "description": "For XYZ purpose",
    "customer": {
      "name": "<name>",
      "email": "<email>",
      "contact": "<phone>"
    },
    "notify": {
      "sms": true,
      "email": true
    },
    "reminder_enable": true,
    "notes": {
      "policy_name": "Life Insurance Policy"
    }
  })
  ```

  ```ruby Ruby theme={null}
  require "razorpay"
  Razorpay.setup('key_id', 'key_secret')

  Razorpay.headers = {"Content-type" => "application/json"}

  para_attr = {
    "upi_link": true,
    "amount": 500,
    "currency": "USD",
    "description": "For XYZ purpose",
    "customer": {
      "name": "<name>",
      "email": "<email>",
      "contact": "<phone>"
    },
    "notify": {
      "sms": true,
      "email": true
    },
    "reminder_enable": true,
    "notes": {
      "policy_name": "Life Insurance Policy"
    }
  }

  Razorpay::PaymentLink.create(para_attr.to_json)
  ```

  ```java Java theme={null}
  import org.json.JSONObject;
  import com.razorpay.Payment;
  import com.razorpay.RazorpayClient;
  import com.razorpay.RazorpayException;

  RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
  JSONObject paymentLinkRequest = new JSONObject();
  paymentLinkRequest.put("upi_link",true);
  paymentLinkRequest.put("amount",1000);
  paymentLinkRequest.put("currency","USD");
  paymentLinkRequest.put("accept_partial",false);
  paymentLinkRequest.put("first_min_partial_amount",100);
  paymentLinkRequest.put("description","Payment for policy no #23456");
  JSONObject customer = new JSONObject();
  customer.put("name","<name>");
  customer.put("contact","<phone>");
  customer.put("email","<email>");
  paymentLinkRequest.put("customer",customer);
  JSONObject notify = new JSONObject();
  notify.put("sms",true);
  notify.put("email",true);
  paymentLinkRequest.put("notify",notify);
  paymentLinkRequest.put("reminder_enable",true);
  JSONObject notes = new JSONObject();
  notes.put("policy_name","Life Insurance Policy");
  paymentLinkRequest.put("notes",notes);

  PaymentLink payment = razorpay.paymentLink.create(paymentLinkRequest);
  ```

  ```csharp .NET theme={null}
  RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

  Dictionary<string, object> paymentLinkRequest = new Dictionary<string, object>();
  paymentLinkRequest.Add("upi_link", true);
  paymentLinkRequest.Add("amount", 1000);
  paymentLinkRequest.Add("currency", "USD");
  paymentLinkRequest.Add("accept_partial", true);
  paymentLinkRequest.Add("first_min_partial_amount", 100);
  paymentLinkRequest.Add("description", "Payment for policy no #23456");
  Dictionary<string, object> customer = new Dictionary<string, object>();
  customer.Add("contact", "<phone>");
  customer.Add("name", "<name>");
  customer.Add("email", "<email>");
  paymentLinkRequest.Add("customer", customer);
  Dictionary<string, object> notify = new Dictionary<string, object>();
  notify.Add("sms", true);
  notify.Add("email", true);
  paymentLinkRequest.Add("reminder_enable", true);
  Dictionary<string, object> notes = new Dictionary<string, object>();
  notes.Add("policy_name", "Life Insurance Policy");
  paymentLinkRequest.Add("notes", notes);

  PaymentLink paymentlink = client.PaymentLink.Create(paymentLinkRequest);
  ```

  ```bash CLI theme={null}
  razorpay payment-links create \
    --amount 1000 \
    --currency INR \
    --upi-link \
    --description "UPI Payment for Order #123" \
    --customer-name "Gaurav Kumar" \
    --customer-contact "+919123456780" \
    --customer-email "gaurav.kumar@example.com" \
    --expire-by 1776758130
  ```

  ```bash Curl theme={null}
  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": "INR",
    "expire_by": 1691097057,
    "reference_id": "TS1989",
    "description": "Payment for policy no #23456",
    "customer": {
      "name": "Gaurav Kumar",
      "contact": "+919000090000",
      "email": "gaurav.kumar@example.com"
    },
    "notify": {
      "sms": true,
      "email": true
    },
    "reminder_enable": true,
    "notes": {
      "policy_name": "Life Insurance Policy"
    },
    "callback_url": "https://example-callback-url.com/",
    "callback_method": "get"
  }'
  ```

  ```php PHP theme={null}
  $api = new Api($key_id, $secret);

  $api->paymentLink->create(array('upi_link'=>true,'amount'=>500, 'currency'=>'INR', 'description' => 'For XYZ purpose', 'customer' => array('name'=>'Gaurav Kumar',
  'email' => 'gaurav.kumar@example.com', 'contact'=>'+919000090000'),  'notify'=>array('sms'=>true, 'email'=>true) ,
  'reminder_enable'=>true ,'notes'=>array('policy_name'=> 'Life Insurance Policy')));
  ```

  ```java Java theme={null}
  import org.json.JSONObject;
  import com.razorpay.Payment;
  import com.razorpay.RazorpayClient;
  import com.razorpay.RazorpayException;

  RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
  JSONObject paymentLinkRequest = new JSONObject();
  paymentLinkRequest.put("upi_link",true);
  paymentLinkRequest.put("amount",1000);
  paymentLinkRequest.put("currency","INR");
  paymentLinkRequest.put("description","Payment for policy no #23456");
  JSONObject customer = new JSONObject();
  customer.put("name","+919000090000");
  customer.put("contact","Gaurav Kumar");
  customer.put("email","gaurav.kumar@example.com");
  paymentLinkRequest.put("customer",customer);
  JSONObject notify = new JSONObject();
  notify.put("sms",true);
  notify.put("email",true);
  paymentLinkRequest.put("notify",notify);
  paymentLinkRequest.put("reminder_enable",true);
  JSONObject notes = new JSONObject();
  notes.put("policy_name","Life Insurance Policy");
  paymentLinkRequest.put("notes",notes);

  PaymentLink payment = razorpay.paymentLink.create(paymentLinkRequest);
  ```

  ```csharp .NET theme={null}
  RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

  Dictionary<string, object> paymentLinkRequest = new Dictionary<string, object>();
  paymentLinkRequest.Add("upi_link", true);
  paymentLinkRequest.Add("amount", 1000);
  paymentLinkRequest.Add("currency", "INR");
  paymentLinkRequest.Add("description", "Payment for policy no #23456");
  Dictionary<string, object> customer = new Dictionary<string, object>();
  customer.Add("contact", "+919999999999");
  customer.Add("name", "Gaurav Kumar");
  customer.Add("email", "gaurav.kumar@example.com");
  paymentLinkRequest.Add("customer", customer);
  Dictionary<string, object> notify = new Dictionary<string, object>();
  notify.Add("sms", true);
  notify.Add("email", true);
  paymentLinkRequest.Add("reminder_enable", true);
  Dictionary<string, object> notes = new Dictionary<string, object>();
  notes.Add("policy_name", "Life Insurance Policy");
  paymentLinkRequest.Add("notes", notes);

  PaymentLink paymentlink = client.PaymentLink.Create(paymentLinkRequest);
  ```

  ```bash CLI theme={null}
  razorpay payment-links create \
    --amount 1000 \
    --currency INR \
    --upi-link \
    --description "UPI Payment for Order #123" \
    --customer-name "Gaurav Kumar" \
    --customer-contact "+919123456780" \
    --customer-email "gaurav.kumar@example.com" \
    --expire-by 1776758130
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "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"
  }
  ```

  ```json Failure theme={null}
  {
    "error": {
      "code": "BAD_REQUEST_ERROR",
      "description": "amount: cannot be blank.",
      "metadata": [],
      "reason": null,
      "source": null,
      "step": null
    }
  }
  ```

  ```json Success theme={null}
  {
    "amount": 1000,
    "amount_paid": 0,
    "cancelled_at": 0,
    "created_at": 1584524459,
    "currency": "INR",
    "customer": {
      "contact": "<phone>",
      "email": "<email>",
      "name": "<name>"
    },
    "description": "Payment for policy no #23456",
    "expire_by": 0,
    "expired_at": 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"
  }
  ```

  ```json Failure theme={null}
  {
    "error": {
      "code": "BAD_REQUEST_ERROR",
      "description": "amount: cannot be blank.",
      "metadata": [],
      "reason": null,
      "source": null,
      "step": null
    }
  }
  ```
</ResponseExample>

## Request Parameters

<ParamField body="amount" type="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.
</ParamField>

<Warning>
  **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`.
</Warning>

<ParamField body="currency" type="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](/docs/us/payments/international-payments#supported-currencies).

  <Info>
    **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](/docs/us/payments/international-payments/currency-conversion) (May 2024).
  </Info>
</ParamField>

<ParamField body="accept_partial" type="boolean">
  Indicates whether customers can make [partial payments](/docs/us/payments/payment-links/partial-payments) using the Payment Link. Possible values:

  * `true`: Customer can make partial payments.
  * `false` (default): Customer cannot make partial payments.
</ParamField>

<ParamField body="first_min_partial_amount" type="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.
</ParamField>

<ParamField body="upi_link" type="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.
</ParamField>

<ParamField body="description" type="string">
  A brief description of the Payment Link. The maximum character limit supported is 2048.
</ParamField>

<ParamField body="reference_id" type="string">
  Reference number tagged to a Payment Link. Must be a unique number for each Payment Link. The maximum character limit supported is 40.
</ParamField>

<ParamField body="customer" type="json object">
  Customer details
</ParamField>

<ParamField body="name" type="string">
  The customer's name.
</ParamField>

<ParamField body="email" type="string">
  The customer's email address.
</ParamField>

<ParamField body="contact" type="string">
  The customer's phone number.
</ParamField>

<ParamField body="expire_by" type="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.
</ParamField>

<ParamField body="notify" type="array">
  Defines who handles Payment Link notification.
</ParamField>

<ParamField body="sms" type="boolean">
  Defines who handles the SMS notification. Possible values:

  * `true`: Razorpay handles the notification.
  * `false`: You handle the notification.
</ParamField>

<ParamField body="email" type="boolean">
  Defines who handles the email notification. Possible values:

  * `true`: Razorpay handles the notification.
  * `false`: You handle the notification.
</ParamField>

<ParamField body="notes" type="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.”`.
</ParamField>

<ParamField body="callback_url" type="string">
  If specified, adds a redirect URL to the Payment Link. Once customers completes the payment, they are redirected to the specified URL.

  <Info>
    **Handy Tips**

    If the `callback_url` is passed, it must be passed in the correct format. That is, it should contain a URL.
  </Info>
</ParamField>

<ParamField body="callback_method" type="string" required>
  If `callback_url` parameter is passed, callback\_method must be passed with the value `get`.
</ParamField>

<ParamField body="reminder_enable" type="boolean">
  Used to send [reminders](/docs/us/payments/payment-links/reminders) for the Payment Link. Possible values:

  * `true`: To send reminders.
  * `false`: To disable reminders.
</ParamField>

## Response Parameters

<ResponseField name="accept_partial" type="boolean">
  Indicates whether customers can make [partial payments](/docs/us/payments/payment-links/partial-payments) using the Payment Link. Possible values:

  * `true`: Customer can make partial payments.
  * `false` (default): Customer cannot make partial payments.
</ResponseField>

<ResponseField name="amount" type="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.

  <Warning>
    **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`.
  </Warning>
</ResponseField>

<ResponseField name="amount_paid" type="integer">
  Amount paid by the customer.
</ResponseField>

<ResponseField name="callback_url" type="string">
  If specified, adds a redirect URL to the Payment Link. Once the customer completes the payment, they are redirected to the specified URL.
</ResponseField>

<ResponseField name="callback_method" type="string">
  If `callback_url` parameter is passed, `callback_method` must be passed with the value `get`.
</ResponseField>

<ResponseField name="cancelled_at" type="integer">
  Timestamp, in Unix, at which the Payment Link was cancelled by you.
</ResponseField>

<ResponseField name="created_at" type="integer">
  Timestamp, in Unix, indicating when the Payment Link was created.
</ResponseField>

<ResponseField name="currency" type="string">
  Defaults to INR. We accept payments in [international currencies.](/docs/us/payments/international-payments#supported-currencies)

  <Info>
    **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](/docs/us/payments/international-payments/currency-conversion) (May 2024).
  </Info>
</ResponseField>

<ResponseField name="customer" type="json object">
  Customer details.
</ResponseField>

<ResponseField name="name" type="string">
  The customer's name.
</ResponseField>

<ResponseField name="email" type="string">
  The customer's email address.
</ResponseField>

<ResponseField name="contact" type="string">
  The customer's phone number.
</ResponseField>

<ResponseField name="description" type="string">
  A brief description of the Payment Link.
</ResponseField>

<ResponseField name="expire_by" type="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.
</ResponseField>

<ResponseField name="expired_at" type="integer">
  Timestamp, in Unix, at which the Payment Link expired.
</ResponseField>

<ResponseField name="first_min_partial_amount" type="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`.
</ResponseField>

<ResponseField name="id" type="string">
  Unique identifier of the Payment Link. For example, `plink_ERgihyaAAC0VNW`.
</ResponseField>

<ResponseField name="upi_link" type="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.
</ResponseField>

<ResponseField name="notes" type="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.
</ResponseField>

<ResponseField name="notify" type="array">
  Defines who handles Payment Link notification.
</ResponseField>

<ResponseField name="sms" type="boolean">
  Defines who handles the SMS notification.

  * `true`: Razorpay handles the notification.
  * `false`: Businesses handle the notification.
</ResponseField>

<ResponseField name="email" type="boolean">
  Defines who handles the email notification.

  * `true`: Razorpay handles the notification.
  * `false`: Businesses handle the notification.
</ResponseField>

<ResponseField name="payments" type="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`.
</ResponseField>

<ResponseField name="amount" type="integer">
  The amount paid by the customer using the Payment Link.
</ResponseField>

<ResponseField name="created_at" type="integer">
  Timestamp, in Unix, indicating when the payment was made.
</ResponseField>

<ResponseField name="method" type="string">
  The payment method used to make the payment. Possible values:

  * `netbanking`
  * `card`
  * `wallet`
  * `upi`
  * `emi`
  * `bank_transfer`
</ResponseField>

<ResponseField name="payment_id" type="string">
  Unique identifier of the payment made against the Payment Link.
</ResponseField>

<ResponseField name="plink_id" type="string">
  Unique identifier of the Payment Link. For example, `plink_ERgihyaAAC0VNW`.
</ResponseField>

<ResponseField name="status" type="string">
  The payment state. Possible value is `captured`.
</ResponseField>

<ResponseField name="updated_at" type="integer">
  Timestamp, in Unix, indicating when the payment was updated.
</ResponseField>

<ResponseField name="reference_id" type="string">
  Reference number tagged to a Payment Link. Must be a unique number for each Payment Link. The maximum character limit supported is 40.
</ResponseField>

<ResponseField name="short_url" type="string">
  The unique short URL generated for the Payment Link.
</ResponseField>

<ResponseField name="status" type="string">
  Displays the current state of the Payment Link. Possible values:

  * `created`
  * `partially_paid`
  * `expired`
  * `cancelled`
  * `paid`
</ResponseField>

<ResponseField name="updated_at" type="integer">
  Timestamp, in Unix, indicating when the Payment Link was updated.
</ResponseField>

<ResponseField name="reminder_enable" type="boolean">
  Used to send [reminders](/docs/us/payments/payment-links/reminders) for the Payment Link. Possible values:

  * `true`: To send reminders.
  * `false`: To disable reminders.
</ResponseField>

<ResponseField name="user_id" type="string">
  A unique identifier for the user role through which the Payment Link was created. For example, `HD1JAKCCPGDfRx`.
</ResponseField>

<ResponseField name="options" type="array">
  Custom checkout options applied to this payment link (theme, prefill, etc.). Empty when none.
</ResponseField>

## Errors

<AccordionGroup>
  <Accordion title="The {input field} is required">
    **Code:** `4xx`

    A mandatory field is empty.

    **Solution:** Ensure all mandatory fields and values are present.
  </Accordion>

  <Accordion title="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](/docs/us/api/payments/payment-links#request-parameters) on how to add correct input fields.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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](/docs/us/api/authentication#live-mode-api-keys) while passing UPI links.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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](https://razorpay.com/support/) to get live mode enabled for you.
  </Accordion>

  <Accordion title="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](https://razorpay.com/support/) to be reinstated.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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).
  </Accordion>

  <Accordion title="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).
  </Accordion>

  <Accordion title="email: must be in a valid format for e.g. abcxyz@domain.com.">
    **Code:** `400`

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

    **Solution:** Pass `customer.email` as a valid email address.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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](https://razorpay.com/support/) to get it enabled.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>
</AccordionGroup>