API · Exit · Entities
Create a wind down reserve.
Create a WindDownReserve against an open CreditorClaim so the entity can proceed to liquidating distribution without leaving the claim unresolved. The reserve is sized at the larger of the claim's amount_claimed_usd and the entity's good-faith estimate of the disputed exposure.
Once active reserves cover all open or disputed claims, the §281(b)(iii) precondition on calculateDissolutionDistribution is satisfied and the residual cascade can proceed.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
creditor_claim_idstringRequiredcreditor_claims_window_idstringRequiredheld_amount_usdnumberRequiredauthorizing_resolution_idstringRequiredcourt_petition_idstringOptionalCourt-supervised wind-down reserves. Set when the
reserve is being funded against a CourtOrder. court_approved_security_amount_cents rather than a
single open CreditorClaim. See
cookbook/dissolve-an-insolvent-entity for the §280
flow.
metadataobjectOptionalFlat string-to-string map. Up to 50 keys. Keys: max 40 chars, charset
[A-Za-z0-9_\\-.]. Values: max 500 chars. Keys prefixed matter_ are reserved
for platform use. Metadata is retrievable but not filterable via query params.
Response Body
application/json
Request
curl -X POST "https://api.mattermode.com/v1/entities/{id}/wind_down_reserves" \ -H "Content-Type: application/json" \ -d '{ "creditor_claim_id": "string", "creditor_claims_window_id": "string", "held_amount_usd": 0, "authorizing_resolution_id": "string" }'const body = JSON.stringify({ "creditor_claim_id": "string", "creditor_claims_window_id": "string", "held_amount_usd": 0, "authorizing_resolution_id": "string"})fetch("https://api.mattermode.com/v1/entities/{id}/wind_down_reserves", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/entities/{id}/wind_down_reserves" body := strings.NewReader(`{ "creditor_claim_id": "string", "creditor_claims_window_id": "string", "held_amount_usd": 0, "authorizing_resolution_id": "string" }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "creditor_claim_id": "example", "creditor_claims_window_id": "example", "held_amount_usd": 1, "authorizing_resolution_id": "example"}resp = requests.post( "https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/wind_down_reserves", headers=headers, json=payload,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "creditor_claim_id": "string", "creditor_claims_window_id": "string", "held_amount_usd": 0, "authorizing_resolution_id": "string"}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/entities/{id}/wind_down_reserves")) .header("Content-Type", "application/json") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "creditor_claim_id": "string", "creditor_claims_window_id": "string", "held_amount_usd": 0, "authorizing_resolution_id": "string"}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/entities/{id}/wind_down_reserves", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/wind_down_reserves' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "creditor_claim_id": "example", "creditor_claims_window_id": "example", "held_amount_usd": 1, "authorizing_resolution_id": "example"}'const response = await fetch("https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/wind_down_reserves", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "creditor_claim_id": "example", "creditor_claims_window_id": "example", "held_amount_usd": 1, "authorizing_resolution_id": "example" }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"object": "wind_down_reserve",
"id": "string",
"entity_id": "string",
"creditor_claim_id": "string",
"creditor_claims_window_id": "string",
"kind": "general_reserve",
"court_petition_id": "string",
"held_amount_usd": 0,
"released_amount_usd": 0,
"status": "held",
"authorizing_resolution_id": "string",
"opened_at": 0,
"closed_at": 0,
"created": 0,
"updated": 0,
"livemode": true
}No example available.