Pagination & Filtering

How to paginate and filter list endpoints.

List endpoints (e.g., transactions, deposits, settlements) support pagination and date-range filtering via query parameters.

Pagination parameters

Parameter	Type	Default	Maximum	Description
page	number	1	—	Page number (1-indexed)
limit	number	10	100	Number of items per page (values above 100 are clamped to 100)

Example

curl -X GET "https://ramp-api.ivorypay.io/api/v1/transactions?page=2&limit=10" \
  -H "Authorization: your_api_key"

Date filtering

Filter results by date range using ISO 8601 datetime strings:

Parameter	Type	Description
startPeriodDatetime	string	Start of date range (ISO 8601)
endPeriodDatetime	string	End of date range (ISO 8601)

Example

curl -X GET "https://ramp-api.ivorypay.io/api/v1/transactions?startPeriodDatetime=2026-01-01T00:00:00Z&endPeriodDatetime=2026-01-31T23:59:59Z" \
  -H "Authorization: your_api_key"

Endpoint-specific filters

Refer to each API reference page for filters that a specific list endpoint supports beyond page, limit, startPeriodDatetime, and endPeriodDatetime.

Response shape

Pagination is currently request-side only. The success envelope's optional meta field is reserved but is not populated for paginated endpoints today — list endpoints return their items as a plain array under data:

{
  "success": true,
  "message": "Query successful",
  "data": [
    { "id": "...", "...": "..." },
    { "id": "...", "...": "..." }
  ]
}

To detect the end of a list, request the next page until you receive fewer than limit items (or an empty array).