Developers

Search for documents

Dev

Pagination

List endpoints return results in pages using offset pagination with two query parameters.

Parameters

All list endpoints — Transactions, Deposits, Disputes, Stores, Merchants, Statements, Terminals, and others — take the same two 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.

Example

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

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

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

Responses include the page of results in data alongside the full total, the current page, and the limit used:

{
  "data": [ ... ],
  "total": 120,
  "page": 0,
  "limit": 50
}

{
  "data": [ ... ],
  "total": 120,
  "page": 0,
  "limit": 50
}

{
  "data": [ ... ],
  "total": 120,
  "page": 0,
  "limit": 50
}

Paging through results

To page through results, increment page while keeping limit constant (page=0, then page=1, and so on). An out-of-range page returns an empty data array but still surfaces the full total.

Try it out

POST

Guides

Getting Started

Authentication

Pagination

Filtering, Sorting & Fields

api