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.
The fixed-treasury-yield token feature accrues a periodic yield per holder, claimable against a configured treasury. Configure during token creation. After deployment, the platform exposes addon endpoints for treasury top-up, holder claim, and operator withdraw under kit/dapi/src/routes/addons/fixed-yield-schedule/.
For the operator how-to, see Fixed treasury yield how-to. For the architecture model, see Fixed treasury yield architecture.
Configuration during token creation
{
"fixed-treasury-yield": {
"denominationAsset": "0x...",
"basisPerUnit": "1",
"treasury": "0x...",
"startDate": "2026-01-01",
"endDate": "2027-12-31",
"rate": 500,
"interval": "DAILY"
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
denominationAsset | Ethereum address | Yes | Token yield pays in. |
basisPerUnit | Decimal string | Yes | Unit-of-account the rate applies to. |
treasury | Ethereum address | Yes | Wallet the yield draws from. |
startDate | ISO 8601 date | Yes | When accrual begins. |
endDate | ISO 8601 date | Yes | When accrual stops. |
rate | Integer | Yes | Per-period rate in basis points. |
interval | Enum | Yes | DAILY, WEEKLY, MONTHLY. |
Addon endpoints
The fixed-yield-schedule addon exposes operations under /api/v2/addons/fixed-yield-schedule/{scheduleId}:
| Endpoint | Use it for |
|---|---|
POST .../create | Create a yield-schedule deployment (typically called by the Asset Designer during token creation). |
GET .../read | Read schedule state, including current accrued amount and coverage status. |
POST .../claim | Holder claims accrued yield. |
POST .../top-up | Operator funds the treasury with the denomination asset. |
POST .../withdraw | Operator withdraws unclaimed denomination asset (typically after endDate). |
See the schedule object in the read response for fields including treasury, denominationAsset, rate, accruedBalance, and coverageRatio.
Coverage monitoring
The schedule exposes a coverage ratio that signals whether the treasury holds enough denomination asset for all currently-accrued claims. Coverage below 1.0 means some holder claims will fail until top-up. Surface coverage in dashboards alongside the schedule's nextAccrualBlock.
Related
- Maturity redemption — often paired for coupon-paying bonds.
- Yield coverage statistics
- Blockchain monitoring