Instant settlement

Inquire about an instant settlement

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 nothing: no transactions are flagged and no payout is started. Call this first to show the merchant what they are agreeing to.

The fee is a percentage of the settled amount, plus VAT on that percentage, plus a flat transfer fee charged once per request. Your rate and flat fee are configured on your account.

Your per-request and daily caps are enforced here too, so a selection that would breach them is rejected before a request is ever created.

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

post/v3/payment/instant-settlements/instant/inquiry

Request

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

Request body

transactionIdsstring[] required

Transaction ids. Must be a non-empty array, and every id must still be eligible.

Response

The amount you would receive and the fees that would be deducted. Nothing has been committed.

totalAmountnumber

Gross value of the selected transactions, before any fees.

totalSettlementAmountnumber

What those transactions settle for normally, after their processing fees.

totalRateFeesnumber

The percentage part of the instant settlement fee.

vatnumber

VAT charged on the percentage part of the fee.

flatFeesnumber

The flat transfer fee, charged once per request.

totalFeesnumber

The whole instant settlement fee: totalRateFees + vat + flatFees.

netTransferAmountnumber

The net amount paid out to you: totalSettlementAmount minus totalFees.

transactionsCountinteger

How many transactions were included.

Changes

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