Pagination allows you to control the number of records returned in a single API response and navigate through large datasets. Our API supports two distinct pagination methods depending on the endpoint type.

Offset-based Pagination

This method is used primarily in core API endpoints, such as /v1/payments, /v1/customers, and other primary resources. It uses a combination of limit and offset to retrieve "pages" of data.

Parameter	Type	Description
`limit`	Int32	Number of records to return in the response. Optional.
`offset`	Int32	The starting index of the records to return. Used to skip previous records. Optional.

Example

GET /v1/payments?limit=100&offset=200

Returns 100 payment records, starting from the 201st record.

From/size-based Pagination

Used in reporting endpoints, such as /report/v1/tsys/batch or /report/v1/fd/batch.

Parameter	Type	Description
`size`	Int32	Number of records to return.
`from`	Int32	Record index to start from (acts as an offset).

Example

GET /report/v1/tsys/batch?size=100&from=200

Returns 100 records, starting from the 201st record.

Notes

Offset-based pagination (limit and offset) is used on core GET endpoints.
From/size pagination (size and from) is used on reporting GET endpoints.
Default and maximum values for limit or size may vary depending on the endpoint.

Additional Query Parameters

Many list and reporting endpoints support common query parameters for filtering, sorting, and date-based queries.

Parameter	Type	Default	Description
`ascending`	boolean	false	Sorts results in ascending (`true`) or descending (`false`) order.
`filter`	string	—	General search term (for example: name, email, city). Depends on the endpoint.
`sort`	string	—	Sorts the results by a specified field.
`sortField`	string	—	Field used for sorting results.
`groupBy`	string	—	Groups results by the specified field.
`lastActivity`	string	—	Filters by recent activity (for example: `Last30`).
`startDate`, `endDate`	string (ISO 8601)	—	Filters records within a specific time window.
`dateRange`	string	—	Date range filter. Values include: `Lifetime`, `Today`, `Yesterday`, `Week`, `Month`, `Last7`, `Last30`, `Custom`.

Date Range (DR) Parameters

Used in acquiring account report endpoints.

Parameter	Type	Description
`dr_type`	string	Type of date range: `q` (quick), `rel` (relative), `abs` (absolute).
`dr_from`	string (ISO 8601)	Lower bound of absolute date range.
`dr_to`	string (ISO 8601)	Upper bound of absolute date range.
`dr_quick`	string	Predefined quick date range. Examples: `today`, `yesterday`, `thisWeek`, `last_24_h`, `monthToDate`, `yearToDate`.