Corgi BankDocumentation
OpenAPI

The Investment Distribution object

Actual signed customer fund income or Treasury maturity evidence and retained cash accounting recovery state.

Attributes

accounting_plan_sha256stringOptional
accounting_plansarray of objectsOptional
7 child attributes
correction_reasonstringOptional
created_atstring · date-timeRequired
evidence_sha256stringRequired
journalobjectRequired

Journal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.

11 child attributes
adjusts_periodstringOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired
4 child attributes
amountintegerRequired
currency_codestringRequired
directionstringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired
protected_command_idstringRequired
reasonstringOptional
release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
reversal_ofstringOptional
source_refstringRequired
source_servicestringRequired
journal_keystringRequired
journal_sha256stringRequired
supersedes_sha256stringOptional
actorstringRequired
created_atstring · date-timeRequired
exceptionsarray of stringsRequired
idstringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

receiptobjectRequired

Distribution is actual external cash evidence. Neither a forecast dividend nor a reached Treasury maturity date authorizes a customer credit.

27 child attributes
cash_evidenceobjectRequired

Document retains the actual external bytes, not a mutable reference alone.

3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
cash_referencestringRequired
currency_codestringRequired
cusipstringRequired
custodian_referencestringRequired
custody_evidenceobjectRequired

Document retains the actual external bytes, not a mutable reference alone.

3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
external_account_referencestringRequired
fee_amountintegerRequired
gross_amountintegerRequired
idstringRequired
key_idstringRequired
kindstringRequired

Cash_distribution or maturity

lot_idstringRequired
lot_revisionintegerRequired
net_cash_amountintegerRequired
observed_atstring · date-timeRequired
original_settlement_sha256stringRequired
owner_idstringRequired
payment_datestring · dateRequired

A business date, YYYY-MM-DD

payment_referencestringRequired
record_datestring · dateRequired

A business date, YYYY-MM-DD

signaturestringRequired
tax_characterstringRequired

Explicit actual classification, including unknown

tax_evidenceobjectRequired

Document retains the actual external bytes, not a mutable reference alone.

3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
unitsintegerRequired

Original full lot; distribution does not remove units

versionstringRequired
withholding_amountintegerRequired
request_sha256stringRequired
resolutionsarray of objectsOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
statusstringRequired

to move to open esc to close