Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
withdraw_funds · Boson Protocol
Skip to content

withdraw_funds

Withdraws funds from an entity's protocol treasury to the entity's treasury address. Sellers withdraw proceeds; buyers withdraw refunds. Caller must control the entity via signerAddress. Returns unsigned transaction data.

Category: Funds. Returns unsigned tx? Likely yes — sign locally and broadcast via send_signed_transaction or a meta-tx relay.

Input schema

FieldTypeRequiredDescription
entityIdstringyesNumeric ID of the seller or buyer entity withdrawing funds.
listobject[]yes
configIdstringyesBoson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Call get_config_ids to list all valid values for this server.
signerAddressyesEthereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally.
executionModedirect | metaTxno'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defaults to 'direct'.

Related