Skip to main content
POST
/
api
/
v1
/
wallet
/
offboard
/
vtxos
Offboard specific VTXOs
curl --request POST \
  --url https://api.example.com/api/v1/wallet/offboard/vtxos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vtxos": [
    "<string>"
  ],
  "address": "<string>"
}
'
{
  "offboard_txid": "<string>"
}

Authorizations

​
Authorization
string
header
required

Base64url-encoded auth token

Body

application/json
​
vtxos
string[]
required

List of VTXO IDs to offboard. The sum of the VTXOs being refreshed must be

= P2TR_DUST [blocked] after the server-configured OffboardFees [blocked] are deducted.

​
address
string | null

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

Response

Returns the offboard transaction id

​
offboard_txid
string
required

The transaction id of the offboard transaction