Reports

Pay-by-link payments list

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.

get/shop/reports/pay-by-link-payments

Query parameters

site_idstring uuid required

Restrict to pay-by-link payments at the given site.

pageinteger

The page to retrieve results from

per_pageinteger

The number of payments to return per page. Defaults to 30.

created_fromstring date

Restrict to pay-by-link charges created on or after this date.

created_tostring date

Restrict to pay-by-link charges created on or before this date.

completed_fromstring date

Restrict to pay-by-link charges completed on or after this date.

completed_tostring date

Restrict to pay-by-link charges completed on or before this date.

revenue_date_fromstring date

Restrict to pay-by-link charges whose underlying basket has a revenue date on or after this date.

revenue_date_tostring date

Restrict to pay-by-link charges whose underlying basket has a revenue date on or before this date.

statusstring

Example:complete

Filter to pay-by-link charges with a specific status. Defaults to all.

sortstring

Example:created_at

Field to sort the list by.

sort_order'asc' | 'desc'

Sort direction. asc returns oldest-first, desc returns newest-first. Combine with sort to control which column is sorted. Defaults to asc.

Response

The pay-by-link payments were successfully retrieved.

Example response

{
  "data": [
    {
      "status": "pending",
      "order_ref": "TRY03",
      "customer_name": "Jane Doe"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.