Instant settlement

Get amount suggestions

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 it (above) — so you do not have to hand-pick transactions to hit a number.

Both sides are clamped to your effective cap (the lower of perRequestCap and your remaining daily cap), and a side is null when no combination fits. Ties are broken in favour of the combination with fewer transactions. Each side carries the transactionIds you can pass straight to the fee inquiry or to create a request.

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

post/v3/payment/instant-settlements/instant/suggestions

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v3/payment/instant-settlements/instant/suggestions
  • Auth: API key in header Authorization

Request body

targetAmountnumber required

The amount you would like to get as close to as possible. Must be a positive number.

channelstring

Optional channel filter — online or pos.

methodstring

Optional payment-method filter — card or wallet.

dateFromstring

Optional inclusive lower bound on the transaction date (ISO).

dateTostring

Optional inclusive upper bound on the transaction date (ISO).

Response

The nearest combination below and above the target.

targetAmountnumber

The target you asked for.

candidatesConsideredinteger

How many eligible transactions were considered.

truncatedboolean

Whether the candidate set was truncated before the search ran.

approximateboolean

Whether the result is an approximation rather than the exact nearest combination.

Changes

No recorded changes to this operation across all 1 revision of this API.