---
title: "List payment links with context-aware access control"
method: GET
path: "/api/v1/payment-links"
tags: ["Payment Links"]
---

# List payment links with context-aware access control

`GET /api/v1/payment-links`

List payment links with context-aware access control

## Query parameters

- `page` integer — Page number (1-based)
- `limit` integer — Number of items per page (max 100)
- `sort` string — Sort field and direction (e.g., "created_at:desc", "amount:asc")
- `status` 'active' | 'used' | 'expired' | 'cancelled' — Payment link status
- `merchant_id` string, uuid — Filter by merchant ID (admin/partner only)
- `search` string — Search by payment reference or order ID

## Response `200`

Success

- PaymentLinkListResponse — Paginated response with metadata
  - `success` boolean, required — Indicates if the request was successful
  - `data` object[], required
    - `id` string, uuid, required
    - `merchant` object, required
      - `id` string, uuid, required
      - `brand_name` string, required
    - `amount` string, required — Amount in decimal format (e.g. "10.00")
    - `currency` string, required — Currency code (ISO 4217)
    - `payment_reference` string, required
    - `order_id` string, nullable, required
    - `status` 'active' | 'used' | 'expired' | 'cancelled', required — Payment link status
    - `link_type` 'single_use' | 'reusable', required
    - `views_count` integer, required
    - `first_viewed_at` string, date-time, nullable, required
    - `expires_at` string, date-time, required
    - `created_at` string, date-time, required
    - `transaction_id` string, uuid, nullable, required
  - `pagination` object, required — Metadata for paginated responses
    - `total` integer, required — Total number of items
    - `page` integer, required — Current page number
    - `limit` integer, required — Number of items per page
    - `totalPages` integer, required — Total number of pages
    - `hasNextPage` boolean, required — Whether there is a next page
    - `hasPreviousPage` boolean, required — Whether there is a previous page

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/banqzinc/apis/quidkey-api.md) · [All operations](https://skmtc.net/banqzinc/apis/quidkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/banqzinc/quidkey-api/revisions/f86d2bdbcb08/schema)