Request that all or part of a submitted election be withdrawn.
This is a request, not an instruction. It is created with
status: requested and is subject to approval by Clear Street
operations, which may reject it — the transfer agent may already have
acted on the election.
Set scope to full to withdraw the whole election, or to partial
and supply quantity to withdraw part of it. Exactly one of those two
shapes is accepted; there is no default.
Preconditions, all of which are published on the resources themselves:
- the offer permits withdrawals (
withdrawals_permittedon the offer); - the election has reached
ops-submitted(can_withdrawon the
election); - no earlier withdrawal on the same election is still open;
- for a partial,
quantityis a whole number no greater than the
election'sremaining_quantity.
A partial whose quantity equals remaining_quantity withdraws the whole
election, so it is recorded as scope: full and, once approved, moves
the election to client-withdrew. A larger quantity is rejected with
422 quantity-exceeds-election.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||