Skip to main content

Pagination

List endpoints that may return large result sets are paginated.

Request Parameters

Pagination parameters are accepted as query parameters (or request-body fields, depending on the endpoint contract):

ParameterTypeDefaultDescription
pageinteger0Zero-based page index.
sizeinteger20Page size. Maximum recommended value is 100.
sortstringvariesSorting in the format field,asc or field,desc. Endpoint specific.

Refer to each endpoint's documentation for the exact parameter location and any additional filters.

Response Envelope

Paginated endpoints return:

{
"content": [ /* page of items */ ],
"page": 0,
"size": 20,
"totalElements": 137,
"totalPages": 7
}
FieldDescription
contentThe array of items for the requested page.
pageZero-based page index returned.
sizePage size used.
totalElementsTotal number of matching items across all pages.
totalPagesTotal number of pages available given the current size.

Iterating Pages

A simple loop pattern in pseudocode:

page = 0
loop:
result = GET /transactions?page=page&size=50
process(result.content)
if page + 1 >= result.totalPages: break
page = page + 1

Recommendations

  • Use the smallest page size that meets your need. Smaller pages return faster.
  • Don't fetch every page on each polling cycle. For status polling, query by transactionId instead.
  • For exports of historical data, use the largest reasonable page size (e.g. 100) and iterate.

Last updated: April 2026