Claim a provision's fees on any pool

post/dex/pools/{poolNft}/provisions/{boxId}/claimapi_key

Settles one of this wallet's provisions on the pool against the pool's vault, paying what the vault owes it. Needs the provision's ownerNFT in this wallet and a vault flushed since the provision last claimed. The provision gets a new box id, returned as successorBoxId. Open on every pool, whatever its genesis. The body is optional; every field bounds the claim.

Path parameters

poolNftstringrequired
The pool's NFT id, 64 hex characters
boxIdstringrequired
The provision box to settle

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

200The claimLDClaimResult▶

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

400The provision has nothing to settle until the pool is flushed, or the vault cannot pay what it is owed.ApiError▶

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

403Missing or wrong api_keyApiError▶

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

404No LithosDex pool with that NFT, or no live provision of the pool with that id.ApiError▶

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

409The vault or the provision moved since the quote, or another LithosDex mutation is running. Re-read and resend.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

422The claim pays less than a minimum, or this wallet does not hold the provision's ownerNFT.ApiError▶

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

503The pool index is still building, or the node or wallet did not answer. 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 your provisions on any pool Next →Check a flush on any pool