KashierDevelopersKashier Developers
API reference and playgroundSettlement reporting

List settlement windows

curl -X GET "https://test-api.kashier.io/v3/payment/settlement/windows"
{  "message": "success",  "data": [    {      "windowId": "STW-XXXXXXXX",      "accountId": "ACC-XXXX-XXX-01",      "merchantId": "YOUR_MID",      "windowDate": "2025-07-21 00:00",      "status": "closed",      "totalOriginalAmount": 5000,      "totalSettlementAmount": 4850.5,      "transactionsCount": 12,      "batchesCount": 2,      "batchesIds": "BATCH-XXXX-1,BATCH-XXXX-2,"    }  ],  "pagination": {    "total": 1,    "limit": 20,    "page": 1,    "pages": 1  }}

Lists your settlement windows, newest first. A window groups the transactions that became ready for settlement on a given date; when it closes it produces one or more batches, and each batch is what actually reaches your bank.

A window's status is one of:

  • open — still accumulating transactions; nothing has been paid out yet.
  • in_progress — the window is being closed and its batches produced.
  • closed — finalised; the transactions in it have been paid out.
  • failed — closing the window failed.

Add action=export to download the same list as a spreadsheet instead of JSON.

Settlement windows exist in live mode only. Test mode never produces windows or batches, so this read returns an empty list against the test host.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Query Parameters

page?integer

Page number. Defaults to 1.

limit?integer

Number of records per page. Defaults to 20.

sortBy?string

Field to sort by. Defaults to createdAt.

sortType?integer

Sorting direction: 1 = ascending, -1 = descending. Defaults to -1.

Value in

  • 1
  • -1
status?string

Filter by window status. all applies no status filter, and is the default.

Value in

  • "all"
  • "open"
  • "in_progress"
  • "closed"
  • "failed"
q?string

Search term. A value starting with TX- is treated as a settlement transaction id and resolves to the window containing that transaction.

dateFrom?string

Only return windows on or after this date.

action?"export"

Set to export to download the windows list as a spreadsheet instead of JSON.

Value in

  • "export"

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v3/payment/settlement/windows

List settled transactions GET

Lists your transactions that have been settled, with a summary of the total settled amount alongside the page of results. Use it for a transaction-level view of settlement; use GET /v3/payment/sett…

Get a settlement window GET

Retrieves one settlement window together with its batches. Each batch carries its own rfsDate (the ready-for-settlement date), channel and method, gross and net amounts, and the fees and VAT taken…