Skip to content
/
Lists POS transactions

Lists POS transactions

Request

GET {{baseURL}}/v2/pos/transactions

This endpoint lists POS transactions.

Each item in the response contains a reduced transaction object. Fields are limited to the most relevant transaction information. This is often sufficient for rendering transaction lists, dashboards, and reconciliation views. Situations requiring full detail context, such as for decline details, AVS response, or transaction events, are available with GET /v2/pos/transactions/{{posTransactionId}}.

See Also:
To retrieve a POS transaction by ID, see GET /v2/pos/transactions/{posTransactionId}.
To create a new POS transaction, see POST /v2/pos/transactions.
To cancel a POS transaction, see POST /v2/pos/transactions/{posTransactionId}/cancel.

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.

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.

For page numbering information, see pageIndex.

Example: 50

Default:20
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:

ValueDescription
ascSort results from the lowest value to the highest value.
descSort results from the highest value to the lowest value.
Default:"asc"
Example:sortOrder=desc
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
terminalIdstring, (uuid)

Specifies to filter by terminal identifier.

Example:terminalId=57dbdbc6-fef4-44b8-816a-4372c063f1ec
fromDatestring, (date-time)

Specifies returning items on or after this date (in an ISO 8601 date-time format) to filter by,.

If only fromDate is specified, the search returns all available items from the fromDate value to the present. The fields fromDate and toDate may be used together to create an exclusive range. We recommend creating an exclusive range to avoid a potentially excessive number of returns.

Example:fromDate=2025-01-27T12:05:54.322Z
toDatestring, (date-time)

Specifies returning items on or to this date (in an ISO 8601 date-time format) to filter by,.

If only toDate is specified, the search returns all available items up to the toDate value. The fields fromDate and toDate may be used together to create an exclusive range. We recommend creating an explicit range to avoid a potentially excessive number of returns.

Example:toDate=2026-02-27T12:05:54.322Z
posTransactionStatusstring

Specifies the POS transaction status to filter by,

Valid values are:

ValueDescription
CancelledThe POS transaction was canceled before it completed.
CompletedThe POS transaction finished processing successfully.
FailedThe POS transaction did not complete because of an error.
InProgressThe POS transaction is still being processed.
Enum:"InProgress""Completed""Cancelled""Failed"
Example:posTransactionStatus=Completed
curl -i -X GET \
  'https://sandbox.api.flute.com/v2/pos/transactions?pageIndex=0&pageSize=20&sortOrder=desc&sortBy=ContactName&terminalId=57dbdbc6-fef4-44b8-816a-4372c063f1ec&fromDate=2025-01-27T12%3A05%3A54.322Z&toDate=2026-02-27T12%3A05%3A54.322Z&posTransactionStatus=Completed' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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": [
    {
      "posTransactionId": "cdf3b72b-6bb5-4707-8963-1f73456323d8",
      "createdOn": "2026-06-03T21:54:31.884Z",
      "terminalId": "bcd3a843-9f21-4a71-a019-e1b336b65496",
      "posTransactionStatus": "Completed",
      "transactionId": "1782bc6c-efb0-416d-8e62-627401707177",
      "processedAmount": 135.5,
      "currencyCode": "USD"
    },
    {
      "posTransactionId": "18090b35-0758-4a5b-81ae-927d4496cd53",
      "createdOn": "2026-06-03T21:59:31.884Z",
      "terminalId": "bff9c356-fb17-4ed8-89ad-d980c92e391e",
      "posTransactionStatus": "InProgress",
      "transactionId": null,
      "processedAmount": 135.5,
      "currencyCode": "USD"
    }
  ],
  "pageInfo": {
    "pageIndex": 0,
    "pageSize": 20,
    "totalItems": 150,
    "totalPages": 8,
    "hasMore": true
  }
}