Corporate actions
Named catalog for cash dividends, bond coupons, bonus issues, rights issues, capital decreases, splits, and spin-offs.
The Corporate Actions catalog is one v2 collection:
/api/v2/tokens/{tokenAddress}/corporate-actions
type selects cashDividend, bondCoupon, bonusIssue, rightsIssue, capitalDecrease, stockSplit, or spinOff. stockSplit carries direction: forward | reverse.
What each type does
| Type | Mechanism | First-pass exclusions |
|---|---|---|
cashDividend | Declares and snapshots dividend-yield. Does not mint equity. Does not escrow denomination in a feature. | Claims stay on dividend-yield. |
bondCoupon | Names the attached fixed-treasury-yield program and completes on create. Preview and confirm return 409. | Top-up, allowance, and claim stay on the feature. |
bonusIssue | Snapshots holders and mints floor(balance × ratio). | No on-chain bonus event. No cash remainder. |
rightsIssue | Allotment mint, or pages an existing token-sale whitelist. | No sale create, rights instrument, nil-paid, or lapse. |
capitalDecrease | Burns announced snapshot amounts. | No legal ratio engine. No capital-account ledger. |
stockSplit | Chunked mint or burn of the ratio delta. | No atomic rebase. No market halt. Do not pause the token. |
spinOff | Mints an existing empty child to parent holders. | Child create stays POST /tokens. Parent balances do not change. |
Run lifecycle
POST /corporate-actions— create. Composition types persist asdrafted. A token accepts only one in-flight composition.POST .../{corporateActionId}/preview— store allocations. Cash-dividend preview does not queue a transaction.POST .../{corporateActionId}/confirm— apply the stored preview. One Idempotency-Key covers a holder book larger than one mint or burn batch. A 202 handle is not success.POST .../{corporateActionId}/abort— fence later chunks. Applied holders stay. There is no rollback.GETlist or get — reconstruct applied, skipped, and remaining holders.
completed requires every snapshot holder applied or stored as zero-after-floor. A compliance skip is aborted.
Token lifecycle API
How to sequence API calls for token creation, minting, transfers, burns, feature detach, and event reconciliation with safe idempotent retries.
Token creation progress stream API
Subscribe to a server-sent events stream that reports token-creation deployment progress for one async create request, then handle each phase event until the deployment completes or fails.