Release Milestone Funds

Release the funds of one or more approved milestones, signed by a release signer.

Builds the unsigned transaction where a release signer (roles.releaseSigners) releases the funds of specific milestones. Batch by design: pass the indexes of every approved milestone you want to settle in one transaction.

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

Endpoint

Release one or more milestones in batch

post

Multi-release V2 batches per-milestone releases — pass the indices to release. The contract returns errors from the dedicated ReleaseError enum.

Authorizations

x-api-keystringRequired

Body

contractIdstringRequired

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

Example: CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB

releaseSignerstringRequired

Release signer wallet — signs the transaction.

Example: GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN

milestoneIndexesnumber[]Required

Zero-based indexes of the milestones to release in this batch.

Example: [0,1]

Responses

200

Unsigned XDR built successfully.

application/json

unsignedXdrstringRequired

Base64-encoded unsigned XDR. Sign it with the appropriate wallet and submit to Soroban / Horizon to execute the operation on-chain.

Example: AAAAAgAAAAAtWsgedQ...AAAAAQAAAAA=

txHashstringRequired

SHA-256 hash of the prepared transaction. NOTE: it only matches the executed transaction if you sign the XDR exactly as returned — re-preparing (re-simulating) it changes the hash. Prefer contractId for correlation when present.

Example: b1946ac92492d2347c6235b4d2611184a8d53f7a8e6e9b4f0c79a2b30e5c4f3a

contractIdobject · nullableOptional

Deploys only: the address (C…) the new escrow contract WILL have once this transaction executes — known upfront because the service generates the deploy salt. Track your escrow with it (e.g. GET /escrows/:contractId) as soon as the transaction lands; it is stable even if your wallet/SDK re-prepares the transaction.

Example: CAAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQC526

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

post/escrow/multi-release/v2/release-funds

POST /escrow/multi-release/v2/release-funds HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "contractId": "CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB",
  "releaseSigner": "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN",
  "milestoneIndexes": [
    0,
    1
  ]
}

{
  "unsignedXdr": "AAAAAgAAAAAtWsgedQ...AAAAAQAAAAA=",
  "txHash": "b1946ac92492d2347c6235b4d2611184a8d53f7a8e6e9b4f0c79a2b30e5c4f3a",
  "contractId": "CAAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQC526"
}

Field notes

• Each milestone releases its own amount to roles.receiver; the rest of the escrow stays locked.

• A milestone must have reached its approvalsTarget and not be in dispute.

• Fees (Trustless Work + platformFee) are deducted on-chain per release.

• Indexes are zero-based, no duplicates in the batch.

What this endpoint returns

unsignedXdr + txHash — sign the XDR exactly as returned and submit it via Send Transaction.

Next steps

• Confirm the settlement and per-milestone txHash: GET /escrows/{contractId}