Pagination

Use limit and offset to page through list endpoints.

Most Safepay list endpoints use limit and offset query parameters. Many responses include a count field and an array of resources inside data.

Settlement operations list endpoints use cursor pagination instead (cursor, limit, direction, and next_cursor).

Query parameters

Parameter	Description	Example
limit	Max records to return in a page.	limit=10
offset	Number of records to skip before returning results.	offset=0

Parameter types vary between endpoints (string or integer). Follow the OpenAPI schema for each endpoint. For settlement operations, use cursor / next_cursor rather than offset.

Example: list payments

cURL

curl --request GET "{{base_url}}/v1/aggregators/{{aggregator_id}}/payments?limit=10&offset=0" \
  --header "X-SFPY-AGGREGATOR-SECRET-KEY: {{secret_key}}"

Response shape

List responses return a data object containing count and a list for the resource type. Examples include payments, keys, refunds, and qrs.

{
  "api_version": "v1",
  "data": {
    "count": "605",
    "payments": []
  }
}

See also

• Errors
• Payments
• Refunds
• Settlement operations
• API reference