aum-fee
API reference for configuring the aum-fee token feature and reading or collecting accrued management fees through dapi endpoints.
The aum-fee token feature accrues a periodic management fee against outstanding supply, paid to a configured recipient. Configure during token creation. Read accrued fees and collect through the feature endpoints.
For the operator how-to, see AUM fee how-to. For the architecture model, see AUM fee architecture.
Configuration during token creation
{
"aum-fee": {
"feeBps": 200,
"recipient": "0x..."
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
feeBps | Integer | Yes | Annualised fee rate in basis points. 200 = 2.00% per year. |
recipient | Ethereum address | Yes | Wallet that receives the collected fee. |
Reading accrued fees
GET /api/v2/token/{address}/features/aum-feeReturns the running accrual since the last collection, plus the configured rate and recipient.
Collecting accrued fees
POST /api/v2/token/{address}/features/aum-fee/collectTransfers accrued tokens from the asset to the configured recipient. The platform queues the transfer as an async blockchain mutation.
Updating parameters
Restricted-mutable. Update through the asset's governance-update path:
PUT /api/v2/token/{address}/features/aum-fee
{
"feeBps": 150,
"recipient": "0x..."
}Updates apply forward; previously accrued amounts continue to settle at the previous rate to the previous recipient.
Related
fixed-treasury-yield
API reference for configuring the fixed-treasury-yield token feature and operating the holder claim, treasury top-up, and yield-withdraw endpoints through the fixed-yield-schedule addon.
transaction-fee
API reference for configuring the transaction-fee token feature so the platform deducts per-operation fees on chain for mint, burn, and transfer.