Deposit orders
Retarget deposit order
Move a funded deposit order to another share class of the same fund, before it is valued.
- Use this when an investor funded a deposit for one share class and wants the shares issued in another one - a different currency class of the same fund, typically.
- The order must be funded and not yet selected for execution. Once the daily execution has picked it up, retargeting is refused.
- The target share class must belong to the same fund as the current one, must be available to you, and the investor's account must not have a frozen or closed line for it. A line the account does not hold yet is opened as part of the re-target.
- Returns the updated order, with its new shareClassId.
Distribute-with-Spiko's-license distributors cannot re-target this order from their backend. The investor must do it directly from the browser with a short-lived Investor JWT, targeting the investor-scoped path PUT /v0/investor/deposit-orders/{id}/retarget (identical payload and response, but authenticated with the investor JWT as bearer token instead of your API credentials).
put/v0/deposit-orders/{id}/retarget
Request
- Base URLhttps://distributor-api.spiko.io
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
a Universally Unique Identifier
Request body
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.