POSTlive

Validate or execute the authorized settlement action

Requires a credential with the dedicated settlement:execute capability bound to the exact adapter. The action is derived from the served evaluation outcome, never supplied by the caller. Dry runs append a validated receipt; live calls append an immutable caller attempt linked to one server-derived business-operation journal. Different caller idempotency keys cannot resubmit the same binding, operative Award revision/hash, and action. Unknown provider outcomes require reconciliation before any terminal result is reported.

/api/v2/cases/{caseId}/settlement-executionsexecuteSettlementV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

settlementAdapterBearer

Credential carrying only settlement:execute and bound to one exact adapter resource.

Parameters

NameLocationRequirementSchema
caseIdpathRequired{"type":"string"}
Idempotency-KeyheaderRequired{"type":"string","minLength":8,"maxLength":200}

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/PartnerSettlementExecutionInput",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "bindingDigest"
  ],
  "properties": {
    "bindingDigest": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "dryRun": {
      "type": "boolean",
      "default": false
    }
  }
}

Responses

201

Immutable validation or execution attempt.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PartnerSettlementAttempt",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "partnerId",
        "caseId",
        "bindingId",
        "bindingDigest",
        "evaluationDigest",
        "dispositionId",
        "awardRevision",
        "awardHash",
        "outcomeCode",
        "action",
        "amountMinorUnits",
        "allocations",
        "currency",
        "dryRun",
        "status",
        "createdAt"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "partnerId": {
          "type": "string"
        },
        "caseId": {
          "type": "string"
        },
        "bindingId": {
          "type": "string"
        },
        "operationId": {
          "type": "string"
        },
        "operationKey": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "bindingDigest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "evaluationDigest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "dispositionId": {
          "type": "string"
        },
        "awardRevision": {
          "type": "integer",
          "minimum": 0
        },
        "awardHash": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "outcomeCode": {
          "type": "string"
        },
        "action": {
          "type": "string",
          "enum": [
            "release_to_claimant",
            "release_to_respondent",
            "allocate_by_award",
            "none"
          ]
        },
        "amountMinorUnits": {
          "type": "string",
          "pattern": "^(0|[1-9][0-9]{0,77})$"
        },
        "allocations": {
          "type": "array",
          "maxItems": 2,
          "items": {
            "$ref": "#/components/schemas/PartnerSettlementAllocation",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "recipient",
              "principalId",
              "amountMinorUnits"
            ],
            "properties": {
              "recipient": {
                "type": "string",
                "enum": [
                  "claimant",
                  "respondent"
                ]
              },
              "principalId": {
                "type": "string"
              },
              "amountMinorUnits": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,77})$"
              }
            }
          }
        },
        "currency": {
          "type": "string",
          "const": "USD"
        },
        "dryRun": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "validated",
            "manual_action_required",
            "callback_required",
            "completed",
            "failed",
            "blocked",
            "unknown_outcome"
          ]
        },
        "adapterReceipt": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "failureCode": {
          "type": "string"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "id": "id_test",
    "partnerId": "partner_test_123",
    "caseId": "case_test_123",
    "bindingId": "bindingId_test",
    "bindingDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "evaluationDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "dispositionId": "dispositionId_test",
    "awardRevision": 1,
    "awardHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "outcomeCode": "outcomeCode_test",
    "action": "release_to_claimant",
    "amountMinorUnits": "12500",
    "allocations": [
      {
        "recipient": "claimant",
        "principalId": "principal_test_123",
        "amountMinorUnits": "12500"
      }
    ],
    "currency": "USD",
    "dryRun": false,
    "status": "validated",
    "createdAt": "2026-08-09T12:00:00.000Z"
  },
  "requestId": "requestId_test"
}

Usage notes

  • Responses reflect the current authoritative resource state.
  • Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.

Likely next action: Inspect attempts and the business-operation journal →