KashierDevelopersKashier Developers

Get amount suggestions

curl -X POST "https://test-api.kashier.io/v3/payment/instant-settlements/instant/suggestions" \  -H "Content-Type: application/json" \  -d '{    "targetAmount": 50000  }'

{  "targetAmount": 50000,  "below": {    "totalAmount": 38500,    "transactionsCount": 4,    "transactionIds": [      "TX-A30000",      "TX-B7000",      "TX-C1000",      "TX-D500"    ]  },  "above": {    "totalAmount": 55000,    "transactionsCount": 2,    "transactionIds": [      "TX-A30000",      "TX-E25000"    ]  },  "candidatesConsidered": 5,  "truncated": false,  "approximate": false,  "limits": {    "perRequestCap": 100000,    "dailyCap": 250000,    "remainingToday": 250000  }}

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.

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 target amount to find transaction combinations for, plus optional filters narrowing the candidate set.

Response Body

application/json

application/json

application/json

application/json

application/json

POST
/v3/payment/instant-settlements/instant/suggestions