Skip to main content
GET
Retrieve Payment Link

Overview

Fetch detailed information about a specific payment link using its unique ID. This includes the current status, the payments made through it, buyer details, and associated order information.

Path Parameters

  • paymentLinkId: The link’s link_id from Create Payment Link (e.g., PR5106085554). The payment_id it returns is the same value.
  • paid_payment_id: The link’s payment_id once it is paid, or null until then.
  • payments: The link’s payment, as a single entry from the moment the link is created: its payment_id (the same as link_id), status (pending, captured, failed or, rarely, invalid), mop_type (e.g. upi, or null), amount in the format Create Payment Link returns ("1500", or "1500.50" when there are paise), created_at, and payment_completed_at (null until it completes).
link_id is the link’s ID; payment_id is the same value, kept for compatibility.

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 - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Path Parameters

The link's link_id from Create Payment Link (e.g. PR5106085554). The payment_id Create Payment Link returns is the same value.

Response

Payment link details retrieved successfully

success
boolean
message
string
data
object