DEVELOPER DOCUMENTATION
Fund Milestone
Request escrow funding for an unfunded milestone — returns a pending approval a human must co-sign before money moves.
/api/public/v1/milestones/{milestoneId}/fundRequests escrow funding for a NOT_FUNDED milestone. This call never moves money. It records a pending approval (type: "milestone_fund") and returns 202; a signed-in human must open approval.approvalUrl and confirm in the OpenTrain app before the milestone is funded. Approvals expire after ~72 hours.
Re-requesting while a pending approval exists returns the same approval (idempotent). Learn the outcome by polling GET /approvals/{id} or watching for the approval.confirmed event on GET /updates. The request has no body. Funding is drawn per the account’s billing setup — see credits & billing.
Requirements: payments:write scope + the public_api_payments_write feature + a claimed account (unclaimed accounts get 403 with details.reason: "account_claim_required" and a claimUrl) + a payment method on file (409 with details.reason: "payment_method_required" otherwise).
Request
Section titled “Request”milestoneIdstringpathrequiredThe milestone to fund. Must be NOT_FUNDED, not cancelled, on an active contract you own.
Response
Section titled “Response”Returns 202 — the request is recorded, nothing has been charged yet.
approvalobjectThe pending approval, in the same shape as GET /approvals/{id}: {id, type: "milestone_fund", status: "pending", contractId, milestoneId, jobId, proposalId: null, approvalUrl, expiresAt, resolvedAt, result, createdAt}.
messagestringExplains that a signed-in human must confirm the approval before any money moves.
Errors
Section titled “Errors”| Status | code | Meaning |
|---|---|---|
401 | UNAUTHORIZED | Missing or invalid token |
403 | FORBIDDEN | Missing payments:write scope, public_api_payments_write disabled, or account not claimed (details.reason: "account_claim_required", details.claimUrl) |
404 | NOT_FOUND | No such milestone, or its contract is on another account |
409 | CONFLICT | See the reason catalog below |
409 reason catalog
Section titled “409 reason catalog”details.reason | Meaning | Extra details fields |
|---|---|---|
milestone_not_fundable | Milestone is not NOT_FUNDED (e.g. already funded) | status |
payment_method_required | No payment method on file; a human must add a card in the OpenTrain app | billingUrl |
milestone_cancelled | Milestone has been cancelled | — |
contract_ended | The contract has ended | contractId |