GETpartial

Read one execution and its receipts or performance reports

Read one execution and its receipts or performance reports.

/api/executions/{id}getAwardExecution

Authentication and authority

Use one listed account-session, scoped OAuth, or partner credential alternative. Account tokens retain the approving account’s authority. Cookie-authenticated writes require same-origin authorization. Alternatives are OR; schemes in one alternative are AND.

CanonicalPartnerBearer

CanonicalSession

AccountOAuth

Account tokens authorize only their approving account and case scope. S256 PKCE is mandatory on the code flow. Explicit reacceptance is required after Rules/disclosure changes.

Parameters

NameLocationRequirementSchema
idpathRequired{"type":"string"}

Responses

200

Authorized execution resource.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$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": "object",
              "additionalProperties": false,
              "required": [
                "adapter",
                "action",
                "txHashes",
                "at"
              ],
              "properties": {
                "adapter": {
                  "type": "string"
                },
                "action": {
                  "type": "string",
                  "enum": [
                    "capture",
                    "void",
                    "capture_partial",
                    "refund",
                    "refuse",
                    "complete",
                    "reject",
                    "distribute",
                    "partner_execute"
                  ]
                },
                "txHashes": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "at": {
                  "type": "string",
                  "format": "date-time"
                },
                "detail": {
                  "type": "string"
                },
                "provenance": {
                  "$ref": "#/components/schemas/ExecutionReceiptProvenance",
                  "type": "string",
                  "enum": [
                    "live",
                    "test",
                    "synthetic"
                  ],
                  "description": "Provider environment recorded by the engine. Missing historical provenance never confirms payment."
                }
              }
            },
            {
              "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",
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "by",
                    "status",
                    "at"
                  ],
                  "properties": {
                    "by": {
                      "type": "string",
                      "enum": [
                        "claimant",
                        "respondent"
                      ]
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "acknowledged",
                        "disputed"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    },
                    "at": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        },
        "attestation": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/ExecutionNonPerformanceAttestation",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "reason",
                "at"
              ],
              "properties": {
                "reason": {
                  "type": "string"
                },
                "at": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            {
              "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"
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

Authorization, validation, or execution conflict.

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",
    "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.