List eligible transactions
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.
Request
- Base URL: https://test-api.kashier.io
- URL: https://test-api.kashier.io/v3/payment/instant-settlements/instant/eligible-transactions
- Auth: API key in header Authorization
Query parameters
1-based page number. Clamped to at least 1.
Records per page. Clamped to the range 1–100.
Optional channel filter.
Optional payment-method filter, intersected with the eligible methods.
Inclusive lower bound on the transaction date (ISO).
Inclusive upper bound on the transaction date (ISO). Extended to the end of that day.
Response
The eligible transactions for this page, plus totals for the whole eligible set and your current caps.
Changes
No recorded changes to this operation across all 1 revision of this API.