Create a payment link

POST

payment_links

curl --request POST \
  --url https://api.razorpay.com/v1/payment_links \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 50000,
  "currency": "INR",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "+919900000000"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  "expire_by": 1691097057,
  "accept_partial": false,
  "reference_id": "TS1989"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 50000,
    currency: 'INR',
    description: 'Payment for policy no #23456',
    customer: {
      name: 'Gaurav Kumar',
      email: 'gaurav.kumar@example.com',
      contact: '+919900000000'
    },
    notify: {sms: true, email: true},
    reminder_enable: true,
    expire_by: 1691097057,
    accept_partial: false,
    reference_id: 'TS1989'
  })
};

fetch('https://api.razorpay.com/v1/payment_links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.razorpay.com/v1/payment_links"

payload = {
    "amount": 50000,
    "currency": "INR",
    "description": "Payment for policy no #23456",
    "customer": {
        "name": "Gaurav Kumar",
        "email": "gaurav.kumar@example.com",
        "contact": "+919900000000"
    },
    "notify": {
        "sms": True,
        "email": True
    },
    "reminder_enable": True,
    "expire_by": 1691097057,
    "accept_partial": False,
    "reference_id": "TS1989"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.razorpay.com/v1/payment_links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 50000,
    'currency' => 'INR',
    'description' => 'Payment for policy no #23456',
    'customer' => [
        'name' => 'Gaurav Kumar',
        'email' => 'gaurav.kumar@example.com',
        'contact' => '+919900000000'
    ],
    'notify' => [
        'sms' => true,
        'email' => true
    ],
    'reminder_enable' => true,
    'expire_by' => 1691097057,
    'accept_partial' => false,
    'reference_id' => 'TS1989'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.razorpay.com/v1/payment_links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 50000,\n  \"currency\": \"INR\",\n  \"description\": \"Payment for policy no #23456\",\n  \"customer\": {\n    \"name\": \"Gaurav Kumar\",\n    \"email\": \"gaurav.kumar@example.com\",\n    \"contact\": \"+919900000000\"\n  },\n  \"notify\": {\n    \"sms\": true,\n    \"email\": true\n  },\n  \"reminder_enable\": true,\n  \"expire_by\": 1691097057,\n  \"accept_partial\": false,\n  \"reference_id\": \"TS1989\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.razorpay.com/v1/payment_links"

	payload := strings.NewReader("{\n  \"amount\": 50000,\n  \"currency\": \"INR\",\n  \"description\": \"Payment for policy no #23456\",\n  \"customer\": {\n    \"name\": \"Gaurav Kumar\",\n    \"email\": \"gaurav.kumar@example.com\",\n    \"contact\": \"+919900000000\"\n  },\n  \"notify\": {\n    \"sms\": true,\n    \"email\": true\n  },\n  \"reminder_enable\": true,\n  \"expire_by\": 1691097057,\n  \"accept_partial\": false,\n  \"reference_id\": \"TS1989\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.razorpay.com/v1/payment_links")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 50000,\n  \"currency\": \"INR\",\n  \"description\": \"Payment for policy no #23456\",\n  \"customer\": {\n    \"name\": \"Gaurav Kumar\",\n    \"email\": \"gaurav.kumar@example.com\",\n    \"contact\": \"+919900000000\"\n  },\n  \"notify\": {\n    \"sms\": true,\n    \"email\": true\n  },\n  \"reminder_enable\": true,\n  \"expire_by\": 1691097057,\n  \"accept_partial\": false,\n  \"reference_id\": \"TS1989\"\n}")
  .asString();

{
  "id": "plink_ERgihyaAAC0VNW",
  "entity": "payment_link",
  "accept_partial": false,
  "amount": 50000,
  "amount_paid": 0,
  "cancelled_at": null,
  "created_at": 1591097057,
  "currency": "INR",
  "customer": {
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "+919900000000"
  },
  "description": "Payment for policy no #23456",
  "expire_by": 1691097057,
  "expired_at": null,
  "reference_id": "TS1989",
  "reminder_enable": true,
  "short_url": "https://rzp.io/i/nxrHnLJ",
  "status": "created",
  "updated_at": 1591097057,
  "user_id": ""
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The amount must be greater than 0.",
    "field": "amount"
  }
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The amount must be greater than 0.",
    "field": "amount"
  }
}

Authorizations

Authorization

string

header

required

Use your Razorpay Key ID as the username and Key Secret as the password.

Body

application/json

amount

integer

required

Payment link amount in the smallest currency unit (e.g., paise for INR). Must be greater than 0.

Example:

50000

currency

string

required

ISO 4217 currency code. Supported values include INR.

Example:

"INR"

description

string

A brief description of the payment link shown to the customer on the payment page.

Example:

"Payment for policy no #23456"

customer

object

Customer contact details.

Show child attributes

notify

object

Notification channels for sending the payment link to the customer.

Show child attributes

reminder_enable

boolean

Set to true to send payment reminders to the customer.

Example:

true

expire_by

integer

Unix timestamp after which the payment link will expire. Must be at least 15 minutes in the future.

Example:

1691097057

accept_partial

boolean

Set to true to allow the customer to pay a partial amount.

Example:

false

reference_id

string

An optional reference identifier for internal use. Must be unique per payment link.

Example:

"TS1989"

Response

Payment link created successfully.

A Razorpay Payment Link object.

string

Unique identifier of the payment link.

Example:

"plink_ERgihyaAAC0VNW"

entity

string

Entity type. Always payment_link.

Example:

"payment_link"

accept_partial

boolean

Indicates whether the customer can make a partial payment.

Example:

false

amount

integer

Payment link amount in the smallest currency unit (e.g., paise for INR).

Example:

50000

amount_paid

