KashierDevelopersKashier Developers
API reference and playgroundInstant settlement

List eligible transactions

curl -X GET "https://test-api.kashier.io/v3/payment/instant-settlements/instant/eligible-transactions"
{  "message": "success",  "data": [    {      "transactionId": "TX-1001",      "amount": 10000,      "settlementAmount": 10000,      "accountId": "ACC-39550-436-01",      "method": "card",      "channel": "online",      "transactionDate": "2026-06-10T11:20:00.000Z",      "rfsDate": "2026-06-15T00:00:00.000Z"    },    {      "transactionId": "TX-1002",      "amount": 5000,      "settlementAmount": 5000,      "accountId": "ACC-39550-436-02",      "method": "wallet",      "channel": "online",      "transactionDate": "2026-06-11T09:05:00.000Z",      "rfsDate": "2026-06-16T00:00:00.000Z"    }  ],  "pagination": {    "total": 2,    "limit": 20,    "page": 1,    "pages": 1  },  "summary": {    "count": 2,    "totalAmount": 15000,    "totalSettlementAmount": 15000  },  "limits": {    "perRequestCap": 100000,    "dailyCap": 250000,    "usedToday": 0,    "remainingToday": 250000  }}

Returns a paginated list of your not-yet-settled transactions that are eligible for instant settlement, together with summary totals across the whole eligible set and the caps that apply to your account.

A transaction qualifies when it is a captured payment that has not been voided or refunded, was taken on a card or wallet, has not passed its normal settlement date, and is not already part of another instant settlement 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. Clamped to at least 1.

Default1
limit?integer

Records per page. Clamped to the range 1–100.

Default20
channel?string

Optional channel filter.

Value in

  • "online"
  • "pos"
method?string

Optional payment-method filter, intersected with the eligible methods.

Value in

  • "card"
  • "wallet"
dateFrom?string

Inclusive lower bound on the transaction date (ISO).

dateTo?string

Inclusive upper bound on the transaction date (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/eligible-transactions

Get payment method definitions GET

Retrieves every payment method Kashier supports, mapped to the provider integrations that can process it. It is the canonical list of method names — card, wallet, bankinstallments, and the rest — u…

Get amount suggestions POST

Given a target amount, returns the combination of your eligible transactions whose combined settlementAmount comes closest to it — one combination at or below the target (below) and one at or above…