KashierDevelopersKashier Developers

Inquire about an instant settlement

curl -X POST "https://test-api.kashier.io/v3/payment/instant-settlements/instant/inquiry" \  -H "Content-Type: application/json" \  -d '{    "transactionIds": [      "TX-1001",      "TX-1002"    ]  }'
{  "totalAmount": 15000,  "totalSettlementAmount": 15000,  "totalRateFees": 225,  "vat": 31.5,  "flatFees": 0,  "totalFees": 256.5,  "netTransferAmount": 14743.5,  "transactionsCount": 2}

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.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The transactions to quote a fee for, or to include in a request.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

POST
/v3/payment/instant-settlements/instant/inquiry