Corgi BankDocumentation
OpenAPI

The Bank Repo Snapshot object

Snapshot retains a current observation and the requested accounting date separately. It does not reconstruct historical custody or external cash.

Attributes

blockersarray of stringsRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

captured_atstring · date-timeRequired
cash_evidencearray of objectsRequired
8 child attributes
actual_datestring · dateRequired

A business date, YYYY-MM-DD

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired
proofobjectRequired
7 child attributes
journalobjectRequired
6 child attributes
delta_amountintegerRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

idstringRequired
sha256stringRequired
source_referencestringRequired
source_servicestringRequired
line_keystringRequired
match_idstringRequired
readybooleanRequired
statement_datestring · dateRequired

A business date, YYYY-MM-DD

statement_idstringRequired
statement_sha256stringRequired
readybooleanRequired
receipt_sha256stringRequired
signed_delta_amountintegerRequired
source_idstringRequired
content_sha256stringRequired
counterparty_checksarray of objectsRequired
3 child attributes
admissionobjectRequired
2 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

observationobjectRequired

RegistryObservation is a current read of the latest independently reviewed classification and the customer's unchanged authoritative identity source. It is an observation, not a distributed fence on later ownership changes.

4 child attributes
content_sha256stringRequired
customer_sha256stringRequired
observed_atstring · date-timeRequired
recordobjectRequired
stagestringRequired
transaction_idstringRequired
idstringRequired
journalsarray of objectsRequired
8 child attributes
approved_bystringRequired
committed_atstring · date-timeRequired
idstringRequired
idempotency_keystringRequired
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_sha256stringRequired
posted_bystringRequired
posting_datestring · dateRequired

A business date, YYYY-MM-DD

legal_entitystringRequired
managed_accountsarray of objectsRequired
7 child attributes
gl_codestringRequired
held_amountintegerRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

normal_balancestringRequired
posted_amountintegerRequired
purposestringRequired
source_idstringRequired
observation_datestring · dateRequired

A business date, YYYY-MM-DD

positionsarray of objectsRequired
4 child attributes
coverageobject or nullOptional
7 child attributes
adjusted_collateral_amountintegerRequired
blockersarray of stringsRequired
excess_amountintegerRequired
fair_value_amountintegerRequired
readybooleanRequired
required_amountintegerRequired
shortfall_amountintegerRequired
current_lotsarray of objectsRequired
33 child attributes
accrued_to_datestring · date or nullOptional

Exclusive start boundary; closing D requires D+1

actual_proceeds_amountinteger or nullOptional
cash_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

disposal_cash_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

disposal_datestring · date or nullOptional

A business date, YYYY-MM-DD

disposal_execution_sha256stringOptional
disposal_order_idstringOptional
disposal_settlement_datestring · date or nullOptional

A business date, YYYY-MM-DD

disposal_settlement_sha256stringOptional
disposal_trade_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

exceptionsarray of stringsRequired
execution_sha256stringRequired
external_account_referencestringRequired
idstringRequired
instrumentobjectRequired
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
custody_accountobject or nullOptional
decisionobject or nullOptional
idstringRequired
instrumentobject or nullOptional
kindstringRequired
programobject or nullOptional
latest_observationobject or nullOptional
23 child attributes
accrued_income_amountinteger or nullOptional
as_ofstring · dateRequired

A business date, YYYY-MM-DD

close_out_completebooleanRequired
currency_codestringRequired
cusipstringRequired
custodian_referencestringRequired
encumbered_unitsintegerRequired
evidenceobjectRequired
external_account_referencestringRequired
fair_value_amountinteger or nullOptional

Actual custody units at supplied price

key_idstringRequired
legal_entitystringRequired
lot_idstringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

observed_atstring · date-timeRequired
original_execution_sha256stringRequired
original_settlement_sha256stringOptional
priceinteger or nullOptional
price_basisstringOptional

Optional actual bid/ask/mid/last source; repo requires bid

signaturestringRequired
unitsintegerRequired

Actual custodian quantity, distinct from trade-date book quantity

valuation_basisstringOptional

Intraday uses start of AsOf; day_close uses start of AsOf+1

versionstringRequired
latest_valuationobject or nullOptional
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
idstringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

requestobjectRequired
resultobjectRequired
legal_entitystringRequired
original_cost_amountintegerRequired
programobjectRequired
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
custody_accountobject or nullOptional
decisionobject or nullOptional
idstringRequired
instrumentobject or nullOptional
kindstringRequired
programobject or nullOptional
purchase_order_idstringRequired
redemption_idstringOptional
reservation_revisionintegerOptional
reserved_order_idstringOptional
reserved_redemption_idstringOptional
revisionintegerRequired
scheduleobjectRequired
5 child attributes
conventionstringRequired
cost_amountintegerRequired
face_amountintegerRequired
maturity_datestring · dateRequired

A business date, YYYY-MM-DD

start_datestring · dateRequired

A business date, YYYY-MM-DD

settlement_datestring · date or nullOptional

A business date, YYYY-MM-DD

settlement_sha256stringOptional
statusstringRequired

Unsettled, active, selling, sold_unsettled, sold, redeeming, redeemed, exception

