AUM Fee API reference

The aum-fee token feature accrues an annual management fee against time-weighted supply. Use this page as the endpoint reference. See Configure and operate AUM Fee for the task flow, and AUM Fee architecture for the canonical model, dilution mechanics, and events.

Configuration during token creation

{
  "aum-fee": {
    "feeBps": 200,
    "recipient": "0x..."
  }
}

Reading accrued fees

GET /api/v2/tokens/{tokenAddress}/aum-fee/accrued-estimate

Returns the current accrued-fee estimate in token units, the configured annual rate, the last collection time, the measurement time, and the address of the attached feature contract. The response data is null when your token has no attached and initialised AUM Fee feature.

Collecting accrued fees

POST /api/v2/tokens/{tokenAddress}/features/aum-fee/collections

Queues an async blockchain mutation that calls the AUM Fee collection flow. Collection mints newly issued token units to the configured recipient. It does not transfer existing treasury tokens.

Updating parameters

Update each governance-controlled parameter through its own endpoint. The platform blocks these calls after you freeze the rate and recipient.

PATCH /api/v2/tokens/{tokenAddress}/features/aum-fee/bps
PATCH /api/v2/tokens/{tokenAddress}/features/aum-fee/recipient
POST /api/v2/tokens/{tokenAddress}/features/aum-fee/rate-freezes

Collect before you change the rate or recipient when the accounting period needs a clean cut-off. The next estimate and collection use the current configuration against elapsed time since the last collection.

Listing collection events

GET /api/v2/tokens/{tokenAddress}/aum-fee/collection-events

Returns indexed AUMFeeCollected events for the attached feature. The collection supports DataTable filtering, sorting, and pagination. Useful response fields include collector, recipient, feeAmount, feeAmountExact, eventTimestamp, blockNumber, blockTimestamp, txHash, and logIndex. Filter and sort collections by collectedAt, blockNumber, collector, recipient, and feeAmount.

Related

• AUM Fee operator guide
• AUM Fee architecture
• Funds use case
• Token lifecycle