integer

Amount paid against the payment link so far.

Example:

0

cancelled_at

integer | null

Unix timestamp at which the payment link was cancelled. null if not cancelled.

Example:

null

created_at

integer

Unix timestamp at which the payment link was created.

Example:

1591097057

currency

string

ISO 4217 currency code.

Example:

"INR"

customer

object

Customer contact details.

Show child attributes

description

string

A brief description shown to the customer on the payment page.

Example:

"Payment for policy no #23456"

expire_by

integer | null

Unix timestamp after which the payment link will expire.

Example:

1691097057

expired_at

integer | null

Unix timestamp at which the payment link expired.

Example:

null

reference_id

string | null

An optional reference identifier you can set for internal use.

Example:

"TS1989"

reminder_enable

boolean

Indicates whether payment reminders are enabled for the link.

Example:

true

short_url

string

Short URL of the payment link that is shared with customers.

Example:

"https://rzp.io/i/nxrHnLJ"

status

enum<string>

Current status of the payment link.

Available options:

created,

partially_paid,

paid,

cancelled,

expired

Example:

"created"

updated_at

integer

Unix timestamp at which the payment link was last updated.

Example:

1591097057

user_id

string

Unique identifier of the Razorpay user who created the payment link.

Example:

""

Create a payment link

curl --request POST \
  --url https://api.razorpay.com/v1/payment_links \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 50000,
  "currency": "INR",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "+919900000000"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  "expire_by": 1691097057,
  "accept_partial": false,
  "reference_id": "TS1989"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 50000,
    currency: 'INR',
    description: 'Payment for policy no #23456',
    customer: {
      name: 'Gaurav Kumar',
      email: 'gaurav.kumar@example.com',
      contact: '+919900000000'
    },
    notify: {sms: true, email: true},
    reminder_enable: true,
    expire_by: 1691097057,
    accept_partial: false,
    reference_id: 'TS1989'
  })
};

fetch('https://api.razorpay.com/v1/payment_links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.razorpay.com/v1/payment_links"

payload = {
    "amount": 50000,
    "currency": "INR",
    "description": "Payment for policy no #23456",
    "customer": {
        "name": "Gaurav Kumar",
        "email": "gaurav.kumar@example.com",
        "contact": "+919900000000"
    },
    "notify": {
        "sms": True,
        "email": True
    },
    "reminder_enable": True,
    "expire_by": 1691097057,
    "accept_partial": False,
    "reference_id": "TS1989"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.razorpay.com/v1/payment_links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 50000,
    'currency' => 'INR',
    'description' => 'Payment for policy no #23456',
    'customer' => [
        'name' => 'Gaurav Kumar',
        'email' => 'gaurav.kumar@example.com',
        'contact' => '+919900000000'
    ],
    'notify' => [
        'sms' => true,
        'email' => true
    ],
    'reminder_enable' => true,
    'expire_by' => 1691097057,
    'accept_partial' => false,
    'reference_id' => 'TS1989'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.razorpay.com/v1/payment_links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 50000,\n  \"currency\": \"INR\",\n  \"description\": \"Payment for policy no #23456\",\n  \"customer\": {\n    \"name\": \"Gaurav Kumar\",\n    \"email\": \"gaurav.kumar@example.com\",\n    \"contact\": \"+919900000000\"\n  },\n  \"notify\": {\n    \"sms\": true,\n    \"email\": true\n  },\n  \"reminder_enable\": true,\n  \"expire_by\": 1691097057,\n  \"accept_partial\": false,\n  \"reference_id\": \"TS1989\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.razorpay.com/v1/payment_links"

	payload := strings.NewReader("{\n  \"amount\": 50000,\n  \"currency\": \"INR\",\n  \"description\": \"Payment for policy no #23456\",\n  \"customer\": {\n    \"name\": \"Gaurav Kumar\",\n    \"email\": \"gaurav.kumar@example.com\",\n    \"contact\": \"+919900000000\"\n  },\n  \"notify\": {\n    \"sms\": true,\n    \"email\": true\n  },\n  \"reminder_enable\": true,\n  \"expire_by\": 1691097057,\n  \"accept_partial\": false,\n  \"reference_id\": \"TS1989\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.razorpay.com/v1/payment_links")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 50000,\n  \"currency\": \"INR\",\n  \"description\": \"Payment for policy no #23456\",\n  \"customer\": {\n    \"name\": \"Gaurav Kumar\",\n    \"email\": \"gaurav.kumar@example.com\",\n    \"contact\": \"+919900000000\"\n  },\n  \"notify\": {\n    \"sms\": true,\n    \"email\": true\n  },\n  \"reminder_enable\": true,\n  \"expire_by\": 1691097057,\n  \"accept_partial\": false,\n  \"reference_id\": \"TS1989\"\n}")
  .asString();

{
  "id": "plink_ERgihyaAAC0VNW",
  "entity": "payment_link",
  "accept_partial": false,
  "amount": 50000,
  "amount_paid": 0,
  "cancelled_at": null,
  "created_at": 1591097057,
  "currency": "INR",
  "customer": {
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "+919900000000"
  },
  "description": "Payment for policy no #23456",
  "expire_by": 1691097057,
  "expired_at": null,
  "reference_id": "TS1989",
  "reminder_enable": true,
  "short_url": "https://rzp.io/i/nxrHnLJ",
  "status": "created",
  "updated_at": 1591097057,
  "user_id": ""
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The amount must be greater than 0.",
    "field": "amount"
  }
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The amount must be greater than 0.",
    "field": "amount"
  }
}

Introduction

API Guides

Core Resources API

Products API

Additional Resources

Payments

QR Codes

RazorpayX

Partners

Create a payment link

Authorizations

Body

Response