Complete A Flagged Deposit With A Resolution Fee
Changed onReleases a deposit that was flagged only because it fell below the asset's minimum, by paying the resolution fee out of the deposit itself.
Breet deducts the asset's flagFeeUSD from the USD value actually received, converts the remainder at the current rate, credits your wallet, and fires trade.completed with flagFeeUSD populated. If auto-settlement is enabled on the address, the net amount is paid out to the linked bank account as usual.
Only deposits with status: "flagged" and passAMLCheck: true are eligible — a deposit flagged by an AML check cannot be resolved this way. The remainder after the fee must be greater than $1; when it is not, the only route is a top-up to the same address in the same asset. The call is a no-op after the deposit is credited, so a retry on an already-resolved deposit returns 404.
Read flagFeeUSD per asset from GET /trades/assets before calling, and see Deposits for the full flow.
Request
- Base URLhttps://api.breet.io/v1
- AuthAPI key in header x-app-id and API key in header x-app-secret and API key in header X-Breet-Env
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID of the flagged deposit (the id on the trade.flagged webhook payload).
Response
Deposit resolved, wallet credited
Changes
- info
endpoint added
- info