Deposit orders

Create deposit order

Create a new deposit order for an investor with the specified parameters.

  • Return order details, including wire instructions to fund the deposit.
  • A deposit in a currency other than the share class currency is funded through the investor's virtual IBAN on the share class of the same fund denominated in that currency (a SAFOd deposit in EUR is wired to the eurSAFOd virtual IBAN). The account must hold an active line on that share class; otherwise the request fails with NoDepositAccountInCurrencyError (422) and no order is created.
  • Set sendDepositInstructions to email the subscription form for this order to your distributor contact address.
  • sendDepositInstructions has no effect when authenticating with an investor JWT. Use the subscription form endpoint to retrieve the same document, with any authentication method.

Distribute-with-Spiko's-license distributors cannot place this order from their backend. The investor must place it directly from the browser with a short-lived Investor JWT, targeting the investor-scoped path POST /v0/investor/deposit-orders/ (identical payload and response, but authenticated with the investor JWT as bearer token instead of your API credentials).

post/v0/deposit-orders/

Request

Request body

investorIdstring uuid required

a Universally Unique Identifier

shareClassIdstring uuid required

a Universally Unique Identifier

accountIdstring uuid

a Universally Unique Identifier

Response

Success

idstring uuid required

a Universally Unique Identifier

investorIdstring uuid required

a Universally Unique Identifier

accountIdstring uuid required

a Universally Unique Identifier

shareClassIdstring uuid required

a Universally Unique Identifier

status'created' required
createdAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.