Skip to main content
POST
Builds the redeem transaction that turns a holder’s shares in one of this market’s connected vaults back into the vault’s asset, the market’s settlement token (stablecoin). The holder’s wallet signs it. No approval is needed, since the vault burns the holder’s own shares. Any vault connected to this market can be redeemed through it, whether or not its operator has published it. Nothing on the vault can pause a redemption. Send the same call again with the transaction’s hash to confirm it.
A redemption fills only as far as liquidity allows. The vault pays from its idle funds first, then draws back what the markets it funds have free. When utilization blocks the rest, the redemption pays out part of the value and the unpaid shares stay in the wallet. This build carries no estimate of the fill, because it checks only the holder’s share balance.
For a fill estimate, use Redeem on the vault surface for a vault visible to your instance. It returns willFillFully and expectedPayout before the signature.

Path Parameters

string
required
The market’s record ID, as id on List Markets, not its contract address. See Market IDs.
string
required
A vault connected to this market, from List Connected Vaults. 0x followed by 40 hex characters. A mixed-case address must pass its EIP-55 checksum.

Body Parameters

string
Shares to redeem as a decimal string. Digits with an optional fraction, greater than zero, parsed at the vault’s asset decimals, which are also its share decimals. A finer fraction answers VALIDATION_ERROR. Required when building calldata, ignored when confirming.
string
The wallet that will sign. redeem burns the caller’s own shares, so shares is checked against this wallet’s balance before any calldata is built. Required when building calldata, and omitting it answers VALIDATION_ERROR. Ignored when confirming.
string
Hash of the mined redemption. Send it on its own to confirm and record the redemption. Omit it to receive the calldata.

Gas limit

A wallet’s own estimate can come up short when the markets the vault has consented to draw for already accrued interest in the block it estimates in. The API waits for a block past those markets’ last accrual, simulates the redemption from holderAddress with eth_simulateV1, and sets gasLimit on transaction to the gas used plus 50 percent, checked in a second simulation under that limit. Sign with the transaction as handed, gasLimit included. When the node cannot simulate, or the redemption fails in the simulation, transaction carries no gasLimit. See Gas limit on the vault surface.

Confirm the redemption

Send the redemption’s hash back to this same endpoint as { "txHash": "0x..." }, as confirmWith names. The API verifies the receipt against the vault and reads what was paid from the vault’s Redeemed event. amount on the confirm response is the assets actually paid, not the value of the shares requested. A partial fill shows as an amount below the value of the shares you redeemed. When the vault has a Trusset record, the redemption is written to the vault’s transaction history, and recorded says so.

Response Fields

object

Error Codes

Confirming with txHash can also return any transaction verification error.