Claim settled fees for a provision

post/dex/provisions/{boxId}/claimapi_key

Pay out a provision's settled fees without changing its size. The provision gets a new box id — use successorBoxId from the response next. The body is optional.

Path parameters

boxIdstringrequired
UTXO id of the provision box

Request body

LDClaimRequest · application/json

expectedVaultBoxIdstring
The vault box this was quoted against
expectedProvisionBoxIdstring
The provision box this was quoted against
minAmountXstring
Least you will accept on the ERG side. Decimal string.
minAmountYstring
The same on the token side. Decimal string.

Responses

200Result of the claim transactionLDClaimResult▶

outcomestringrequired
Node submission outcome; uncertain retains the known transaction ID and input ownership.
one ofacceptedrejecteduncertain
claimedXstringrequired
nanoERG paid out of the vault. Decimal string.
claimedYstringrequired
Raw token units paid out of the vault. Decimal string.
successorBoxIdstringrequired
New provision box id. Use it for the next request.
txIdstringrequired

400Nothing to settle for this provision.ApiError▶

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

404No live provision with that id.ApiError▶

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

409The vault or provision moved. Re-read and try again.LDStateChangedResponse▶

errorintegerrequired
reasonstringrequired
detailstringrequired
What moved, and what it moved to
poolBoxIdstring
Current pool box id
vaultBoxIdstring
Current vault box id
provisionBoxIdstring
Current provision box id

422Settles less than the given bounds, or the vault cannot cover it.ApiError▶

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

503Node or wallet unavailable. Retry.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

← PreviousList liquidity provisions Next →Quote a provision resize