Skip to main content
GET
/
api
/
v1
/
payment-links
List payment links with context-aware access control
curl --request GET \
  --url https://core.quidkey.com/api/v1/payment-links \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 25,
    "totalPages": 6,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number (1-based)

Required range: x >= 1
Examples:

1

2

3

​
limit
integer
default:25

Number of items per page (max 100)

Required range: 1 <= x <= 100
Examples:

10

25

50

​
sort
string

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

Examples:

"created_at:desc"

"amount:asc"

"updated_at:desc"

​
status
enum<string>

Payment link status

Available options:
active,
used,
expired,
cancelled
​
merchant_id
string<uuid>

Filter by merchant ID (admin/partner only)

​
search
string

Search by payment reference or order ID

Response

Success

Paginated response with metadata

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
data
object[]
required
​
pagination
Pagination Metadata · object
required

Metadata for paginated responses