Get Escrow

Read an escrow state directly from the contract (authoritative).

Reads the escrow's state directly from the contract by invoking get_escrow on-chain — including per-milestone approvals, dispute and released flags. Authoritative; for lists and dashboards prefer the read-model endpoints.

The reference below is generated from the live API spec — if anything on this page disagrees with it, the reference wins.

Endpoint

Read the on-chain state of a deployed escrow

get

Invokes get_escrow directly on the child contract.

Authorizations

x-api-keystringRequired

Path parameters

contractIdstringRequired

Deployed multi-release-v2 escrow contract (C...).

Example: CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB

Responses

200

Escrow state read successfully.

application/json

typestringRequiredExample: multi-release

contractIdstringRequired

contractBaseIdstringRequired

engagementIdstringRequired

titlestringRequired

descriptionstringRequired

balancenumberRequired

Funded balance, 0 until first fund.

platformFeenumberRequired

Platform fee as percent.

receiverMemonumberRequired

400

Request body or query params fail schema validation (wrong type, missing required field, unknown property).

application/json

401

Missing, malformed, expired, revoked or invalid API key.

application/json

403

API key is valid but does not have the role required for this operation.

application/json

422

Payload is well-formed but a business rule rejects it (e.g. amount out of range, role not allowed for this user).

application/json

500

Unexpected server-side failure. Use the traceId to look up the incident in server logs or contact support.

application/json

get/escrow/multi-release/v2/{contractId}

GET /escrow/multi-release/v2/{contractId} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "type": "multi-release",
  "contractId": "text",
  "contractBaseId": "text",
  "engagementId": "text",
  "title": "text",
  "description": "text",
  "balance": 1,
  "platformFee": 1,
  "receiverMemo": 1,
  "trustline": {
    "address": "text",
    "contractId": "text",
    "symbol": "USDC"
  },
  "roles": {
    "approvers": [
      "text"
    ],
    "serviceProviders": [
      "text"
    ],
    "platform": "text",
    "releaseSigners": [
      "text"
    ],
    "disputeResolvers": [
      "text"
    ],
    "admin": "text",
    "observers": [
      "text"
    ]
  },
  "milestones": [
    {
      "description": "text",
      "status": "text",
      "evidence": "text",
      "approvals": {
        "target": 1,
        "approvalCount": 1,
        "approvedBy": [
          "text"
        ]
      },
      "amount": 1,
      "dispute": {
        "isDisputed": true,
        "reason": "text",
        "resolved": true
      },
      "released": true,
      "receiver": "text"
    }
  ]
}

Field notes

• Read-only: nothing to sign, nothing to submit.

• If the contract's storage has expired, the read fails with STELLAR_STATE_ARCHIVED — see Extend TTL for the restore flow.