For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fund Escrow

Deposit funds into a deployed multi-release escrow, locking them until each milestone settles.

Builds the unsigned transaction that moves tokens from the funder's wallet into the escrow contract. Any wallet holding the escrow's trustline asset can fund; the signer is the wallet paying.

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

Endpoint

Fund the multi-release v2 escrow

post
Authorizations
x-api-keystringRequired
Body
contractIdstringRequired

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

Example: CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB
signerstringRequired

Wallet funding the escrow β€” signs the transaction.

Example: GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN
amountnumberRequired

Total amount to fund the escrow with, in human-readable decimals. Should equal the sum of milestone amounts.

Example: 750
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
post/escrow/multi-release/v2/fund
POST /escrow/multi-release/v2/fund HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "contractId": "CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB",
  "signer": "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN",
  "amount": 750
}
{
  "unsignedXdr": "AAAAAgAAAAAtWsgedQ...AAAAAQAAAAA=",
  "txHash": "b1946ac92492d2347c6235b4d2611184a8d53f7a8e6e9b4f0c79a2b30e5c4f3a",
  "contractId": "CAAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQC526"
}

Field notes

  • amount is in human token units and must be greater than zero.

  • Milestones release independently, but funding is against the escrow as a whole β€” fund enough to cover the milestones you expect to settle.

What this endpoint returns

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

Next steps

Last updated