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

# List payment links

`GET /v1/payment_links/`

List payment links

**Required scope: `business/orders:read`**

## Query parameters

- `created_at__gte` string, date-time, nullable — The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `created_at__lte` string, date-time, nullable — The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `updated_at__gte` string, date-time, nullable — The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `updated_at__lte` string, date-time, nullable — The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `cursor` string, nullable — A pagination cursor from where results should start being fetched.
- `limit` integer — The maximum number of results to return.
- `status` PaymentLinkStatus[], nullable — A list of statuses to filter on.

## Response `200`

Successful Response

- PaginatedResponsePaymentLink
  - `data` PaymentLink[], required — A list of paginated entities.
    - `id` string, required — The unique identifier of the payment link.
    - `url` string, required — The payment link.
    - `customer_reference` string, required — The customer's name or reference that will appear on the payment page.
    - `customer_description` string, nullable, required — An optional description that will appear on the payment page.
    - `status` 'cancelled' | 'paid' | 'pending', required — A payment link transitions through various states throughout its lifecycle. A payment link is always created in a `pending` state. From there, it will move to a terminal state which will be one of either `paid` or `cancelled`. The following transitions are possible: - pending -> paid - pending -> cancelled
    - `order_id` string, required — A reference to the original order.
    - `created_at` string, date-time, required — The payment link creation date and time in ISO 8601 format.
    - `updated_at` string, date-time, nullable, required — The date and time the payment link was last modified in ISO 8601 format.
  - `next_cursor` string, nullable, required — A pagination cursor that can be used to retrieve the next set of results.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

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