Record-Set Pagination

Some endpoints return large data sets. Use record-set pagination to control the number of records returned at a time. Pass the number of records per page in the recordCnt parameter. The default maximum is 200 records per page. If you pass a number higher than 200 you will get 200 entries per page.

Set the MXRPG provider parameter to increase the maximum number of entries per page or set NOPGE to retrieve all records in one page, irrespective of MXRPG.

Each response includes:

  • total_record_count — Total number of records found within the search parameters
  • number_of_pages — Number of pages available
  • page — Current page being returned. To request different pages, pass the desired page number in the page parameter.

Wires-related endpoints

For the wires-related endpoints—Get Destination Accounts and Get Wire History—the pagination scheme is different. Instead of specifying which page to return, you get the first page by default, and then you call the endpoint again to get each subsequent page.

  1. Pass a value for recordCount to specify how many records per page to return. Default 100. Max 200.
  2. The first time you call the endpoint, leave nextPageToken blank.
  3. The endpoint returns the first page of records along with total_record_count.
    • If total_record_count is higher than the number of records on page 1, a next_page_token is provided.
    • If total_record_count is equal to or lower than the number of records on page 1, a next_page_token is not returned.
  4. To retrieve the next page of records, call the endpoint again and populate nextPageToken with the value received in the previous call.
  5. As needed, repeat the previous step until there are no more pages to return.