Interface PaymentHandle

Readonlyid

Readonlystatus

settled

• settled(opts?: { timeoutMs?: number }): Promise<RouteResult>

  OPTIONAL await — resolves on a terminal result, rejects on the timeout. Fire-and-forget rails may never resolve it; that is allowed.

  Parameters

  • Optionalopts: { timeoutMs?: number }

  Returns Promise<RouteResult>

subscribe

• subscribe(
      fn: (
          u: { error?: unknown; result?: RouteResult; status: PaymentStatus },
      ) => void,
  ): () => void

  Progress stream; returns an unsubscribe fn. Replays the latest update. A terminal "failed" update carries the rejection in error (for swap rails a SwapError whose isRefundable/pendingSwap drive recovery).

  Parameters

  • fn: (u: { error?: unknown; result?: RouteResult; status: PaymentStatus }) => void

  Returns () => void