KashierDevelopersKashier Developers
API reference and playgroundSettlement reporting

Get a settlement window

curl -X GET "https://test-api.kashier.io/v3/payment/settlement/windows/string"
{  "message": "string",  "data": {    "windowId": "string",    "accountId": "string",    "merchantId": "string",    "windowDate": "string",    "startDate": "string",    "endDate": "string",    "status": "open",    "totalOriginalAmount": 0,    "totalSettlementAmount": 0,    "transactionsCount": 0,    "batchesCount": 0,    "batchesIds": "string",    "batches": [      {        "batchId": "string",        "rfsDate": "string",        "channel": "string",        "method": "string",        "transactionsCount": 0,        "totalOriginalAmount": 0,        "totalFees": 0,        "totalVat": 0,        "totalSettlementAmount": 0      }    ]  }}

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 — the numbers you reconcile a settlement against.

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

Path Parameters

windowId*string

Settlement window identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v3/payment/settlement/windows/{windowId}

List settlement windows GET

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 wha…

Get a batch within a settlement window GET

Retrieves one batch of one settlement window. This is the last step of reconciling a single order: read the order's settlementWindowId and settlementBatchId from the transaction, then fetch the bat…