POS Transactions

POS Transactions are card-present payments initiated on a semi-integrated card terminal.

Each transaction record tracks its type, amount, and a status that reflects the terminal's progress. Transaction type is set with a transactionTypeId, covering Authorization, Sale, Capture, Void, Refund, and more. Status moves through terminal states such as TerminalConnecting, TransactionProcessing, and Completed.

The POS Transactions endpoints support listing, creating, retrieving, canceling, and printing a receipt. A transaction can only be canceled while it has not yet begun processing on the terminal. Retrieving a transaction can optionally wait for it to reach a completed status before responding. A separate endpoint reprints a completed transaction's receipt directly from the terminal.

GET /pos-api/v1/pos-transactions. Lists POS transactions for the merchant.
POST /pos-api/v1/pos-transactions. Creates a new POS transaction on the terminal.
GET /pos-api/v1/pos-transactions/{posTransactionsid}. Retrieves a single POS transaction by its identifier.
POST /pos-api/v1/pos-transactions/{posTransactionsid}/cancel. Cancels a POS transaction before the terminal begins processing it.
POST /pos-api/v1/pos-transactions/{posTransactionId}/print. Reprints a completed transaction receipt on the terminal.

Operations

Lists POS transactions

Request

GET {{baseURL}}/pos-api/v1/pos-transactions

This endpoint lists POS transactions.

See Also:
To create a POS transaction, see POST /pos-api/v1/pos-transactions.
To retrieve a POS transaction by ID, see GET /pos-api/v1/pos-transactions/{id}.
To cancel a POS transaction, see POST /pos-api/v1/pos-transactions/{id}/cancel.
To print a POS transaction receipt, see POST /pos-api/v1/pos-transactions/{posTransactionId}/print.

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.

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.

The sort field is specified by the orderBy value.

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

Example: false

Default:false

terminalIdstring, (uuid)

Specifies the terminal identifier.

Example: 2428b5e7-6386-42ad-8b1c-d2a9032da4b3

Example:terminalId=2428b5e7-6386-42ad-8b1c-d2a9032da4b3

curl -i -X GET \
  'https://developer.flute.com/_mock/api-reference/pos-api/v1/pos-transactions?page=0&pageSize=15&orderBy=string&asc=false&terminalId=2428b5e7-6386-42ad-8b1c-d2a9032da4b3' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

itemsArray of objects or null

POS (point of service) transactions for the current page.

totalinteger, (int32)

Indicates the total number of POS (point of service) transactions found.

Example: 124

Example:124

Response

{
  "items": [
    {
      "id": "8b6c7c7e-6c62-4e7a-9e0c-3d3c1c4d9f9d",
      "createdOn": "2025-12-15T10:35:52.5407322Z",
      "terminalId": "c2a1a3c2-2d9e-4c0e-b0f4-6a7b5f1e2d11",
      "posTransactionStatusId": 6,
      "posTransactionStatus": "Completed",
      "transactionId": "1f7e3d2a-9c4b-4c7d-8b7e-2a3c4d5e6f70",
      "amount": 10,
      "currencyId": 1,
      "targetTransactionId": null,
      "transactionTypeId": 2,
      "transactionType": "Sale",
      "isCompleted": true
    }
  ],
  "total": 100
}