Corgi BankDocumentation
OpenAPI

Capture current agency claims with actual ledger evidence and unknown interest kept explicit

GET/deposit-placement-snapshot

Placement staff/service read scope required. Current watched snapshot retains source controls/positions, actual outbound accounting journal, signed receiving-bank interest and explicit unknown/exception fields. Off-bank claims remain distinct from original-bank deposits and bank-owned investments. No historical reconstruction is claimed.

Returns

200 OK

blockersarray of stringsRequired
captured_atstring · date-timeRequired
observation_datestring · dateRequired

A business date, YYYY-MM-DD

positionsarray of objectsRequired
8 child attributes
blockersarray of stringsRequired
interest_as_ofstring · date or nullOptional

A business date, YYYY-MM-DD

observed_accrued_interest_amountinteger or nullOptional
off_bank_principal_amountinteger or nullOptional
outbound_journalobjectOptional
placementobjectRequired
25 child attributes
accounting_plan_sha256stringOptional
accounting_plansarray of objectsOptional
7 child attributes
correction_reasonstringOptional
created_atstring · date-timeRequired
journalobjectRequired

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

journal_keystringRequired
journal_sha256stringRequired
receipt_sha256stringRequired
supersedes_sha256stringOptional
actorstringRequired
capacityobjectRequired
8 child attributes
actorstringRequired
capacityobject or nullOptional
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
idstringRequired
kindstringRequired
programobject or nullOptional
cash_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_atstring · date-timeRequired
customer_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
exceptionsarray of stringsRequired
idstringRequired
instructionobject or nullOptional

Instruction is an immutable, authorized bridge command. Reading a draft is not dispatch.

22 child attributes
agency_titlestringRequired
annual_rate_bpsintegerRequired
capacitystringRequired
currency_codestringRequired
external_account_referencestringOptional
fdic_certificatestringRequired
idstringRequired
interest_basisstringRequired
issued_atstring · date-timeRequired
maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

operationstringRequired
owner_idstringRequired
placement_idstringRequired
principal_amountintegerRequired
productstringRequired
program_idstringRequired
program_sha256stringRequired
receiver_referencestringRequired
routing_numberstringRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

sha256stringRequired
standing_authorization_sha256stringOptional
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

latest_statementobject or nullOptional

Statement is the receiving bank's signed principal and accrued-interest observation for an existing allocation. It is not a funds-transfer receipt.

16 child attributes
accrued_interest_amountintegerRequired
as_ofstring · dateRequired

A business date, YYYY-MM-DD

capacitystringRequired
evidencestring · byteRequired
evidence_formatstringRequired
evidence_sha256stringRequired
external_account_referencestringRequired
fdic_certificatestringRequired
key_idstringRequired
observed_atstring · date-timeRequired
original_instruction_sha256stringRequired
owner_idstringRequired
placement_idstringRequired
principal_amountintegerRequired
signaturestringRequired
versionstringRequired
posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

prior_redemptionsarray of objectsOptional
13 child attributes
accounting_plan_sha256stringOptional
accounting_plansarray of objectsOptional
actorstringRequired
created_atstring · date-timeRequired
idstringRequired
idempotency_keystringRequired
instructionobjectRequired

Instruction is an immutable, authorized bridge command. Reading a draft is not dispatch.

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

receiptobject or nullOptional

Receipt is signed by a key in the independently approved retained program. Evidence retains the receiving-bank allocation and actual settlement confirmation, not an ACK.

request_sha256stringRequired
statusstringRequired
sweep_authorizationobject or nullOptional

Generated Placement.Actor and Redemption.Actor retain Mandate.Consent.Actor, the real authorizing customer. Run.Actor and persistence events identify the actual executing bridge; callers must never synthesize customer claims or a fresh human approval to execute this retained standing authority.

programobjectRequired
8 child attributes
actorstringRequired
capacityobject or nullOptional
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
idstringRequired
kindstringRequired
programobject or nullOptional
receiptobject or nullOptional

Receipt is signed by a key in the independently approved retained program. Evidence retains the receiving-bank allocation and actual settlement confirmation, not an ACK.

19 child attributes
capacitystringRequired
currency_codestringRequired
evidencestring · byteRequired
evidence_formatstringRequired
evidence_sha256stringRequired
external_account_referencestringRequired
fdic_certificatestringRequired
instruction_sha256stringRequired
interest_amountintegerRequired
key_idstringRequired
observed_atstring · date-timeRequired
operationstringRequired
owner_idstringRequired
principal_amountintegerRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

settlement_referencestringRequired
signaturestringRequired
statusstringRequired
versionstringRequired
redemptionobject or nullOptional
13 child attributes
accounting_plan_sha256stringOptional
accounting_plansarray of objectsOptional
actorstringRequired
created_atstring · date-timeRequired
idstringRequired
idempotency_keystringRequired
instructionobjectRequired

Instruction is an immutable, authorized bridge command. Reading a draft is not dispatch.

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

receiptobject or nullOptional

Receipt is signed by a key in the independently approved retained program. Evidence retains the receiving-bank allocation and actual settlement confirmation, not an ACK.

request_sha256stringRequired
statusstringRequired
sweep_authorizationobject or nullOptional

Generated Placement.Actor and Redemption.Actor retain Mandate.Consent.Actor, the real authorizing customer. Run.Actor and persistence events identify the actual executing bridge; callers must never synthesize customer claims or a fresh human approval to execute this retained standing authority.

requestobjectRequired
9 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

agency_consentbooleanRequired
amountintegerRequired
capacity_idstringRequired
currency_codestringRequired
disclosure_sha256stringRequired
program_idstringRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

standing_authorization_sha256stringOptional
request_sha256stringRequired
screening_atstring · date-time or nullOptional
screening_idsarray of stringsOptional
sourceobjectRequired
6 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

captured_atstring · date-timeRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

owner_idstringRequired
ownership_revisionintegerRequired
ownership_sha256stringRequired
statusstringRequired
sweep_authorizationobject or nullOptional

Generated Placement.Actor and Redemption.Actor retain Mandate.Consent.Actor, the real authorizing customer. Run.Actor and persistence events identify the actual executing bridge; callers must never synthesize customer claims or a fresh human approval to execute this retained standing authority.

5 child attributes
bridge_subjectstringRequired
mandateobjectRequired
runobjectRequired

The full run is independently durable. Its exact source and deterministic selection must be reverified by the application before issuing or claiming.

sha256stringRequired
versionstringRequired
redemption_journalobjectOptional
reserved_insurance_headroomintegerRequired
readybooleanRequired
source_sha256stringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close