KashierDevelopersKashier Developers
API reference and playgroundSettlement reporting

List settled transactions

curl -X GET "https://test-api.kashier.io/v2/aggregator/settlement-transactions"
{  "body": [    {}  ],  "pagination": {    "total": 0,    "limit": 0,    "page": 0,    "pages": 0  },  "summary": {}}

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/settlement/windows when you want the window and batch grouping instead.

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.

limit?integer

Number of records per page.

sortBy?string

Field to sort by.

sortDirection?string

Sorting direction: asc or desc.

Value in

  • "asc"
  • "desc"
sortType?integer

Sorting direction as a number: 1 = ascending, -1 = descending.

Value in

  • 1
  • -1
search?string

Search term.

branchIds?string

Restrict the results to specific branches.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/aggregator/settlement-transactions

List holds on a balance account GET

Lists the holds placed on a balance account. A hold reserves part of the balance so it cannot be paid out yet — it explains a gap between an account's total balance and its available balance.

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…