trade_datestring · dateRequired

A business date, YYYY-MM-DD

trade_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

unitsintegerRequired

Original full quantity; disposition never rewrites it

reservationsarray of objectsRequired
2 child attributes
activebooleanRequired
reservationobjectRequired

Reservation is a ledger-owned exclusive sidecar. Revision is the fixed source revision at reservation, not the later mutable accounting revision.

9 child attributes
custody_proof_sha256stringOptional
instruction_sha256stringRequired
lot_idstringRequired
lot_revisionintegerRequired
original_settlement_sha256stringRequired
pledge_referencestringOptional
statestringRequired

Reserved, pledged, releasing, released

transaction_idstringRequired
unitsintegerRequired
transactionobjectRequired
23 child attributes
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.

journal_keystringRequired
journal_sha256stringRequired
supersedes_sha256stringOptional
accrued_to_datestring · date or nullOptional

Exclusive start boundary

actorstringRequired
admissionsarray of objectsRequired
2 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

observationobjectRequired

RegistryObservation is a current read of the latest independently reviewed classification and the customer's unchanged authoritative identity source. It is an observation, not a distributed fence on later ownership changes.

cancellationobject or nullOptional
3 child attributes
actorstringRequired
atstring · date-timeRequired
reasonstringRequired
collateralarray of objectsRequired
3 child attributes
custody_accountobjectRequired
lotobjectRequired
observationobjectRequired
content_sha256stringRequired
created_atstring · date-timeRequired
custody_proofsarray of objectsRequired
13 child attributes
evidenceobjectRequired
instruction_sha256stringRequired
key_idstringRequired
lot_idstringRequired
observationobjectRequired
observed_atstring · date-timeRequired
original_program_idstringRequired
original_program_sha256stringRequired
pledge_referencestringRequired
signaturestringRequired
statestringRequired

Pledged or released

transaction_idstringRequired
versionstringRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
exceptionsarray of stringsRequired
fundingobject or nullOptional
24 child attributes
cash_evidenceobjectRequired
cash_referencestringRequired
confirmationobjectRequired
currency_codestringRequired
fee_amountintegerRequired
instruction_sha256stringRequired
interest_amountintegerRequired
key_idstringRequired
legal_entitystringRequired
lender_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

lender_referencestringRequired
master_cash_external_account_referencestringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

master_cash_statement_line_referencestringRequired
master_cash_statement_referencestringRequired
net_cash_amountintegerRequired
observed_atstring · date-timeRequired
principal_amountintegerRequired
repayment_instruction_sha256stringOptional
settled_atstring · date-timeRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

signaturestringRequired
transaction_idstringRequired
versionstringRequired
funding_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired
instructionobject or nullOptional
18 child attributes
collateralarray of objectsRequired
content_sha256stringRequired
currency_codestringRequired
decision_sha256stringRequired
idstringRequired
issued_atstring · date-timeRequired
legal_entitystringRequired
lender_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

lender_referencestringRequired
master_cash_external_account_referencestringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

program_idstringRequired
program_sha256stringRequired
repurchase_amountintegerRequired
scheduleobjectRequired
sha256stringRequired
transaction_idstringRequired
versionstringRequired
programobjectRequired
7 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
idstringRequired
kindstringRequired

Program

programobject or nullOptional
repaymentobject or nullOptional
24 child attributes
cash_evidenceobjectRequired
cash_referencestringRequired
confirmationobjectRequired
currency_codestringRequired
fee_amountintegerRequired
instruction_sha256stringRequired
interest_amountintegerRequired
key_idstringRequired
legal_entitystringRequired
lender_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

lender_referencestringRequired
master_cash_external_account_referencestringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

master_cash_statement_line_referencestringRequired
master_cash_statement_referencestringRequired
net_cash_amountintegerRequired
observed_atstring · date-timeRequired
principal_amountintegerRequired
repayment_instruction_sha256stringOptional
settled_atstring · date-timeRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

signaturestringRequired
transaction_idstringRequired
versionstringRequired
repayment_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

repayment_instructionobject or nullOptional
17 child attributes
cash_amountintegerRequired
currency_codestringRequired
due_datestring · dateRequired

A business date, YYYY-MM-DD

funding_sha256stringRequired
hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

interest_amountintegerRequired
issued_atstring · date-timeRequired
legal_entitystringRequired
lender_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

lender_referencestringRequired
master_cash_external_account_referencestringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

original_instruction_sha256stringRequired
principal_amountintegerRequired
sha256stringRequired
transaction_idstringRequired
versionstringRequired
repayment_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

requestobjectRequired
10 child attributes
currency_codestringRequired
lot_idsarray of stringsRequired
maturity_datestring · dateRequired

A business date, YYYY-MM-DD

principal_amountintegerRequired
proceeds_beneficiary_customer_idsarray of stringsRequired
proceeds_useobjectRequired
program_idstringRequired
rate_bpsintegerRequired
rationalestringRequired
start_datestring · dateRequired

A business date, YYYY-MM-DD

request_sha256stringRequired
statusstringRequired
readybooleanRequired
versionstringRequired

to move to open esc to close