---
title: "Pay-by-link payments list"
method: GET
path: "/shop/reports/pay-by-link-payments"
tags: ["Reports"]
---

# Pay-by-link payments list

`GET /shop/reports/pay-by-link-payments`

A paginated list of pay-by-link charges issued at the given site. Useful for tracking
outstanding payment links sent to customers (`status=pending`) and reviewing recently
collected pay-by-link payments.

For the smart-filter options used to power list-page chips and saved searches, see
[`/shop/reports/pay-by-link-payments/smart-filters`](/endpoints/Reports#listPayByLinkPaymentsSmartFilters).

## Query parameters

- `site_id` string, uuid, required
- `page` integer
- `per_page` integer
- `created_from` string, date
- `created_to` string, date
- `completed_from` string, date
- `completed_to` string, date
- `revenue_date_from` string, date
- `revenue_date_to` string, date
- `status` string
- `sort` string
- `sort_order` 'asc' | 'desc'

## Response `200`

The pay-by-link payments were successfully retrieved.

- PayByLinkPaymentsResponse
  - `data` PayByLinkPayment[], required
    - `id` string, object-id, required — The charge ID.
    - `status` string, required — The current status of the pay-by-link charge.
    - `order_ref` string, required
    - `basket_id` string, object-id, required — The ID of the basket the pay-by-link payment is collecting for.
    - `customer_name` string, nullable, required
    - `revenue_date` string, nullable — The revenue date of the underlying basket, as `YYYY-MM-DD`.
    - `created_at` string, date-time, required
    - `paid_at` string, date-time, nullable — When the customer completed the payment. `null` until the charge has been collected.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `400` — The request failed.

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)