GETpartial

List settlement attempts and business operations

List settlement attempts and business operations.

/api/cases/{id}/settlement-executionsgetSettlementExecutionsCanonical

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
idpathRequired{"type":"string"}
view

Select executions for the four-mode Award resource; omission preserves the legacy attempts response.

queryOptional{"type":"string","enum":["executions"]}

Responses

200

Immutable caller attempts and the authoritative business-operation journal.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "caseId",
            "executions"
          ],
          "properties": {
            "caseId": {
              "type": "string"
            },
            "executions": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AwardExecutionResource",
                "type": "object",
                "required": [
                  "id",
                  "caseId",
                  "awardId",
                  "awardHash",
                  "mode",
                  "status",
                  "paymentConfirmed",
                  "executedBy",
                  "receipt",
                  "reports",
                  "links"
                ],
                "properties": {
                  "provider": {
                    "type": "string"
                  },
                  "providerOperation": {
                    "type": "object",
                    "required": [
                      "id",
                      "status",
                      "attempts"
                    ],
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "status": {
                        "enum": [
                          "prepared",
                          "submitting",
                          "unknown",
                          "confirmed",
                          "needs_action"
                        ]
                      },
                      "attempts": {
                        "type": "integer",
                        "minimum": 0
                      }
                    }
                  },
                  "reconciliation": {
                    "type": "object",
                    "required": [
                      "state",
                      "checkedAt",
                      "recovery"
                    ],
                    "properties": {
                      "state": {
                        "enum": [
                          "pending",
                          "unknown",
                          "confirmed",
                          "needs_action",
                          "reversed"
                        ]
                      },
                      "checkedAt": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date-time"
                      },
                      "recovery": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "reason": {
                            "enum": [
                              "vacated",
                              "superseded",
                              "provider_reversal"
                            ]
                          },
                          "status": {
                            "enum": [
                              "pending",
                              "reversed",
                              "needs_action"
                            ]
                          },
                          "detail": {
                            "type": "string"
                          },
                          "requestedAt": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "updatedAt": {
                            "type": "string",
                            "format": "date-time"
                          }
                        }
                      }
                    }
                  },
                  "providerReceipts": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "step",
                        "id",
                        "object",
                        "amount",
                        "currency",
                        "livemode",
                        "status"
                      ],
                      "properties": {
                        "step": {
                          "enum": [
                            "debit",
                            "transfer",
                            "reverse_transfer",
                            "refund_debit"
                          ]
                        },
                        "id": {
                          "type": "string"
                        },
                        "object": {
                          "enum": [
                            "charge",
                            "payment",
                            "transfer",
                            "transfer_reversal",
                            "refund"
                          ]
                        },
                        "amount": {
                          "type": "integer",
                          "minimum": 1
                        },
                        "currency": {
                          "const": "usd"
                        },
                        "livemode": {
                          "type": "boolean"
                        },
                        "source": {
                          "type": "string"
                        },
                        "destination": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "id": {
                    "type": "string"
                  },
                  "caseId": {
                    "type": "string"
                  },
                  "awardId": {
                    "type": "string"
                  },
                  "awardHash": {
                    "type": "string"
                  },
                  "mode": {
                    "type": "string",
                    "enum": [
                      "partner_executed",
                      "court_escrow",
                      "external_provider",
                      "decision_only"
                    ]
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "decision_delivered",
                      "execution_pending",
                      "overdue",
                      "will_not_execute",
                      "not_automatically_executed",
                      "performance_reported",
                      "performance_acknowledged",
                      "performance_disputed",
                      "not_requested",
                      "pending",
                      "unknown_outcome",
                      "needs_action",
                      "blocked",
                      "executed",
                      "simulated",
                      "reversal_pending",
                      "reversed",
                      "reversal_needs_action"
                    ]
                  },
                  "paymentConfirmed": {
                    "type": "boolean"
                  },
                  "executedBy": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "partner",
                      "peoples_court",
                      "provider",
                      null
                    ]
                  },
                  "receipt": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/ExecutionReceipt"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "reports": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/ExecutionPerformanceReport",
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "id",
                        "by",
                        "description",
                        "reportedAt",
                        "responses"
                      ],
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "by": {
                          "type": "string",
                          "enum": [
                            "claimant",
                            "respondent",
                            "partner"
                          ]
                        },
                        "description": {
                          "type": "string"
                        },
                        "reference": {
                          "type": "string"
                        },
                        "reportedAt": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "responses": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ExecutionPerformanceResponse"
                          }
                        }
                      }
                    }
                  },
                  "attestation": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/ExecutionNonPerformanceAttestation"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "submissionAttempts": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "minimum": 0,
                    "description": "Durable adapter invocations, excluding reconciliation reads. Historical counts are null when unavailable. An invocation may stop before provider submission."
                  },
                  "deliveredAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "overdueAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time"
                  },
                  "nextReconcileAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time"
                  },
                  "reminders": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "createdAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "updatedAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "links": {
                    "type": "object",
                    "required": [
                      "self",
                      "case"
                    ],
                    "properties": {
                      "self": {
                        "type": "string"
                      },
                      "case": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "schemaVersion",
            "caseId",
            "attempts",
            "operations"
          ],
          "properties": {
            "schemaVersion": {
              "type": "string",
              "const": "partner-settlement-attempt-list-v2"
            },
            "caseId": {
              "type": "string"
            },
            "attempts": {
              "type": "array",
              "items": {
                "$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"
                  }
                }
              }
            },
            "operations": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/PartnerSettlementOperation",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "schemaVersion",
                  "id",
                  "operationKey",
                  "providerIdempotencyKey",
                  "partnerId",
                  "caseId",
                  "bindingId",
                  "bindingDigest",
                  "dispositionId",
                  "awardRevision",
                  "awardHash",
                  "outcomeCode",
                  "action",
                  "amountMinorUnits",
                  "allocations",
                  "currency",
                  "adapter",
                  "externalReference",
                  "status",
                  "createdAt",
                  "updatedAt"
                ],
                "properties": {
                  "schemaVersion": {
                    "type": "string",
                    "const": "partner-settlement-operation-v2"
                  },
                  "id": {
                    "type": "string"
                  },
                  "operationKey": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  },
                  "providerIdempotencyKey": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  },
                  "partnerId": {
                    "type": "string"
                  },
                  "caseId": {
                    "type": "string"
                  },
                  "bindingId": {
                    "type": "string"
                  },
                  "bindingDigest": {
                    "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"
                  },
                  "adapter": {
                    "type": "string"
                  },
                  "externalReference": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "prepared",
                      "submitting",
                      "unknown_outcome",
                      "manual_action_required",
                      "callback_required",
                      "completed",
                      "failed",
                      "blocked"
                    ]
                  },
                  "adapterReceipt": {
                    "type": "object",
                    "additionalProperties": {
                      "type": "string"
                    }
                  },
                  "failureCode": {
                    "type": "string"
                  },
                  "createdAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "updatedAt": {
                    "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": {
    "caseId": "pcase_test_123",
    "executions": [
      {
        "id": "id_test",
        "caseId": "pcase_test_123",
        "awardId": "awardId_test",
        "awardHash": "awardHash_test",
        "mode": "partner_executed",
        "status": "decision_delivered",
        "paymentConfirmed": false,
        "executedBy": "partner",
        "receipt": {
          "adapter": "adapter_test",
          "action": "capture",
          "txHashes": [
            "txHashes_test"
          ],
          "at": "2026-08-09T12:00:00.000Z"
        },
        "reports": [
          {
            "id": "id_test",
            "by": "claimant",
            "description": "description_test",
            "reportedAt": "2026-08-09T12:00:00.000Z",
            "responses": [
              {
                "by": "claimant",
                "status": "acknowledged",
                "at": "2026-08-09T12:00:00.000Z"
              }
            ]
          }
        ],
        "links": {
          "self": "self_test",
          "case": "case_test"
        }
      }
    ]
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.