Instant settlement

Get request details

Returns the full detail of a single instant settlement request: its totals and fee breakdown, its status history, the transactions an agent excluded from it, and the balance-ledger records created for its early-payout deduction.

linkedBalanceRecords is empty while the request is still PENDING, because no deduction has posted yet. If the balance ledger is temporarily unavailable the details still return, but with linkedBalanceRecords: null and linkedBalanceRecordsUnavailable: true — retry later to get the records.

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

get/v3/payment/instant-settlements/instant-requests/{id}

Request

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

Path parameters

idstring required
Example:ISR-1042

The request's UUID id or its human-readable requestId (for example ISR-1042).

Response

The request's full detail.

messagestring

Changes

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