Accounts

Get deposit instructions

Changed on

Retrieve deposit instructions for a given account, share class, and subscription currency.

Returns a list of virtual bank accounts, each with its supported payment rails. An empty list means the share class cannot be funded by bank transfer in subscriptionCurrency on this account: the account has no active line on the share class, no virtual bank account is provisioned, or the share class does not accept deposits in that currency.

When subscriptionCurrency differs from the share class currency, the deposit is routed in one of two ways depending on the fund:

  • Share classes listing subscriptionCurrency in their intermediaryShareClasses (for example USTBL and UKTBL in EUR): the virtual IBAN is provisioned on the account's line on the requested share class itself, so no line on the intermediary share class is needed.
  • SAFO share classes: the instructions point to the investor's virtual bank account on the share class of the same fund denominated in subscriptionCurrency (a SAFOd deposit in EUR is funded through the eurSAFOd virtual IBAN). The request fails with NoDepositAccountInCurrencyError (422) when that share class is not available to the distributor, or when the account has no virtual IBAN on it.

Each entry includes payment informations and supported rails:

  • SCT / SCT Instant - SEPA Credit Transfer (EUR)
  • Faster Payments / CHAPS / BACS - UK local transfers (GBP); also includes gbpLocalDetails with sort code and account number
  • SWIFT - international wire

The response also lists stablecoin deposit accounts under stablecoinDepositAccounts: one deposit address per supported network, provisioned on demand the first time instructions are requested. Each address accepts every stablecoin listed in its stablecoins field (independent of subscriptionCurrency); sending a supported stablecoin to it automatically creates and funds a subscription. An empty list means stablecoin deposits are not available for this account and share class (the feature requires an organization, or an individual with a tax identification number on file, on supported share classes).

get/v0/accounts/{accountId}/deposit-instructions

Request

Path parameters

accountIdstring uuid required

a Universally Unique Identifier

Query parameters

shareClassIdstring uuid required

a Universally Unique Identifier

subscriptionCurrency'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK' required

a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"

Response

Success

shareClassCurrency'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK' required

a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"

Changes

    • info

      removed the Banking Circle enum value from the // response property for the response status

    • info

      removed the CACEIS enum value from the // response property for the response status

    • info

      removed the HSBC enum value from the // response property for the response status

    • info

      removed the Memo Bank enum value from the // response property for the response status