KashierDevelopersKashier Developers
API reference and playgroundInstant settlement

List your instant settlement requests

curl -X GET "https://test-api.kashier.io/v3/payment/instant-settlements/instant-requests"
{  "message": "success",  "data": [    {      "id": "d2719f9a-3a36-4f10-9c7b-1f2e3d4c5b6a",      "requestId": "ISR-1042",      "merchantId": "MID-957-917",      "status": "PENDING",      "totalSettlementAmount": 15000,      "netTransferAmount": 14743.5,      "transactionsCount": 2,      "createdAt": "2026-06-13T08:00:00.000Z"    }  ],  "pagination": {    "total": 1,    "limit": 20,    "page": 1,    "pages": 1  }}

Returns a paginated list of your own instant settlement requests, newest first, with the totals and status of each. Use Get request details for the full breakdown of a single request.

Requires the instant_settlement_request feature flag and the instant_settlements.all.view_instant_settlement permission.

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

1-based page number.

Default1
limit?integer

Records per page.

Default20
status?string

Filter by request status.

Value in

  • "PENDING"
  • "PROCESSING"
  • "TRANSFERRED"
  • "DECLINED"
requestId?string

Filter or search by the human-readable requestId (prefix-safe).

dateFrom?string

Inclusive lower bound on the date range (ISO).

dateTo?string

Inclusive upper bound on the date range (ISO). Extended to the end of that day.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v3/payment/instant-settlements/instant-requests

Inquire about an instant settlement POST

Works out what you would receive for a set of transactions without committing to it. It runs the same calculation the create-request endpoint runs and returns the same breakdown, but it changes not…

Create an instant settlement request POST

Creates an instant settlement request over the selected transactions. The request is created in PENDING status and is then reviewed by Kashier: approval moves it to PROCESSING and deducts the early…