Fetch a payment link

GET

payment_links

{id}

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

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

fetch('https://api.razorpay.com/v1/payment_links/{id}', 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/{id}",
  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/{id}")

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/{id}"

	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))

}

{
  "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"
  }
}

{
  "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.

Path Parameters

string

required

Unique identifier of the payment link.

Example:

"plink_ERgihyaAAC0VNW"

Response

Payment link details retrieved 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:

""

Fetch a payment link

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

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

fetch('https://api.razorpay.com/v1/payment_links/{id}', 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/{id}",
  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/{id}")

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/{id}"

	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))

}

{
  "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"
  }
}

{
  "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

Fetch a payment link

Authorizations

Path Parameters

Response