GETlive

List settlement attempts and business operations

List settlement attempts and business operations Compatibility alias. New Award execution commands use /api/cases/{id}/executions. The historical digest-bound input and response remain supported here. Its compatibility window has not started.

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

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"}

Responses

200

Immutable caller attempts and the authoritative business-operation journal.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "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"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "partner-settlement-attempt-list-v2",
    "caseId": "pcase_test_123",
    "attempts": [
      {
        "id": "id_test",
        "partnerId": "partner_test_123",
        "caseId": "pcase_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"
      }
    ],
    "operations": [
      {
        "schemaVersion": "partner-settlement-operation-v2",
        "id": "id_test",
        "operationKey": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "providerIdempotencyKey": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "partnerId": "partner_test_123",
        "caseId": "pcase_test_123",
        "bindingId": "bindingId_test",
        "bindingDigest": "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",
        "adapter": "adapter_test",
        "externalReference": "partner_reference_123",
        "status": "prepared",
        "createdAt": "2026-08-09T12:00:00.000Z",
        "updatedAt": "2026-08-09T12:00:00.000Z"
      }
    ]
  },
  "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.