Skip to main content
POST
Board a specific amount

Authorizations

Authorization
string
header
required

Base64url-encoded auth token

Body

application/json
amount_sat
integer<int64>
required

An amount of onchain funds to board (in satoshis). For a board operation to be successful, this value, with any server-configured BoardFees [blocked] deducted, must be

= P2TR_DUST [blocked].

Required range: x >= 0

Response

Returns the board result

Describes a completed transition of funds from onchain to offchain.

amount_sat
integer<int64>
required

The amount of the board.

Required range: x >= 0
funding_tx
object
required

The funding transaction. This is the transaction that has to be confirmed onchain for the board to succeed.

movement_id
integer<int32>
required

The ID of the movement associated with this board.

Required range: x >= 0
vtxos
string[]
required

The IDs of the VTXOs that were created in this board.

Currently, this is always a vector of length 1