Lists payment links

Request

GET {{baseURL}}/v2/payment-links

This endpoint lists payment links for the authenticated merchant.

It returns a paginated set of payment links.

See Also:
To create a new payment link, see POST /v2/payment-links.
To retrieve a payment link by identifier, see GET /v2/payment-links/{{paymentLinkId}}.
To update a payment link, see PATCH /v2/payment-links/{{paymentLinkId}}.
To delete a payment link, see DELETE /v2/payment-links/{{paymentLinkId}}.
To share a payment link, see POST /v2/payment-links/{{paymentLinkId}}/share.

Security

Bearer

Query

pageIndexinteger, (int32), >= 0

Specifies the page number of the returned search results.

A page is considered each set of the pageSize values.

The page count is zero-based. The maximum for pageIndex, or the page number, is the pageSize divided by the total count rounded down. For example, the pageSize is 50 and the total is 130. That means there are three pages, but the pageIndex value is in the inclusive range from zero to two.

Value restrictions include:

A value less than zero is not permitted.
Values equal to or greater than totalPages end successfully but will not return any items.

For page size information, see pageSize.

Example: 0

Default:0

pageSizeinteger, (int32), [ 1 .. 100 ]

Specifies the number of items for each page of the returned search results.

A page is considered each set of the pageSize values.

For page numbering information, see pageIndex.

Example: 50

Default:20

searchstring

Filters using a search string.

This performs a case-insensitive search that matches exactly or partially.

The field does not have to be specified. If the results are to be sorted, use the sortBy field to specify the sort field.

The search includes the following fields:
name
description
paymentLinkId

Example:
Peppared Street Cafe
Street
ree

Example:search=Peppared Street Cafe

linkTypestring

Specifies the link type to filter by.

Valid values are:

Type	Description
MultiUse	The link can be shared with, and paid by, more than one customer.
SingleUse	The link is intended for a single customer and a single payment.

Enum:"MultiUse""SingleUse"

Example:linkType=SingleUse

paymentLinkStatusstring

Specifies the effective status to filter by.

Valid values are:

Status	Description
Active	The link is open and can accept a payment.
Completed	A SingleUse link that has received its one payment.
Expired	The link's `expiresOn` date has passed.
Inactive	The link was deactivated and cannot accept a payment.

Enum:"Active""Completed""Expired""Inactive"

Example:paymentLinkStatus=Active

sortBystring

Specifies the field the results get ordered or sorted by.

The sort order is specified by the sortOrder value.
The field that gets sorted by is specified by the sortBy value.

Example:sortBy=ContactName

sortOrderstring

Specifies the sort order.

The sort order is specified by the sortOrder value.
The field that gets sorted by is specified by the sortBy value.

Valid values are:

Value	Description
asc	Sort results from the lowest value to the highest value.
desc	Sort results from the highest value to the lowest value.

Default:"asc"

Example:sortOrder=desc

curl -i -X GET \
  'https://sandbox.api.flute.com/v2/payment-links?pageIndex=0&pageSize=20&search=Peppared%20Street%20Cafe&linkType=SingleUse&paymentLinkStatus=Active&sortBy=ContactName&sortOrder=desc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

itemsArray of objects or null

pageInfoobject

Indicates an object describing the pagination status.

If additional pages to review are needed, repeat the exact same search but include a new pageIndex value. Typically, this will increment the current pageIndex by one. However, any valid value may be used. Value restrictions include:

A value less than zero is not permitted.
Values equal to or greater than totalPages end successfully but will not return any items.

Response

{
  "items": [
    {
      "paymentLinkId": "6f2a8b3c-9d4e-4f1a-8b7c-3e5d6a9f0c1b",
      "linkType": "SingleUse",
      "paymentMethods": {
        "card": {
          "enabled": true,
          "processorId": "d529945e-8d10-4cb4-9dc3-718e57f3f14e"
        }
      },
      "baseAmount": 25,
      "currencyCode": "USD",
      "paymentLinkStatus": "Active",
      "name": "Spring campaign",
      "description": null,
      "shortUrl": "https://pay.example.com/l/abc123",
      "customerId": "3c4d5e6f-7a8b-49c0-8d1e-2f3a4b5c6d7e",
      "customerFirstName": "Alexandro",
      "customerLastName": "Peppared",
      "referenceId": "ORDER-1042",
      "expiresOn": "2026-09-15T00:00:00.000Z",
      "paymentCount": 0,
      "totalCollectedAmount": 0,
      "lastPaymentOn": null,
      "createdOn": "2026-08-12T09:15:22.100Z",
      "modifiedOn": "2026-08-12T09:15:22.100Z"
    }
  ],
  "pageInfo": {
    "pageIndex": 0,
    "pageSize": 20,
    "totalItems": 150,
    "totalPages": 8,
    "hasMore": true
  }
}