Claim a settled bond
/sigmafi/claims/{tokenId}api_keyTake the vault output the bond's settlement paid, found from the bond's own confirmed spend, burning the bond asset. Up to 8 other vault boxes naming the asset, largest first, come with it, each box into an output of its own. Burning the asset locks every vault box naming it that the claim leaves, for good; the quote's warnings and the result's warnings say what is left. Refused while a bond still holds the asset's other unit, for an asset that is not verified, and while the settlement cannot be established from the node's index.
Path parameters
tokenIdstringrequiredThe bond asset's token id.
Responses
200The transaction was sent; `outcome` says whether the node accepted it.SFResult▶
txIdstringrequiredoutcomestringrequiredone ofacceptedrejecteduncertainboxIdstringThe output that matters: the new order or bond, the vault box a repayment or liquidation pays, or the first box a cancel or claim returns to this wallet.
assetIdstringThe bond asset a fill minted.
warningsstring[]What to know about the sent transaction: vault boxes a claim left locked for good, or a repayment sent with two blocks or fewer left to be mined in.
403Missing or wrong api_key.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
404No unspent box has that id, it is not the kind named, or it is not this wallet's.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
409A pending transaction already spends a box this names. Re-read and resend.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
422Valid, but not possible now: the box's terms are refused, maturity has passed or not come, the wallet cannot cover it, or no wallet box can authorize a cancel.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503Node, wallet or transaction engine unavailable, or the request ran out of time. The message says whether anything was sent. When it says the outcome is unknown, check `GET /sigmafi/portfolio` before retrying.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description