Settle a position

post/forwards/positions/{boxId}/settleapi_key

Pay both sides of a position whose window has been recorded, recording the current epoch in the same transaction when it is due. The network fee comes out of the position; this wallet keeps the rewards, 5 LIT, or 10 LIT when the settlement also records. No body.

Path parameters

boxIdstringrequired
Position box id, as listed by GET /forwards/positions.

Responses

200Result of the settlementDFSettleResult▶

txIdstringrequired
outcomestringrequired
one ofacceptedrejecteduncertain
refundbooleanrequired
owedLongstringrequired
owedShortstringrequired
rewardLitstringrequired

403Missing or wrong api_keyApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

404No unspent position has that id.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

409An unconfirmed transaction already spends the position, or the accumulator's unconfirmed spends are contested or record an epoch that is over. Retry after the next block.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

422The window's last epoch is not recorded yet, or no accumulator is deployed.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

503Node, wallet or transaction engine unavailable, or the request ran out of time. The message says whether anything was sent. When it says the outcome is unknown, check this wallet's offers and positions before retrying.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

defaultErrorApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

← PreviousQuote settling a position Next →Wallet balances