> ## 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.

# List Payment Links

> Retrieve a paginated list of payment links.

## Overview

Retrieve a paginated list of all payment links created by your account. This is useful for building a dashboard to track the status of all your shared links.

## Filtering and Pagination

You can use query parameters to paginate through your payment links:

* `page`: The page number to retrieve (default: 1).
* `page_size`: Number of items per page (default: 10).


## OpenAPI

````yaml GET /pg/payment-links/
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/:
    get:
      tags:
        - Payment Links
      summary: List Payment Links
      description: Retrieve a paginated list of payment links.
      operationId: v1_get_pg_payment-links_
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          schema:
            type: integer
            default: 10
      responses:
        '200':
          description: List of payment links retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_ListPaymentLinksResponse'
      security:
        - clientAuth: []
          clientSecretAuth: []
          apiVersionHeader: []
components:
  schemas:
    v1_ListPaymentLinksResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            count:
              type: integer
            next:
              type: string
              format: uri
              nullable: true
            previous:
              type: string
              format: uri
              nullable: true
            results:
              type: array
              items:
                type: object
                properties:
                  payment_id:
                    type: string
                  payment_link:
                    type: string
                    format: uri
                  reference_id:
                    type: string
                  status:
                    type: string
                  amount:
                    type: object
                    properties:
                      amount:
                        type: string
                      total_amount:
                        type: string
                      currency:
                        type: string
                  buyer:
                    type: object
                    properties:
                      name:
                        type: string
                      email:
                        type: string
                      phone:
                        type: string
                        nullable: true
                  created_at:
                    type: string
                    format: date-time
  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

````