All GET based endpoints that return a list of resources support pagination. The default limit is 20 and maximum is 250. The results are in descending order by default, newest first.

Query Parameters

ParameterTypeDescription
limitintegerThe number of results to retrieve. Must be between 1 and 250 (inclusive). Default value is 20.
offsetintegerThe position to start the results at. The first result has a position of 0. Default value is 0.

Response

ParameterTypeDescription
limitintegerThe number of results that this page was limited to.
offsetintegerThe position of the first result retrieved for this page.
totalResultsintegerThe total number of results matching the given criteria. If this number is greater than limit, one or more results were excluded from this page.
resultsarrayA page of matching results. This may be a subset of the total.

Example Request

curl https://api.sandbox.clearpay.com/v2/payments \
  -H 'Authorization: Basic <Base64EncodedString>' \
  -H 'User-Agent: <MyUserAgent>' \
  -H 'Accept: application/json'

Example Response

{
  "totalResults": 213,
  "offset": 0,
  "limit": 20,
  "results": [
    ...
  ]
}