banking.v1.AllocationsService
Burn a holder's units with no cash leg (AllocationManage) — the reverse of IssueUnits: `units` leave the holder's account and the supply shrinks by the same amount. Nothing is paid; this is a cap-table correction, the way an in-kind mint was. The holder must have at least `units` AVAILABLE (Read-First; units resting on the book or reserved by a redemption do not count) — otherwise INVALID_ARGUMENT — and the allocation must be `closed`, because burning a holder's units out of a live product is a decision that deserves a closed door first; `force` is the explicit override for a live product (FAILED_PRECONDITION without it). Priced at the current (fresh) NAV for the record; the default `cost_basis` is `units × NAV`, the book value written off.
Answers a UnitIssuance with source = "retire" and POSITIVE units: the row is the magnitude, the source is the direction, and the console lists mints and retirements as one history. Idempotent by idempotency_key in the same key space as IssueUnits: the same key naming a mint and then a retirement is ALREADY_EXISTS, not a retry.
post/banking.v1.AllocationsService/RetireUnits
Request
- The document declares no server URL.
- Auth: none required
Headers
Connect-Protocol-Version1 required
Define the version of the Connect protocol
Connect-Timeout-Msnumber
Define the timeout, in ms
Request body
Response
Success
Changes
Changes to this operation have not been checked yet.