Retrieve Payment Link

curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'

import requests

url = "https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/"

headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "X-API-Version": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'X-API-Version': '<api-key>'
  }
};

fetch('https://api-pacb-uat.eximpe.com/pg/payment-links/{link_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-pacb-uat.eximpe.com/pg/payment-links/{link_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 => [
    "X-API-Version: <api-key>",
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/"

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

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("X-API-Version", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/")
  .header("X-Client-ID", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("X-API-Version", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/")

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

request = Net::HTTP::Get.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["X-API-Version"] = '<api-key>'

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

{
  "success": true,
  "message": "Payment link details fetched successfully",
  "data": {
    "payment_id": "PR4829301756",
    "link_id": "PR4829301756",
    "reference_id": "ORD-2026-000123",
    "currency": "INR",
    "payment_link": "https://api-pacb-uat.eximpe.com/p/Xk3nQ7bT2mWp9vLc4R/",
    "expiry_date": "2026-12-31T18:29:59.000000Z",
    "mop_type": null,
    "settlement": {
      "status": "not_applicable",
      "message": null,
      "settlement_details": null
    },
    "buyer": {
      "name": "Rahul Sharma",
      "email": "[email protected]",
      "phone": "+919876543210",
      "address": {
        "line_1": "221B MG Road",
        "line_2": "Indiranagar",
        "city": "Bengaluru",
        "state": "Karnataka",
        "postal_code": "560038"
      },
      "pan_number": null,
      "dob": null
    },
    "product": {
      "name": "Annual subscription",
      "description": "12-month premium plan",
      "hs_code": null,
      "hs_code_description": null,
      "type_of_goods": "service"
    },
    "invoice": {
      "number": "INV2026000123",
      "date": null,
      "file": null
    },
    "air_waybills": [],
    "status": "active",
    "status_message": null,
    "created_at": "2026-09-14T09:30:15.123456Z",
    "paid_payment_id": null,
    "payments": []
  }
}

GET

payment-links

{link_id}

Retrieve Payment Link

curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'

import requests

url = "https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/"

headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "X-API-Version": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'X-API-Version': '<api-key>'
  }
};

fetch('https://api-pacb-uat.eximpe.com/pg/payment-links/{link_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-pacb-uat.eximpe.com/pg/payment-links/{link_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 => [
    "X-API-Version: <api-key>",
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/"

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

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("X-API-Version", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/")
  .header("X-Client-ID", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("X-API-Version", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-pacb-uat.eximpe.com/pg/payment-links/{link_id}/")

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

request = Net::HTTP::Get.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["X-API-Version"] = '<api-key>'

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

{
  "success": true,
  "message": "Payment link details fetched successfully",
  "data": {
    "payment_id": "PR4829301756",
    "link_id": "PR4829301756",
    "reference_id": "ORD-2026-000123",
    "currency": "INR",
    "payment_link": "https://api-pacb-uat.eximpe.com/p/Xk3nQ7bT2mWp9vLc4R/",
    "expiry_date": "2026-12-31T18:29:59.000000Z",
    "mop_type": null,
    "settlement": {
      "status": "not_applicable",
      "message": null,
      "settlement_details": null
    },
    "buyer": {
      "name": "Rahul Sharma",
      "email": "[email protected]",
      "phone": "+919876543210",
      "address": {
        "line_1": "221B MG Road",
        "line_2": "Indiranagar",
        "city": "Bengaluru",
        "state": "Karnataka",
        "postal_code": "560038"
      },
      "pan_number": null,
      "dob": null
    },
    "product": {
      "name": "Annual subscription",
      "description": "12-month premium plan",
      "hs_code": null,
      "hs_code_description": null,
      "type_of_goods": "service"
    },
    "invoice": {
      "number": "INV2026000123",
      "date": null,
      "file": null
    },
    "air_waybills": [],
    "status": "active",
    "status_message": null,
    "created_at": "2026-09-14T09:30:15.123456Z",
    "paid_payment_id": null,
    "payments": []
  }
}

Overview

Returns one payment link: its status, the payments made through it, its expiry_date, buyer, product, invoice and settlement. Use it to confirm a link’s outcome — for an active link it checks for a payment before answering, so it can be ahead of List Payment Links.

Path Parameters

link_id: The link’s ID from Create Payment Link, e.g. PR4829301756. The payment_id it returned is the same value.

From a payment webhook, pass its link_id: the webhook’s payment_id names the payment, not the link. A link that is not yours — or, for a PSP, not one of your sub-merchants’ — reads as not found:

{
  "success": false,
  "error": {
    "code": "ERR_PAYMENT_005",
    "message": "Payment not found",
    "details": {
      "payment_id": "Payment not found"
    }
  }
}

PSPs do not need X-Merchant-ID here: a sub-merchant’s link is found without it.

Link status

`status`	Meaning
`active`	Open for payment.
`paid`	Paid. This outranks expiry: a paid link reads `paid` even after its `expiry_date` passes.
`expired`	Past its `expiry_date`, or deactivated — a deactivated link reads `expired`.
`failed`	Could not be created, or closed without being paid.

How the link was paid

A buyer may try more than once before a payment goes through. Two fields show the payments made through the link:

paid_payment_id: The payment_id of the payment that paid the link, or null until it is paid. Refund and reconcile by this ID — see Tracking a payment link.
payments: The payments made through the link, newest first — at most the 50 newest. Each entry carries:

Field	Description
`payment_id`	The payment’s ID. Its payment webhooks carry it, next to the link’s `link_id`
`status`	`pending` while it is under way, `captured` once it went through, `failed` — or, rarely, `invalid` — if it did not
`mop_type`	The method it was made with, in lowercase (`upi`, `credit_card`), or `null` when none is recorded
`amount`	Its amount, in the format Create Payment Link returns: a decimal string, `"1500"` for whole rupees and `"1500.50"` when there are paise
`created_at`	When it was made
`payment_completed_at`	When it completed, or `null` until it has — usually `null` for a payment that failed

On some accounts a link and its payment share one ID. There payments holds a single entry whose payment_id is link_id, from the moment the link is created, and paid_payment_id becomes that same ID once the buyer pays. Elsewhere each try is a payment of its own, and payments stays empty until the buyer first tries to pay. A link the buyer paid on their second try, with the rest of the response left out:

{
  "link_id": "PR6120458839",
  "status": "paid",
  "paid_payment_id": "PR7730215564",
  "payments": [
    {
      "payment_id": "PR7730215564",
      "status": "captured",
      "mop_type": "upi",
      "amount": "1500",
      "created_at": "2026-09-14T10:02:44.519302Z",
      "payment_completed_at": "2026-09-14T10:03:21.087716Z"
    },
    {
      "payment_id": "PR7730209921",
      "status": "failed",
      "mop_type": "credit_card",
      "amount": "1500",
      "created_at": "2026-09-14T09:48:10.332907Z",
      "payment_completed_at": null
    }
  ]
}

Response Fields

The response carries no amount for the link. Keep the amount from Create Payment Link, or read amount from List Payment Links.

link_id: The link’s ID. payment_id is the same value, kept for compatibility.
expiry_date: When the link stops accepting payment. For a deactivated link, the moment it was deactivated.
mop_type: The method the buyer paid with, in uppercase (UPI, CREDIT_CARD) — List gives the same value in lowercase. It is null until the link is paid, and can stay null after. payments gives the method of each payment.
buyer, product, invoice: As sent on create.
- buyer.pan_number and buyer.dob are null unless they were collected from the buyer.
- product.hs_code and product.hs_code_description are null: the link does not store them.
- invoice.date and invoice.file are null unless they were added to the order later.
settlement: The settlement state recorded against the link. settlement_details stays null until the payment is part of a settlement; its settlement_id is what Get Settlement takes. When paid_payment_id differs from link_id, the money moved on that payment rather than on the link, and settlement does not follow it: reconcile by paid_payment_id.
status_message: Why the link failed or closed, when there is a reason to give; otherwise null.
created_at and the other timestamps are UTC with microseconds, e.g. 2026-09-14T09:30:15.123456Z.

Authorizations

X-Client-ID

string

header

required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret

string

header

required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-API-Version

string

header

required

API Version - Optional, and not a credential. Send 3.0.0 for v3. If you omit it, the call still succeeds and the response echoes your account's default version in an X-API-Version header.

Path Parameters

link_id

string

required

The link's link_id, as returned by Create Payment Link (PR followed by 10 digits). The payment_id Create Payment Link returns is the same value.

Example:

"PR4829301756"

Response

The payment link

success

boolean

required

Indicates if the request was successful

message

string

required

Response message

data

object

required

The link, and the payments made through it. The link's amount is not included: keep the one from the create response, or read it from List Payment Links.

Show child attributes

Order

Payment

Merchant

Settlement

Refund

Subscriptions

Payment Links

Virtual Bank Accounts

LRS

B2B Services

Webhooks

Retrieve Payment Link

Overview

Path Parameters

Link status

How the link was paid

Response Fields

Authorizations

Path Parameters

Response

​Overview

​Path Parameters

​Link status

​How the link was paid

​Response Fields

Authorizations

Path Parameters

Response

Overview

Path Parameters

Link status

How the link was paid

Response Fields