List all payment links

GET

payment_links

curl --request GET \
  --url https://api.razorpay.com/v1/payment_links \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

<?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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "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"
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

count

integer

default:10

Number of payment links to return. Default is 10, maximum is 100.

Required range: x <= 100

Example:

10

skip

integer

default:0

Number of payment links to skip before returning results. Used for pagination.

Example:

0

reference_id

string

Filter by your internal reference ID.

Response

List of payment links retrieved successfully.

Paginated list of payment links.

entity

string

Entity type. Always collection.

Example:

"collection"

count

integer

Number of payment links returned in this response.

Example:

1

items

object[]

List of payment link objects.

Show child attributes

List all payment links

curl --request GET \
  --url https://api.razorpay.com/v1/payment_links \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

<?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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "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"
  }
}

Introduction

API Guides

Core Resources API

Products API

Additional Resources

Payments

QR Codes

RazorpayX

Partners

List all payment links

Authorizations

Query Parameters

Response