banking.v1.AllocationsService

GetAllocation

Changed on

One allocation by service id. Readable by any authenticated user in any state — an investor holding units of a closed product still needs to render it — but a product whose effective level for the caller is hidden is NOT_FOUND, the same answer an unregistered slug gets, so the catalog cannot be probed for locked products. An AllocationManage holder reads any allocation.

post/banking.v1.AllocationsService/GetAllocation

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

servicestring

Response

Success

servicestring

the slug — the id used by every FundsService RPC

titlestring

display name ("EV Trading")

summarystring

one-line description for the catalog card

statestring

draft | open | closed

unit_capstring

authorised unit supply, decimal (default 100000000)

iconstring

Catalog glyph the client maps onto one of its SVGs. Presentation only. One of: fund | real_estate | trading | yield | venture | treasury | commodity | credit | index | arbitrage. Always populated on a response — fund is the default.

accessstring

The product's default access level: hidden | view | invest. What an investor with no grant holds. A registration lands on view.

caller_accessstring

The level the CALLER effectively holds — the higher of access and the caller's own grant, if any. Populated honestly for everyone, an AllocationManage holder included: their permission lets them read and administer the product, it does not make them an investor in it, so a manager's caller_access says what they would get as one. A client renders the card off access and the subscribe control off this — never off state alone.

backingstring

What stands behind the units: cash | in_kind. cash — the units were paid for into the fund's claim and a redemption pays out of it. in_kind — the units stand for an asset the holders own; the fund holds no cash for them, so Redeem is refused (FAILED_PRECONDITION) and holders exit through the book. Set to in_kind automatically by the first IssueUnits on the product; only SetAllocationBacking takes it back to cash. A registration lands on cash.

Changes