Build a quoted Midnight credit withdrawal
Withdraws an exact loan-asset amount (unit: assets) or an exact credit-unit amount (unit: units) from a Midnight credit position.
Liquidity already available in the market is redeemed first; any remainder is sold against open offers and is covered by the returned quote. Send amount: { "unit": "all" } to redeem the accrued position's current face value directly from market liquidity, without taking offers or using a price guard. Before maturity this may leave pending fees and a residual credit position, so it is not a full exit; the market must have enough withdrawable liquidity to cover the face value or the request returns 422 INSUFFICIENT_LIQUIDITY. Alternatively, with allow_partial: true and amount.unit: all, directly redeem the smaller of accrued credit and currently withdrawable liquidity, without selling to offers or accepting a guard. Zero credit returns POSITION_EMPTY; zero withdrawable liquidity returns INSUFFICIENT_LIQUIDITY. The field defaults to false and is rejected with exact amounts, even when false, with VALIDATION_FAILED. The response's resolved_amount.value and simulation redeemed-unit effect report the actual redemption; amount remains { "unit": "all" } without a value. To withdraw while selling part of the position, send a units amount equal to the position's credit units, with a guard. A sell remainder requires a guard: slippage, max_rate for a maximum WAD-scaled per-second simple rate, or the matching absolute bound (max_units for an assets amount, min_assets for a units amount). Only exact withdrawals accept max_rate; complete withdrawals reject rate guards. With slippage, the guarded seller price is also never below the price implied by a 100% fixed APR to maturity, and quotes below that floor are rejected. The same floor applies to the sold remainder of a units withdrawal when min_assets is already covered by direct redemption; in that case, the encoded minimum is raised to the value of the redeemed units plus the remainder priced at that floor, net of the referral fee, and the action can return QUOTE_RATE_ABOVE_CEILING. The action is reduce-only and cannot open debt. Exception: on an exact Midnight withdraw, when available liquidity covers the whole withdrawal, the response is a midnight.redeem action whose amount is the credit units redeemed, whatever unit was requested; max_rate is still satisfied by face-value redemption, but referral_fee is rejected in that case.
Authorization
ApiKeyAuth 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
Midnight market selector formatted as <chain_id>:<market_id>. The colon may be sent literally or as %3A.
^(?:[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]{64}$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/midnight/markets/{market-selector}/withdraw" \ -H "Content-Type: application/json" \ -d '{ "account": "0x6aBB9Aeb93e9aF04c8D9FD2b84BF6ca8EDC3eAf2", "amount": { "unit": "assets", "value": "1000000" }, "guard": { "type": "slippage", "bps": 50 } }'{ "data": { "action_id": "act_0123456789abcdef0123456789abcdef", "status": "prepared", "chain_id": 8453, "account": "0x6aBB9Aeb93e9aF04c8D9FD2b84BF6ca8EDC3eAf2", "expires_at": 1760001800, "market": { "id": "0xcdea4ca06837feca3026b23a95f0bd96c3eabdc77d1211472ce0346fcc200649", "loan_asset": { "address": "0x4200000000000000000000000000000000000006" }, "collaterals": [ { "address": "0x2Ae3F1Ec7F1F5012CFEab0185bfc7aa3cf0DEc22" }, { "address": "0xFa750DD0099eAdB72d401244De73ce7B89edf90F" } ] }, "action": "midnight.withdraw", "amount": { "unit": "units", "value": "1000000" }, "guard": { "type": "slippage", "bps": 50 }, "quote": { "average_best_price_wad": "999701089374277091", "average_worst_price_wad": "994702583927405705", "available_assets": "1000000", "available_units": "1000000", "offer_count": 1 }, "max_withdraw_units": "1000000", "calls": [ { "id": "call_0", "kind": "withdraw", "to": "0x0bF30B530f816a619C3F28a3b9f44C441122555D", "data": "0xad43ff97000000000000000000000000000000000000000000000000000000000000016000000000000000000000000000000000000000000000000000000000000f424000000000000000000000000000000000000000000000000000000000000f1b3000000000000000000000000000000000000000000000000000000000000000010000000000000000000000006abb9aeb93e9af04c8d9fd2b84bf6ca8edc3eaf2000000000000000000000000000000000000000000000000000000000000038000000000000000000000000000000000000000000000000000000000000003a0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000068e77f0800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002105000000000000000000000000adedd8ab6de832766fedf0fac4992e5c4d3ea18a00000000000000000000000042000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000006ae4b0f00000000000000000000000000000000000000000000000003782dace9d9000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020000000000000000000000002ae3f1ec7f1f5012cfeab0185bfc7aa3cf0dec220000000000000000000000000000000000000000000000000d1d507e40be80000000000000000000000000000000000000000000000000000429d069189e0000000000000000000000000000b03855ad5afd6b8db8091dd5551cac4ed621d9e6000000000000000000000000fa750dd0099eadb72d401244de73ce7b89edf90f0000000000000000000000000000000000000000000000000d99a8cec7e200000000000000000000000000000000000000000000000000000429d069189e0000000000000000000000000000a02f629871be35d6db0f88c944cf955554ec87c00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000048000000000000000000000000000000000000000000000000000000000000f424000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000001000000000000000000000000200000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000068e77f08000000000000000000000000000000000000000000000000000000000000138800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005000000000000000000000000000000000000005000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001e8480000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002105000000000000000000000000adedd8ab6de832766fedf0fac4992e5c4d3ea18a00000000000000000000000042000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000006ae4b0f00000000000000000000000000000000000000000000000003782dace9d9000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020000000000000000000000002ae3f1ec7f1f5012cfeab0185bfc7aa3cf0dec220000000000000000000000000000000000000000000000000d1d507e40be80000000000000000000000000000000000000000000000000000429d069189e0000000000000000000000000000b03855ad5afd6b8db8091dd5551cac4ed621d9e6000000000000000000000000fa750dd0099eadb72d401244de73ce7b89edf90f0000000000000000000000000000000000000000000000000d99a8cec7e200000000000000000000000000000000000000000000000000000429d069189e0000000000000000000000000000a02f629871be35d6db0f88c944cf955554ec87c0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000021234000000000000000000000000000000000000000000000000000000000000", "value": "0" } ], "simulation": { "status": "success", "block": { "number": "21000000", "timestamp": 1760000000 }, "wallet_changes": [ { "asset": { "type": "erc20", "address": "0x4200000000000000000000000000000000000006" }, "difference": "1000000" } ], "position_changes": { "credit_units": "-1000000", "debt_units": "0" }, "effects": { "withdrawn_assets": "1000000", "withdrawn_units": "1000000", "referral_fee_assets": "0" } }, "resolved_amount": { "unit": "units", "value": "1000000" } }}{ "error": { "code": "REQUEST_ABORTED", "message": "string", "details": [ { "code": "string", "message": "string", "path": [ "string" ], "rule": "string", "details": { "min_assets": "string", "loan_token": "string" } } ], "request_id": "string" }}{ "error": { "code": "MARKET_NOT_FOUND", "message": "string", "details": [ { "code": "string", "message": "string", "path": [ "string" ], "rule": "string", "details": { "min_assets": "string", "loan_token": "string" } } ], "request_id": "string" }}{ "error": { "code": "PAYLOAD_TOO_LARGE", "message": "string", "details": [ { "code": "string", "message": "string", "path": [ "string" ], "rule": "string", "details": { "min_assets": "string", "loan_token": "string" } } ], "request_id": "string" }}{ "error": { "code": "ACTION_UNSUPPORTED", "message": "This action is not supported.", "details": null, "request_id": "req_0123456789abcdef0123456789abcdef" }}{ "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" }}{ "error": { "code": "CONTRACT_CODE_MISSING", "message": "string", "details": [ { "code": "string", "message": "string", "path": [ "string" ], "rule": "string", "details": { "min_assets": "string", "loan_token": "string" } } ], "request_id": "string" }}POSTBuild a quoted Midnight lend
Builds a lend of an exact loan-asset spend (unit: assets, inclusive of any referral fee) or an exact credit-unit amount (unit: units; credit units are the…
POSTBuild Midnight collateral-withdrawal calls
Builds calls that withdraw exact or complete balances of one or more configured collaterals from a Midnight position.