kepa
Reconciliation/listSettlements

List Settlements

Historical settlement batches, cursor-paginated.

GET/v1/settlements
Return historical settlement batches, ordered newest first. Cursor-paginated via the cursor query parameter. Use this to power reconciliation dashboards, accounting exports, or to find the batch a specific transaction landed in. Each settlement corresponds to one successful call to /v1/reconciliation with closeDay=true.
Query parameters
cursorstring

Opaque pagination cursor returned by a previous call. Omit on the first page.

Example "cursor_stl_01JQDAY00042"
limitinteger

Page size, 1–100. Defaults to 25.

Example 25
fromstring · ISO 8601

Include settlements closed on or after this timestamp (ISO 8601).

Example "2026-04-01T00:00:00Z"
tostring · ISO 8601

Include settlements closed before this timestamp (ISO 8601).

Example "2026-05-01T00:00:00Z"
currencystring

Filter by ISO 4217 currency code.

Example "NZD"

Response

application/json

dataarrayRequired

Array of Settlement objects, newest first.

hasMorebooleanRequired

Whether more pages exist. If true, pass nextCursor to the next call.

Example true
nextCursorstringnullable

Cursor for the next page. Null when hasMore is false.

Example "cursor_stl_01JQDAY00017"

listSettlements

GETGo API
https://api.kepapay.co/v1/settlements
Request
curl https://api.kepapay.co/v1/settlements?limit=25 \
  -H "X-Api-Key: $KEPA_SECRET_KEY"
Response
{
  "data": [
    {
      "id": "stl_01JQDAY00042",
      "closedAt": "2026-04-08T23:00:00Z",
      "status": "SETTLED",
      "currency": "NZD",
      "saleCount": 47,
      "saleAmount": 328750,
      "refundCount": 2,
      "refundAmount": 5000,
      "voidCount": 1,
      "voidAmount": 1200,
      "netAmount": 322550,
      "merchantId": "MID123456789",
      "terminalId": "TID-00012345"
    }
  ],
  "hasMore": true,
  "nextCursor": "cursor_stl_01JQDAY00017"
}