v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Rewards

Withdraw

Withdraws from an earn position. The amount is the net amount you receive — the platform grosses up the redemption so the fee is taken from realized yield only. Pass "max" to fully exit (closes the position). Asynchronous — returns a PENDING transaction; completion is delivered via webhook.

Body Parameters

Key	Required	Type	Description
assetId	true	string (UUID)	The asset to withdraw.
amount	true	string	Net amount to withdraw, or "max" for a full exit.
type	false	string	Strategy class: regulated or defi.
address	false	string	External destination address. Omit to credit the signer (master wallet or sub-address).
reference	false	string	Client reference.
metadata	false	object	Custom metadata.
addressId	false	string (UUID)	Scope the operation to a sub-address. Omit to act on the master wallet.

post/v1/wallets/{walletId}/rewards/withdraw

Request body

assetIdstring

amountstring

typestring

addressstring

referencestring

metadataobject

addressIdstring

Example request

{
  "assetId": "WALLET_ASSET_ID",
  "amount": "NET_AMOUNT_TO_WITHDRAW",
  "type": "defi",
  "address": "OPTIONAL_EXTERNAL_ADDRESS",
  "reference": "OPTIONAL_REFERENCE",
  "metadata": {},
  "addressId": "OPTIONAL_SUB_ADDRESS_ID"
}

Response

object required