Quote settling a position
/forwards/positions/{boxId}/settle/checkWhat settling a position now pays each side and the builder. Any position can be settled by anyone once its window's last epoch is recorded. No body.
Path parameters
boxIdstringrequiredPosition box id, as listed by
GET /forwards/positions.
Responses
200Quote for the settlementDFSettleQuote▶
boxIdstringrequiredrefundbooleanrequiredWhether the window has left the accumulator, so each side gets its margin back.
recordsbooleanrequiredWhether the settlement also records the current epoch, which adds 5 LIT to the reward.
owedLongstringrequiredowedShortstringrequiredrewardLitstringrequiredLIT base units this wallet receives for building the settlement.
networkFeestringrequired
404No unspent position has that id.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
422The window's last epoch is not recorded yet, or no accumulator is deployed.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503Node unavailable, or the accumulator could not be read. Retry.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
defaultErrorApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description