Pagination

Control how many records are returned and navigate through large datasets efficiently.

Pagination allows you to control the number of records returned in a single API response and navigate through large datasets efficiently.

Banking APIs support multiple pagination controls when retrieving entity data.


Supported Pagination Parameters

ParameterTypeDescription
pageSizeIntegerNumber of records returned per page. Default is 1000. Maximum allowed value is 1000.
pageNumberIntegerPage number of the result set to retrieve. Default value is 1.
limitIntegerMaximum number of records returned in a response. Default is 100. Maximum allowed value is 100.
offsetStringIdentifier of the last record returned in the previous response. Used as the starting point for the next query.

Pagination Behavior

The pagination parameters follow specific precedence rules:

  • pageSize and pageNumber take precedence over other pagination parameters if provided.
  • limit acts as the only governing parameter if passed without pageSize or pageNumber.
  • If no pagination parameters are provided, the API automatically applies:
    • pageSize = 1000
    • pageNumber = 1

.readme-logo { display: none !important; }