Skip to content
/
Lists one-time links

Lists one-time links

Request

GET {{baseURL}}/pay-int-api/quick-payments/one-time

This endpoint lists one-time payment links.

The links may be valid or expired.

The request may be filtered to limit returns to the specified search.

See Also:
To create a one-time payment link, see POST /pay-int-api/quick-payments/one-time.
To retrieve details of a one-time payment link, see GET /pay-int-api/quick-payments/one-time/{quickPaymentId}.
To activate a payment link, see POST /pay-int-api/quick-payments/{quickPaymentId}/activate.
To deactivate a payment link, see POST /pay-int-api/quick-payments/{quickPaymentId}/deactivate.

Security
Bearer
Query
pageinteger, (int32)

Specifies the page number of the returned search results.

A page is considered each set of the pageSize value.

The maximum page value is the pageSize divided by the total count rounded up. The count is zero-based. For example, if pageSize is 50 and the total is 130, there are three pages. The maximum page value is 2.

Values above the maximum page value will complete successfully but not return any items.

Example: 0

Default:0
pageSizeinteger, (int32)

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

A page is considered each set of the pageSize value.

The maximum page value is the pageSize divided by the total count rounded up. The count is zero-based. For example, if pageSize is 50 and the total is 130, there are three pages. The maximum page value is 2.

Example: 50

Default:15
orderBystring

Specifies the field the results get ordered by.

The sort order is specified by the asc value.

Example: contactName

ascboolean

Specifies the sort order is ascending.

The sort field is specified by the orderBy value.

If true, the sort order is ascending.
If false, the sort order is descending.

Example: true

Default:true
searchstring

Specifies the search string.

This performs a case insensitive, matching, or partially matching search.

Fields does not have to be specified. If the results are to be sorted, the field orderby to specify the sort field.e

Example:search=Peppared
Headers
x-api-versionstring

Specifies the API version to use for the request.

Example: 1.0

Example:1.0
curl -i -X GET \
  'https://developer.flute.com/_mock/api-reference/pay-int-api/quick-payments/one-time?page=0&pageSize=15&orderBy=string&asc=true&search=Peppared' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-version: 1.0'

Responses

OK

Bodyapplication/json
itemsArray of objects or null

One-time quick payments for the current page.

totalinteger, (int32)

Indicates the total number of one-time quick payments found.

Example: 17

Example:17
Response
{
  "items": [
    {
      "id": "c8c67f32-aca5-47c4-b10e-123086a43075",
      "customerName": "Jane Doe",
      "amount": 45.99,
      "status": 0,
      "createdOn": "2026-02-19T20:24:52.934Z",
      "expirationTime": "2026-02-19T20:24:52.934Z",
      "transactionId": "0e0034bd-028f-4809-b185-f4cca086eb33"
    }
  ],
  "total": 17
}