Pagination & filtering

Paging

Supported by every list endpoint.

List responses put results in data.items and paging details in data.meta:

{
  "items": [
    "…"
  ],
  "meta": {
    "totalItems": 42,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalPages": 5,
    "currentPage": 1
  }
}

Sorting

Conversions and payouts only. Pass sort as a JSON object with one field and a direction (ASC or DESC), URL-encoded. Results are newest first by default.

# sort={"amount":"DESC"}
/api/payouts?sort=%7B%22amount%22%3A%22DESC%22%7D

Remember to sign the path exactly as sent, encoded characters included.

Date ranges

Conversions and payouts only. Send startDate and endDate together (e.g. 2026-09-01) to limit results to records created in that range. Both days are included in full.

Filters

Filter by passing a supported field as a query parameter, e.g. /api/conversions?status=completed&fromCurrency=ngn. Only send the filters listed for each endpoint:

• List quotes — paging only; no sorting, date ranges or filters.
• List sub-wallets — paging only; no sorting, date ranges or filters.
• List payments received — paging (default limit is 20), startDate and endDate (each usable on its own), and filters virtualAccountId, minAmount, maxAmount. No sorting.
• List conversions — sorting, date ranges, and filters status, fromCurrency, toCurrency, reference.
• List payouts — sorting (createdAt, updatedAt, amount, status), date ranges, and filters status, sourceCurrency, destinationCurrency, refundStatus, isGreylisted, search, conversionId. Any other query parameter is rejected with 400 Unsupported filter field(s).