Skip to main content
withdrawal.requested Sent when a wallet starts the withdrawal timelock. Use it to show pending withdrawal state and the earliest expected finalization time.

Event fields

string
required
string
required
withdrawal.requested
string
required
ISO 8601 datetime
string
required
object
required
string
required
string
required
string
required
string
required
string
required
string
required
ISO 8601 datetime
string
required
ISO 8601 datetime
Earliest configured finalization time. Open obligations may still delay exit.
string
required
string
required
pending

Event examples

Payload
  • Display the withdrawal as pending, not completed.
  • Treat available_at as the earliest configured finalization time.
  • Check open guarantees and settlement obligations before telling a user that funds are withdrawable.
  • Reconcile current state if this event arrives after a finalization event.
See deposits and withdrawals.