---
title: "List Payment Links"
method: GET
path: "/v1/payment_links"
tags: ["Payment Links"]
---

# List Payment Links

`GET /v1/payment_links`

Returns payment links. Supports filtering by reference number, status, and mode.

## Query parameters

- `reference_number` string
- `status` 'active' | 'archived'
- `mode` 'live' | 'test'

## Headers

- `Authorization` string, required

## Response `200`

Payment links retrieved successfully.

- object
  - `data` object[]
    - `id` string, required — The unique identifier of the payment link.
    - `amount` integer, required — Amount in the smallest currency unit.
    - `currency` string, required — Three-letter ISO currency code.
    - `description` string — Description of the payment link.
    - `livemode` boolean, required — Indicates whether the payment link is live.
    - `remarks` string — Remarks attached to the payment link.
    - `status` string, required — Status of the payment link.
    - `url` string, required — Checkout URL of the payment link.
    - `reference_number` string, required — Reference number associated with the payment link.
    - `metadata` object, required — Additional metadata.
    - `restrictions` object
      - `completed_sessions` object
        - `count` integer — Number of completed sessions.
        - `limit` integer — Maximum allowed completed sessions.
    - `created_at` string, date-time, required — Creation timestamp in ISO 8601 format.
    - `updated_at` string, date-time, required — Last update timestamp in ISO 8601 format.

## Other responses

- `401` — Unauthorized.
- `500` — Internal server error.

---

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