Pagination

WePay API uses cursor-based pagination for all top-level resources. Cursor-based pagination is the most efficient method of pagination available, and we strongly recommend using it to retrieve large custom lists. Cursor-based pagination is also well suited for real-time data as it allows you to retrieve a small slice of a list easily. Used on our endpoints for retrieving list.

This is a sample resource with pagination response. use limit and page query params to paginate the response.

Query Params attributes

Field	Type	Description
`limit`	integer	Limit the number of payments returned.
`page`	integer	Specify the page number of the payments to retrieve.

Response

  {
      "statusCode": 200,
      "message": "Sample resource with pagination response",
      "data": {
          "docs": [
              ...
          ],
          "totalDocs": 1,
          "offset": 0,
          "limit": 10,
          "totalPages": 1,
          "page": 1,
          "pagingCounter": 1,
          "hasPrevPage": false,
          "hasNextPage": false,
          "prevPage": null,
          "nextPage": null
      }
  }