Actions APIReferenceVaultsSlugRedeem
Build transactions to submit a vault redemption request.
Path Parameters
slug*string
Length
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
redemptionAsset*string
ERC20 address of the desired redemption asset on the requested chain.
Match
^0x[a-fA-F0-9]{40}$shareAmount*string
Raw base-unit amount of vault shares to redeem (string for bigint safety).
Match
^\d+$chainId*integer
EVM chain ID. Must be one of the supported chains (Plume=98866, Ethereum=1, BSC=56, Plasma=9745, Avalanche=43114) and must match a chain the vault is deployed on.
Range
0 < valueuser*string
User/controller address submitting the redemption.
Match
^0x[a-fA-F0-9]{40}$skipSimulation?boolean
Skip the transaction simulation preflight.
Default
falseResponse Body
application/json
application/json
application/json
curl -X POST "https://example.com/vaults/nest-wisdom-vault/redeem/build-tx" \ -H "Content-Type: application/json" \ -d '{ "redemptionAsset": "0x222365ef19f7947e5484218551b56bb3965aa7af", "shareAmount": "1000000", "chainId": 98866, "user": "0x00000000000000000000000000000000000000ab" }'{ "data": { "slug": "string", "chainId": 0, "redemptionType": "nest", "shareTokenAddress": "string", "redemptionAsset": "string", "shareAmount": "string", "shareDecimals": 0, "redemptionAmount": "string", "redemptionDecimals": 0, "feeAmount": "string", "fees": { "ratePpm": 0, "flatAmount": "string", "maxRatePpm": 0, "maxFlatAmount": "string" }, "minPrice": "string", "deadline": "string", "transactions": [ { "label": "approve", "description": "string", "to": "string", "data": "string", "value": "0" } ] }}