Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Subscribe to a single settlement with real-time state updates.
import { useSettlement } from '@keystoneos/react';
function SettlementView({ settlementId }) {
const { settlement, isLoading, error, refetch } = useSettlement(settlementId);
if (isLoading) return <Spinner />;
if (error) return <Error message={error} />;
if (!settlement) return <NotFound />;
return (
<div>
<h2>{settlement.external_reference}</h2>
<p>State: {settlement.state}</p>
<p>Parties: {settlement.parties.length}</p>
<p>Legs: {settlement.legs.length}</p>
</div>
);
}
| Parameter | Type | Required | Description |
|---|---|---|---|
settlementId | string | null | Yes | The settlement UUID. Pass null to skip fetching. |
interface UseSettlementResult {
settlement: Settlement | null;
isLoading: boolean;
error: string | null;
refetch: () => Promise<void>;
}
| Property | Type | Description |
|---|---|---|
settlement | Settlement | null | The settlement data, or null if not loaded. |
isLoading | boolean | true during the initial fetch. |
error | string | null | Error message if the fetch failed. |
refetch | () => Promise<void> | Manually trigger a re-fetch. |
settlementId changes.state_changed event is received, the settlement object updates automatically.null as settlementId clears the settlement and stops subscriptions.settlement includes parties and legs:
interface Settlement {
id: string;
state: string;
template_slug?: string;
external_reference?: string;
idempotency_key: string;
timeout_at: string;
created_at: string;
updated_at: string;
parties: SettlementParty[];
legs: SettlementLeg[];
}