Skip to main content
POST
Offboard all VTXOs

Authorizations

Authorization
string
header
required

Base64url-encoded auth token

Body

application/json
address
string | null

Optional Bitcoin address to send to. If not provided, uses the onchain wallet's address

Response

Returns the offboard transaction id and the movement id

movement_id
integer<int32>
required

The movement that records this offboard in the wallet history

Required range: x >= 0
offboard_txid
string
required

The transaction id of the offboard transaction