Developers

Search for documents

Dev

Pagination

List endpoints return results in pages. The Valpay API uses two pagination styles depending on the resource.

Offset pagination (default)

Most list endpoints — Users, Disputes, Brands, Permissions, Industry Codes, Terminals, and others — use offset pagination with two query parameters.

Parameter

Type

Required

Description

limit

integer

Yes

Maximum number of records to return. Ranges from 1 to 1000.

page

integer

Yes

Page number to retrieve, starting from 0.

curl "https://api.valpay.com/v1/disputes?limit=50&page=0" \
  -H "Authorization: Bearer YOUR_TOKEN"
curl "https://api.valpay.com/v1/disputes?limit=50&page=0" \
  -H "Authorization: Bearer YOUR_TOKEN"
curl "https://api.valpay.com/v1/disputes?limit=50&page=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

To page through results, increment page while keeping limit constant (page=0, then page=1, and so on).

Cursor pagination (Jobs)

The Jobs list endpoint (GET /v1/jobs) uses cursor-based pagination instead.

Parameter

Type

Required

Description

limit

integer

Yes

Number of items to return (1–100).

lastEvaluatedKey

string

No

Cursor for the next page. Pass the exact base64 token returned by the previous response.

Omit lastEvaluatedKey on the first request. Each response includes the cursor to use for the following page; when no cursor is returned, you have reached the end.