Skip to main content

Import

Usage

Parameters

Return Type

Behavior

  • Fetches the settlement on mount and whenever settlementId changes.
  • Subscribes to real-time updates via the event bus (polling in Phase 1, SSE in Phase 2).
  • When a state_changed event is received, the settlement object updates automatically.
  • Passing null as settlementId clears the settlement and stops subscriptions.

Settlement Object

The returned settlement includes parties and legs:
The full type definitions ship with the package’s TypeScript declarations.