API · Exit · Entities
Settle creditor claim.
Mark a recorded claim as settled, denied, or time-barred. Settling with outcome = settled requires a settlement_document_id pointing at an executed Document of kind: settlement_agreement.
Tier-3 + human signature. The settlement amount lands as a creditor_payment line on any subsequent DissolutionDistributionPlan calc.
Last updated
Path Parameters
idstringRequiredclaim_idstringRequiredRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
outcomestringRequired"settled""denied""time_barred"settled_amount_usdnumberOptionalRequired when outcome = settled. May differ from amount_claimed_usd.
settlement_document_idstringOptionalRequired when outcome = settled. Document of kind: settlement_agreement in execution_status: executed.
settlement_payment_sourcestringOptionalRequired when outcome = settled (null otherwise).
Discriminates which §281(b)(iii) bucket pays the
settlement. remaining_cash — paid from the entity's
operating cash before the residual cascade.
wind_down_reserve — paid from a previously-set-aside
WindDownReserve (requires wind_down_reserve_id).
claimant_releases_for_zero — claimant released the
claim with no payment (typically in exchange for some
other consideration captured in the settlement
Document).
null"remaining_cash""wind_down_reserve""claimant_releases_for_zero"wind_down_reserve_idstringOptionalRequired when settlement_payment_source = wind_down_reserve. The reserve must be in status: held
with sufficient held_amount_usd to cover
settled_amount_usd. Settlement decrements
held_amount_usd and increments released_amount_usd.
denial_reasonstringOptionalRequired when outcome = denied.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/creditor_claims_windows/string/claims/string/settle" \ -H "Content-Type: application/json" \ -d '{ "outcome": "settled" }'const body = JSON.stringify({ "outcome": "settled"})fetch("https://api.mattermode.com/v1/creditor_claims_windows/string/claims/string/settle", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/creditor_claims_windows/string/claims/string/settle" body := strings.NewReader(`{ "outcome": "settled" }`) 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 = { "outcome": "settled"}resp = requests.post( "https://api.mattermode.com/v1/creditor_claims_windows/id_placeholder/claims/id_placeholder/settle", 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("""{ "outcome": "settled"}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/creditor_claims_windows/string/claims/string/settle")) .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("""{ "outcome": "settled"}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/creditor_claims_windows/string/claims/string/settle", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/creditor_claims_windows/id_placeholder/claims/id_placeholder/settle' \ --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 '{ "outcome": "settled"}'const response = await fetch("https://api.mattermode.com/v1/creditor_claims_windows/id_placeholder/claims/id_placeholder/settle", { 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({ "outcome": "settled" }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"claim_id": "string",
"status": "string",
"authorization_id": "string"
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "No entity with id `ent_Nq3KcAbc` is visible to this token.",
"doc_url": "https://mattermode.com/docs/guides/errors#not_found",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/invalid_state_transition",
"title": "Invalid state transition",
"status": 409,
"code": "invalid_state_transition",
"detail": "Entity ent_Nq3KcAbc is in state `dissolved`; `dissolve` is not a valid transition.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_state_transition",
"request_id": "req_Qw9xYz8A",
"current_state": "dissolved",
"attempted_transition": "dissolve",
"allowed_transitions": []
}{
"type": "https://mattermode.com/docs/errors/dissolution_prerequisites_missing",
"title": "Dissolution prerequisites missing",
"status": 409,
"code": "dissolution_prerequisites_missing",
"detail": "Voluntary dissolution requires `board_resolution_id` and `stockholder_consent_id`, or `auto_generate_resolutions: true`.",
"doc_url": "https://mattermode.com/docs/guides/errors#dissolution_prerequisites_missing",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/valuation_stale",
"title": "409A valuation stale",
"status": 409,
"code": "valuation_stale",
"detail": "Active 409A val_AbCd1234 is older than 12 months or superseded by a material event. Issuing ISOs at the prior strike risks IRC §409A violation. Refresh via POST /entities/{id}/valuations/{id}/refresh_request.",
"doc_url": "https://mattermode.com/docs/guides/errors#valuation_stale",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/validation_failed",
"title": "Validation failed",
"status": 422,
"code": "validation_failed",
"detail": "One or more fields failed validation. See `errors[]`.",
"doc_url": "https://mattermode.com/docs/guides/errors#validation_failed",
"request_id": "req_Qw9xYz8A",
"errors": [
{
"field": "founders[0].equity",
"code": "out_of_range",
"message": "Equity must sum to 100% across all founders."
}
]
}