Skip to main content
To redeem, send side: "sell" with the holding and optionally the number of units (default: everything):
Request
Response (sandbox)

What the fields mean

  • amount on a sell is the indicative value at creation: units times the bid price, or units times the price paid when there is no bid.
  • proceeds is what was actually credited, known at completion.
  • customer is inherited from the holding’s original buy.

Rules

  • Units are reserved while the sell is pending: a second sell can only take what is left (400 units_unavailable with available and requested).
  • Live sells wait in pending_fulfilment while Ladder redeems; cancel or rejection releases the units and moves no money.
  • Completion credits sell_proceeds to the wallet exactly once and shrinks or closes the holding (status: closed when nothing is left).
  • Selling needs an active holding (409 holding_not_active) that is yours (404 holding_not_found).
  • A sell never consumes the investment’s partner allocation.
GET /orders?side=sell lists them separately from buys.