Pagination

Our API uses cursor-based pagination to help you handle responses that contain large datasets. We provide pagination for GET requests that return a large number of results.

How it works

In your request, use query parameters to indicate which results you want us to return and how many results you want to view on each page. If your request is successful, we return a response that includes an array of results and HATEOAS links that you can use to navigate the pages.

Requests

To indicate how you want us to return your results, use the following query parameters:

Example request

https://api.payroc.com/v1/merchants/12345/terminals?before=8016650058&after=6516973868&limit=25

Responses

In the response, we provide information about the pages and HATEOAS links that you can use to navigate to the previous page or to the next page. We return the following fields:
We return details of your results in a data array.

Example response

{
"limit" : "10",
"count" : "100",
"has_more": true,
"links": [
{
"rel": "next",
"method": "GET",
"href": "<Uri>"
},
{
"rel": "previous",
"method": "GET",
"href": "<Uri>"
}
]
"data" : [array of objects]
}