Docs

Build Vault V2 in-kind redemption calls

Builds and simulates an exact Vault V2 exit that returns idle assets to the account and supplies the illiquid portion into one caller-selected Morpho Blue market.


POST
/v0/actions/vaults-v2/{vault-selector}/redeem-in-kind

Vaults containing a Midnight adapter are unsupported. The simulation reports the idle/in-kind split and the current force-deallocate penalty in simulation.effects.penalty_assets, but the vault recomputes both at execution before expires_at. max_penalty_bps is required, and must cover a 2% penalty, when the current penalty is below 2% and its setter is not abdicated, whatever the setter's timelock; omitting it when required or setting it below the whole-exit worst case returns 422 ACTION_UNSUPPORTED. The cap is checked on preparation and on any continuation, never at execution: the bundle takes no penalty bound, so an already queued penalty change may exceed it at execution. Not every vault supports this route: the vault must allocate the selected market with enough capacity. amount must be the exact amount to exit; the API does not silently reduce it. Set signature_mode to request a vault-share Permit when available.

Authorization

ApiKeyAuth
x-api-key<token>

Send your Morpho-issued key on every action request. JWKS needs no key on every host; public documentation needs no key.

In: header

Path Parameters

vault-selector*string

Vault identifier formatted as <chain_id>:<vault_address>. The colon may be sent literally or as %3A. Mixed-case addresses must use a valid EIP-55 checksum.

Match^(?:[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]{1}|9007199254740990|9007199254740991):0x[0-9a-fA-F]{40}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v0/actions/vaults-v2/{vault-selector}/redeem-in-kind" \  -H "Content-Type: application/json" \  -d '{    "account": "0x545b6Cc751F0C47C202694cf835db2E3C071400A",    "amount": {      "unit": "assets",      "value": "1000000"    },    "market": "8453:0x9103c3b4e834476c9a62ea009ba2c884ee42e94e6e314a26f04d312434191836",    "max_penalty_bps": 200  }'

{  "data": {    "action_id": "act_0123456789abcdef0123456789abcdef",    "status": "prepared",    "action": "vault_v2.redeem_in_kind",    "chain_id": 8453,    "account": "0x545b6Cc751F0C47C202694cf835db2E3C071400A",    "expires_at": 1791461744,    "vault": {      "address": "0xbeef0e0834849aCC03f0089F01f4F1Eeb06873C9",      "asset": {        "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"      }    },    "market": {      "id": "0x9103c3b4e834476c9a62ea009ba2c884ee42e94e6e314a26f04d312434191836",      "loan_asset": {        "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"      }    },    "amount": {      "unit": "assets",      "value": "1000000"    },    "calls": [      {        "id": "call_0",        "kind": "approval",        "to": "0xbeef0e0834849aCC03f0089F01f4F1Eeb06873C9",        "data": "0x095ea7b3000000000000000000000000e52e169c342c096c4949abb944dc9f30e3f5ea84ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",        "value": "0"      },      {        "id": "call_1",        "kind": "vault_v2_in_kind_redeem",        "to": "0xE52E169C342C096C4949ABb944DC9f30E3F5Ea84",        "data": "0x3debf2f0000000000000000000000000beef0e0834849acc03f0089f01f4f1eeb06873c9000000000000000000000000fdd31cdf6712c47a4e67037d9f2e35587f5404c0000000000000000000000000000000000000000000000000000000000000016000000000000000000000000000000000000000000000000000000000000f424000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006ac78970000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006ac789700000000000000000000000000000000000000000000000000000000000000001000000000000000000000000833589fcd6edb6e08f4c7c32d4f71b54bda02913000000000000000000000000cbb7c0000ab88b473b1f5afd9ef808440eed33bf000000000000000000000000663becd10dae6c4a3dcd89f1d76c1174199639b900000000000000000000000046415998764c29ab2a25cbea6254146d50d226870000000000000000000000000000000000000000000000000bef55718ad600006ac76d5122221111",        "value": "0"      }    ],    "simulation": {      "status": "success",      "block": {        "number": "52332599",        "timestamp": 1791454545      },      "wallet_changes": [],      "position_changes": {        "vault_shares": "-958386135494236729",        "market_supply_shares": "902129516314"      },      "effects": {        "wallet_assets": "0",        "supplied_assets": "999990",        "penalty_assets": "10"      }    }  }}

The amount must be a positive decimal string that fits uint256.

{  "error": {    "code": "VALIDATION_FAILED",    "message": "Validation failed",    "details": [      {        "code": "invalid_format",        "message": "Expected a positive decimal string",        "path": [          "amount",          "value"        ]      },      {        "code": "custom",        "message": "Expected an amount that fits in uint256",        "path": [          "amount",          "value"        ]      }    ],    "request_id": "req_0123456789abcdef"  }}

The selected address is not a supported vault deployment.

{  "error": {    "code": "VAULT_NOT_FOUND",    "message": "The vault is not deployed by the registered Vault V2 factory.",    "details": null,    "request_id": "req_0123456789abcdef"  }}

Request bodies must not exceed 16384 bytes.

{  "error": {    "code": "PAYLOAD_TOO_LARGE",    "message": "Request body too large.",    "details": [      {        "code": "too_big",        "message": "Request body exceeds the 16384-byte limit",        "path": [          "body"        ]      }    ],    "request_id": "req_0123456789abcdef"  }}

Restart the same action without the continuation, sign the newly returned typed data, then finalize with the new continuation.

{  "error": {    "code": "SIGNATURE_REFRESH_REQUIRED",    "message": "The prepared signature nonce or deadline is no longer usable.",    "details": null,    "request_id": "req_0123456789abcdef"  }}

Empty
{  "error": {    "code": "INTERNAL_ERROR",    "message": "string",    "details": [      {        "code": "string",        "message": "string",        "path": [          "string"        ],        "rule": "string",        "details": {          "min_assets": "string",          "loan_token": "string"        }      }    ],    "request_id": "string"  }}

Chain state is temporarily unavailable; retry.

{  "error": {    "code": "STATE_UNAVAILABLE",    "message": "The vault state cannot be read right now.",    "details": null,    "request_id": "req_0123456789abcdef"  }}