Skip to main content
GET
/
pg
/
payment-links
List Payment Links
curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/payment-links/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "count": 123,
    "next": "<string>",
    "previous": "<string>",
    "results": [
      {
        "payment_id": "<string>",
        "payment_link": "<string>",
        "reference_id": "<string>",
        "status": "<string>",
        "amount": {
          "amount": "<string>",
          "total_amount": "<string>",
          "currency": "<string>"
        },
        "buyer": {
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

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

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.

Query Parameters

​
page
integer
default:1
​
page_size
integer
default:10

Response

200 - application/json

List of payment links retrieved successfully

​
success
boolean
​
message
string
​
data
object