v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Payment Links

List payment links with context-aware access control

List payment links with context-aware access control

get/api/v1/payment-links

Query parameters

pageinteger

Page number (1-based)

Example:1

Page number (1-based)

limitinteger

Number of items per page (max 100)

Example:10

Number of items per page (max 100)

sortstring

Sort field and direction (e.g., "created_at:desc", "amount:asc")

Example:created_at:desc

Sort field and direction (e.g., "created_at:desc", "amount:asc")

status'active' | 'used' | 'expired' | 'cancelled'

Payment link status

Payment link status

merchant_idstring uuid

Filter by merchant ID (admin/partner only)

Filter by merchant ID (admin/partner only)

searchstring

Search by payment reference or order ID

Search by payment reference or order ID

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 25,
    "totalPages": 6,
    "hasNextPage": true
  }
}