Skip to main content
GET
Poll transactions

Overview

Returns transactions in ascending processing order so an incremental consumer can follow the stream without missing anything. This is a 1:1 drop-in for Stedi’s Poll Transactions operation. Use polling when you want to mirror every transaction into your own system: keep the returned nextPageToken, wait, then call again with that token. Use List Transactions when you want to search or browse history.

Authentication

JWT Bearer token from POST /api/token, with the api-access feature.

Query parameters

string
ISO 8601 date-time for the initial poll, e.g. 2026-10-01T00:00:00Z. Only transactions processed after this time are returned. Required on the first call when you do not yet have a pageToken.
string
Cursor from the previous poll’s nextPageToken. Pass this on every poll after the first. If both pageToken and startDateTime are supplied, the token takes precedence.
integer
default:"100"
Maximum transactions per poll, 1–500. Defaults to 100.
You must supply at least one of pageToken or startDateTime; otherwise the request returns 400 BadRequestException.

Example

First poll, then continue with the returned cursor:
A polling loop:

Response

Cursor semantics

Unlike the list endpoint, polling always returns a nextPageToken, including when items is empty.
  • On a full or partial page, the token points at the last returned transaction. Call again immediately to continue.
  • On an empty page, the token re-encodes your current position rather than jumping to the present. This guarantees zero gaps: a webhook that arrives slightly out of order, or an uploaded X12 with a historical processedAt, is still delivered on a later poll.
  • Never discard the token on an empty page — that is how the stream advances.
There is a short maturity delay of a few seconds before a transaction becomes pollable, so an in-flight insert cannot be observed half-written. A transaction may therefore appear a few seconds after it is created.

Stop condition

Polling is a never-ending stream by design; decide your own cadence (for example every 30 seconds) and stop when your process exits. Reuse the same cursor across restarts so you do not miss or duplicate the boundary transaction.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize
integer
default:100

Maximum number of transactions to return in a page (1–500). Defaults to 100.

Required range: 1 <= x <= 500
pageToken
string

Cursor returned as nextPageToken by the previous poll. Pass this on every poll after the first. Mutually exclusive with startDateTime (the token wins).

startDateTime
string<date-time>

ISO 8601 date-time for the initial poll, e.g. 2026-10-01T00:00:00Z. Only transactions after this time are returned. Required on the first poll when no pageToken is available.

Response

A page of new transactions. nextPageToken is always present.

items
object[]
required
nextPageToken
string
required

Always present. Pass it back on the next poll. On an empty page it encodes your current position so no transactions are skipped.