List settlement windows
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.
Request
- Base URL: https://test-api.kashier.io
- URL: https://test-api.kashier.io/v3/payment/settlement/windows
- Auth: API key in header Authorization
Query parameters
Page number. Defaults to 1.
Number of records per page. Defaults to 20.
Field to sort by. Defaults to createdAt.
Sorting direction: 1 = ascending, -1 = descending. Defaults to -1.
Filter by window status. all applies no status filter, and is the default.
Search term. A value starting with TX- is treated as a settlement transaction id and resolves to the window containing that transaction.
Only return windows on or after this date.
Set to export to download the windows list as a spreadsheet instead of JSON.
Response
The settlement windows, with pagination.
Changes
No recorded changes to this operation across all 1 revision of this API.