Corgi BankDocumentation
OpenAPI

The Bank Repo object

Bank borrowing secured by full settled bank-owned AFS Treasury lots with separate actual funding, repayment and original-custodian pledge/release evidence.

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.

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
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.

4 child attributes
content_sha256stringRequired
customer_sha256stringRequired
observed_atstring · date-timeRequired
recordobjectRequired
13 child attributes
collateralobject or nullOptional

CollateralAdjustmentRequest adds cash to an existing commitment's collateral. Amount is the additional pledge, not a replacement for the original pledge.

content_sha256stringRequired
customer_sha256stringOptional
customer_snapshotobjectOptional
decisionobject or nullOptional
idstringRequired
kindstringRequired
planobject or nullOptional
policyobject or nullOptional
proposed_atstring · date-timeRequired
proposed_bystringRequired
registryobject or nullOptional
releaseobject or nullOptional
cancellationobject or nullOptional
3 child attributes
actorstringRequired
atstring · date-timeRequired
reasonstringRequired
collateralarray of objectsRequired
3 child attributes
custody_accountobjectRequired
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
custody_accountobject or nullOptional
18 child attributes
bank_ownedbooleanRequired
custodian_referencestringRequired
enabledbooleanRequired
exclusive_core_instructionsbooleanRequired
external_account_referencestringRequired
key_idstringRequired
legal_entitystringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

no_third_party_lienbooleanRequired
observed_atstring · date-timeRequired
onboardingobjectRequired
opening_inventory_emptybooleanRequired
ownershipobjectRequired
program_idstringRequired
program_sha256stringRequired
signaturestringRequired
valid_untilstring · date-timeRequired
versionstringRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
idstringRequired
instrumentobject or nullOptional
16 child attributes
currency_codestringRequired
cusipstringRequired
eligibilityobjectRequired
enabledbooleanRequired
face_value_amountintegerRequired

Cents per whole unit

issue_datestring · dateRequired

A business date, YYYY-MM-DD

kindstringRequired

Treasury_bill

maturity_datestring · dateRequired

A business date, YYYY-MM-DD

namestringRequired
price_scaleintegerRequired
program_idstringRequired
termsobjectRequired
unit_basisstringRequired

Face_100_usd

unit_incrementintegerRequired
unit_scaleintegerRequired
zero_couponboolean or nullOptional
kindstringRequired
programobject or nullOptional
20 child attributes
authorityobjectRequired
bridge_subjectstringRequired
broker_namestringRequired
broker_referencestringRequired
custodian_namestringRequired
custodian_referencestringRequired
custody_agreementobjectRequired
dealersarray of objectsRequired
enabledbooleanRequired
evidence_keysobjectRequired
legal_entitystringRequired
master_cash_external_account_referencestringRequired
master_cash_identityobjectRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_order_amountintegerRequired
policyobjectRequired
providerstringRequired
trading_agreementobjectRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

lotobjectRequired
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

observationobjectRequired
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
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
content_sha256stringRequired
created_atstring · date-timeRequired
custody_proofsarray of objectsRequired
13 child attributes
evidenceobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
instruction_sha256stringRequired
key_idstringRequired
lot_idstringRequired
observationobjectRequired
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
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
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
cash_referencestringRequired
confirmationobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
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
11 child attributes
cusipstringRequired
custody_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

custody_account_sha256stringRequired
external_account_referencestringRequired
lot_idstringRequired
lot_revisionintegerRequired
observation_sha256stringRequired
original_program_idstringRequired
original_program_sha256stringRequired
original_settlement_sha256stringRequired
unitsintegerRequired
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
6 child attributes
day_countstringRequired
maturity_datestring · dateRequired

A business date, YYYY-MM-DD

principal_amountintegerRequired
rate_bpsintegerRequired
roundingstringRequired
start_datestring · dateRequired

A business date, YYYY-MM-DD

sha256stringRequired
transaction_idstringRequired
versionstringRequired
programobjectRequired
7 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
idstringRequired
kindstringRequired

Program

programobject or nullOptional
23 child attributes
agreementobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
authorityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
cash_bridge_subjectstringRequired
cash_evidence_keysobjectRequired
custodian_referencestringRequired
custody_bridge_subjectstringRequired
custody_providerstringRequired
enabledbooleanRequired
haircut_bpsintegerRequired
intermediariesarray of objectsRequired
4 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

external_referencestringRequired
identityobjectRequired
legal_namestringRequired
legal_entitystringRequired
lenderobjectRequired
4 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

external_referencestringRequired
identityobjectRequired
legal_namestringRequired
master_cash_external_account_referencestringRequired
master_cash_identityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_excess_collateral_amountintegerRequired
max_principal_amountintegerRequired
max_rate_bpsintegerRequired
max_term_daysintegerRequired
providerstringRequired
termsobjectRequired

Terms are reviewed contract requirements. True/false assertions alone cannot establish their legal enforceability; the retained opinions and agreement do.

18 child attributes
accountingstringRequired

Secured_borrowing

accounting_opinionobjectRequired
automatic_renewalboolean or nullOptional
bank_entitled_and_obligatedboolean or nullOptional
concurrent_repurchase_agreementboolean or nullOptional
counterparty_may_reuseboolean or nullOptional
day_countstringRequired

Actual_360 or actual_365

default_policystringRequired

Preserve_obligation_governed_resolution

default_proceduresobjectRequired
early_terminationboolean or nullOptional
enforceability_opinionobjectRequired
floating_rateboolean or nullOptional
margin_policystringRequired

Daily_two_sided_review

margin_proceduresobjectRequired
roundingstringRequired

Cumulative_half_up_cent

same_securities_returnboolean or nullOptional
segregated_collateralboolean or nullOptional
substitutionboolean or nullOptional
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

repaymentobject or nullOptional
24 child attributes
cash_evidenceobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
cash_referencestringRequired
confirmationobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
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
2 child attributes
referencestringRequired
sha256stringRequired
program_idstringRequired
rate_bpsintegerRequired
rationalestringRequired
start_datestring · dateRequired

A business date, YYYY-MM-DD

request_sha256stringRequired
statusstringRequired

to move to open esc to close