Manage Reminders for Payment Links

POST /v1/payment_links

Use this endpoint to manage reminders for Payment Links.

• While reminders are enabled globally from Dashboard Settings, you can disable them for specific Payment Links. A valid use case for this might be when the customer has paid the money to you offline. In this case, you would not want reminders to be sent to them.

• You can disable reminders during creation of Payment Link or by updating the link. To disable reminders for a Payment Link, pass reminder_enable as false, during Payment Link creation.

Request

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payment_links/ \
-H 'Content-type: application/json' \
-d '{
  "amount": 1000,
  "currency": "INR",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#425",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "[phone]",
    "email": "[e-mail]"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": false
}'

```php: PHP
$api = new Api($key_id, $secret);

$api->paymentLink->create(array('amount'=>500, 'currency'=>'INR', 'accept_partial'=>true, 'first_min_partial_amount'=>100, 'description' => 'For XYZ purpose', 'customer' => array('name'=>'Gaurav Kumar', 'email' => '[e-mail]', 'contact'=>'[phone]'),  'notify'=>array('sms'=>true, 'email'=>true) ,'reminder_enable'=>false));

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

instance.paymentLink.create({
  amount: 1000,
  currency: "INR",
  accept_partial: true,
  first_min_partial_amount: 100,
  reference_id: "#425",
  description: "Payment for policy no #23456",
  customer: {
    name: "Gaurav Kumar",
    contact: "[phone]",
    email: "[e-mail]"
  },
  notify: {
    sms: true,
    email: true
  },
  reminder_enable: false
})

```python: Python
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment_link.create({
  "amount": 1000,
  "currency": "INR",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#425",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "[phone]",
    "email": "[e-mail]"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": false
})

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

data := map[string]interface{}{
      "amount": 1000,
      "currency": "INR",
      "accept_partial": true,
      "first_min_partial_amount": 100,
      "reference_id": "#425",
      "description": "Payment for policy no #23456",
      "customer": map[string]interface{}{
        "name": "Gaurav Kumar",
        "contact": "[phone]",
        "email": "[e-mail]",
      },
      "notify": map[string]interface{}{
        "sms": true,
        "email": true,
      },
      "reminder_enable": false
    }
body, err := client.PaymentLink.Create(data, nil)

```ruby: Ruby
require "razorpay"
Razorpay.setup('key_id', 'key_secret')

para_attr = {
  "amount": 1000,
  "currency": "INR",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#425",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "[phone]",
    "email": "[e-mail]"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": false
}

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

Razorpay::PaymentLink.create(para_attr.to_json)

```java: Java
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("amount",3400);
paymentLinkRequest.put("currency","INR");
paymentLinkRequest.put("accept_partial",true);
paymentLinkRequest.put("reference_id","#aasasw8");
paymentLinkRequest.put("first_min_partial_amount",100);
paymentLinkRequest.put("description","Payment for policy no #23456");
JSONObject customer = new JSONObject();
customer.put("name","Gaurav Kumar");
customer.put("contact","[phone]");
customer.put("email","[e-mail]");
paymentLinkRequest.put("customer",customer);
JSONObject notify = new JSONObject();
notify.put("sms",true);
notify.put("email",true);
paymentLinkRequest.put("notify",notify);
paymentLinkRequest.put("reminder_enable",false);
              
PaymentLink payment = razorpay.paymentLink.create(paymentLinkRequest);

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary paymentLinkRequest = new Dictionary();
paymentLinkRequest.Add("amount",3400);
paymentLinkRequest.Add("currency","INR");
paymentLinkRequest.Add("accept_partial",true);
paymentLinkRequest.Add("reference_id","#aasasw8");
paymentLinkRequest.Add("first_min_partial_amount",100);
paymentLinkRequest.Add("description","Payment for policy no #23456");
Dictionary customer = new Dictionary();
customer.Add("contact","[phone]");
customer.Add("name","Gaurav Kumar");
customer.Add("email","[e-mail]");
paymentLinkRequest.Add("customer",customer);
Dictionary notify = new Dictionary();
notify.Add("sms",true);
notify.Add("email",true);
paymentLinkRequest.Add("notify",notify);
paymentLinkRequest.Add("reminder_enable",false);
              
PaymentLink paymentlink = client.PaymentLink.Create(paymentLinkRequest);

Response

Success

{
  "amount": 340000,
  "amount_due": 340000,
  "amount_paid": 0,
  "billing_end": null,
  "billing_start": null,
  "cancelled_at": null,
  "comment": null,
  "created_at": 1592579126,
  "currency": "INR",
  "currency_symbol": "₹",
  "customer_details": {
    "billing_address": null,
    "contact": "[phone]",
    "customer_contact": "[phone]",
    "customer_email": "[e-mail]",
    "customer_name": "Gaurav Kumar",
    "email": "[e-mail]",
    "gstin": null,
    "id": "cust_F4WNtqj1xb0Duv",
    "name": "Gaurav Kumar",
    "shipping_address": null
  },
  "customer_id": "cust_F4WNtqj1xb0Duv",
  "date": 1592579126,
  "description": "Salon at Home Service",
  "email_status": null,
  "entity": "invoice",
  "expire_by": 1608390326,
  "expired_at": null,
  "first_payment_min_amount": 0,
  "gross_amount": 340000,
  "group_taxes_discounts": false,
  "id": "inv_F4WfpZLk1ct35b",
  "invoice_number": null,
  "issued_at": 1592579126,
  "line_items": [],
  "notes": [],
  "order_id": "order_F4WfpxUzWmYOTl",
  "paid_at": null,
  "partial_payment": false,
  "payment_id": null,
  "receipt": "5757",
  "reminder_enable": false,
  "short_url": "https://rzp.io/i/vitLptM",
  "sms_status": null,
  "status": "issued",
  "tax_amount": 0,
  "taxable_amount": 0,
  "terms": null,
  "type": "link",
  "user_id": "",
  "view_less": true
}

Parameters

amount mandatory : 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 300, you must enter the value 30000.

currency optional : 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.

.

accept_partial optional : 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 conditionally mandatory : integer 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 700 is to be received from the customer in two installments of #1 - 500, #2 - 200, then you can set this value as 500000. Must be passed along with accept_partial parameter.

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

customer optional : json object Customer details

name optional : string The customer’s name.

email optional : string The customer’s email address.

contact optional : string The customer’s phone number.

notify optional : array Defines who handles Payment Link notification.

sms optional : boolean Defines who handles the SMS notification. Possible values:

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

email optional : boolean Defines who handles the email notification. Possible values:

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

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

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

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.