> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Payment Link

> Get detailed information about a specific payment link.

## Overview

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

## Path Parameters

* `paymentLinkId`: The unique identifier of the payment link (e.g., `PR5106085554`).


## OpenAPI

````yaml GET /pg/payment-links/{paymentLinkId}/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API
  description: >-
    API for payment processing and order management through Eximpe payment
    gateway. This specification includes v1, v2, and v3 API versions.
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api-pacb-uat.eximpe.com
    description: Payment Gateway Sandbox URL
security:
  - clientAuth: []
    clientSecretAuth: []
    apiVersionHeader: []
tags:
  - name: Card Tokens
  - name: Merchants
  - name: Orders
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Settlements
  - name: Subscriptions
paths:
  /pg/payment-links/{paymentLinkId}/:
    get:
      tags:
        - Payment Links
      summary: Retrieve Payment Link
      description: Get detailed information about a specific payment link.
      operationId: v1_get_pg_payment-links_paymentLinkId_
      parameters:
        - name: paymentLinkId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Payment link details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_PaymentLinkDetailsResponse'
        '404':
          description: Payment link not found
      security:
        - clientAuth: []
          clientSecretAuth: []
          apiVersionHeader: []
components:
  schemas:
    v1_PaymentLinkDetailsResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            payment_id:
              type: string
            reference_id:
              type: string
            amount:
              type: string
            currency:
              type: string
            payment_link:
              type: string
              format: uri
            status:
              type: string
            status_message:
              type: string
              nullable: true
            created_at:
              type: string
              format: date-time
            buyer:
              type: object
              properties:
                name:
                  type: string
                email:
                  type: string
                phone:
                  type: string
                address:
                  $ref: '#/components/schemas/v1_Address'
                pan_number:
                  type: string
                  nullable: true
                dob:
                  type: string
                  nullable: true
            product:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                  nullable: true
                hs_code:
                  type: string
                  nullable: true
                hs_code_description:
                  type: string
                  nullable: true
                type_of_goods:
                  type: string
            invoice:
              type: object
              properties:
                number:
                  type: string
                date:
                  type: string
                  nullable: true
                file:
                  type: string
                  format: uri
                  nullable: true
            settlement:
              type: object
              properties:
                status:
                  type: string
                message:
                  type: string
                  nullable: true
                settlement_details:
                  type: object
                  nullable: true
                  properties:
                    settlement_id:
                      type: string
                    settlement_completed_at:
                      type: string
                      format: date-time
                    utr_number:
                      type: string
                    merchant_net_amount:
                      type: string
                    settlement_currency:
                      type: string
    v1_Address:
      type: object
      required:
        - line_1
        - city
        - state
        - postal_code
      properties:
        line_1:
          type: string
          description: Address line 1
        line_2:
          type: string
          description: Address line 2
        city:
          type: string
          description: City name
        state:
          type: string
          description: State name
        postal_code:
          type: string
          description: Postal/ZIP code
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: >-
        **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-displayName: Client ID
      x-example: your-client-id
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: >-
        **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-displayName: Client Secret
      x-example: your-client-secret
    apiVersionHeader:
      type: apiKey
      name: X-API-Version
      in: header
      description: >-
        **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.
      x-displayName: API Version
      x-example: 3.0.0

````