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	Description
page	number	1	Page number (1-indexed)
limit	number	20	Number of items per page

Example

curl -X GET "https://ramp-api.ivorypay.io/api/v1/transactions?page=2&limit=10" \
  -H "x-api-key: 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 "x-api-key: your_api_key"

Endpoint-specific filters

Some list endpoints support additional filters:

Deposits

Parameter	Type	Description
status	string	Filter by transaction status
currency	string	Filter by fiat currency (e.g., NGN)
accountNumber	string	Filter by virtual account number

Example

curl -X GET "https://ramp-api.ivorypay.io/api/v1/deposits?status=SUCCESS&currency=NGN&page=1&limit=25" \
  -H "x-api-key: your_api_key"

Response with pagination metadata

Paginated responses include a meta object:

{
  "statusCode": 200,
  "success": true,
  "message": "Query successful",
  "data": [ ... ],
  "meta": {
    "total": 142,
    "page": 2,
    "limit": 10,
    "totalPages": 15
  }
}

Field	Type	Description
total	number	Total number of matching records
page	number	Current page number
limit	number	Items per page
totalPages	number	Total number of pages