Corgi BankDocumentation
OpenAPI

The Bank Securities Order object

Full bank-owned Treasury trade with separate trade-date accounting and actual signed cash/DVP 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
actorstringRequired
cash_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

cash_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

cash_posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

created_atstring · date-timeRequired
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
opening_inventory_emptybooleanRequired
ownershipobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
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
2 child attributes
referencestringRequired
sha256stringRequired
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
unit_basisstringRequired

Face_100_usd

unit_incrementintegerRequired
unit_scaleintegerRequired
zero_couponboolean or nullOptional
kindstringRequired
programobject or nullOptional
20 child attributes
authorityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bridge_subjectstringRequired
broker_namestringRequired
broker_referencestringRequired
custodian_namestringRequired
custodian_referencestringRequired
custody_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
dealersarray of objectsRequired
4 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

external_referencestringRequired
identityobjectRequired
legal_namestringRequired
enabledbooleanRequired
evidence_keysobjectRequired
legal_entitystringRequired
master_cash_external_account_referencestringRequired
master_cash_identityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_order_amountintegerRequired
policyobjectRequired
10 child attributes
accounting_evidenceobjectRequired
accrual_conventionstringRequired
acquisition_feesstringRequired

Capitalize_direct_acquisition_fees

cash_roundingstringRequired

Half_up_cent

classificationstringRequired

AFS

credit_evidenceobjectRequired
credit_methodstringRequired

Reviewed_afs_credit_assessment

recognitionstringRequired

Trade_date

tax_evidenceobjectRequired
tax_methodstringRequired

Reviewed_external_tax_amounts

providerstringRequired
trading_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
exceptionsarray of stringsRequired
executionobject or nullOptional
27 child attributes
broker_referencestringRequired
confirmationobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
counterpartystringRequired
currency_codestringRequired
cusipstringRequired
custodian_referencestringRequired
dealer_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

dealer_referencestringRequired
executed_atstring · date-timeRequired
execution_referencestringRequired
external_account_referencestringRequired
fee_amountintegerRequired
instruction_sha256stringRequired
key_idstringRequired
legal_entitystringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

net_cash_amountintegerRequired
observed_atstring · date-timeRequired
order_idstringRequired
priceintegerRequired
principal_amountintegerRequired
sidestringRequired
signaturestringRequired
statusstringRequired

Executed, cancelled or rejected (no fill)

trade_datestring · dateRequired

A business date, YYYY-MM-DD

unitsintegerRequired
versionstringRequired
idstringRequired
instructionobject or nullOptional
31 child attributes
broker_referencestringRequired
cash_limit_amountintegerRequired
currency_codestringRequired
cusipstringRequired
custodian_referencestringRequired
custody_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

custody_account_sha256stringRequired
dealer_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

dealer_referencestringRequired
external_account_referencestringRequired
idstringRequired
instrument_idstringRequired
instrument_sha256stringRequired
issued_atstring · date-timeRequired
legal_entitystringRequired
limit_priceintegerRequired
lot_idstringRequired

Allocated BUY lot or exclusively reserved SELL lot

lot_revisionintegerOptional
master_cash_external_account_referencestringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_fee_amountintegerRequired
order_idstringRequired
program_idstringRequired
program_sha256stringRequired
request_sha256stringRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

sha256stringRequired
sidestringRequired
trade_datestring · dateRequired

A business date, YYYY-MM-DD

unitsintegerRequired
versionstringRequired
instrumentobjectRequired
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
opening_inventory_emptybooleanRequired
ownershipobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
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
2 child attributes
referencestringRequired
sha256stringRequired
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
unit_basisstringRequired

Face_100_usd

unit_incrementintegerRequired
unit_scaleintegerRequired
zero_couponboolean or nullOptional
kindstringRequired
programobject or nullOptional
20 child attributes
authorityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bridge_subjectstringRequired
broker_namestringRequired
broker_referencestringRequired
custodian_namestringRequired
custodian_referencestringRequired
custody_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
dealersarray of objectsRequired
4 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

external_referencestringRequired
identityobjectRequired
legal_namestringRequired
enabledbooleanRequired
evidence_keysobjectRequired
legal_entitystringRequired
master_cash_external_account_referencestringRequired
master_cash_identityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_order_amountintegerRequired
policyobjectRequired
10 child attributes
accounting_evidenceobjectRequired
accrual_conventionstringRequired
acquisition_feesstringRequired

Capitalize_direct_acquisition_fees

cash_roundingstringRequired

Half_up_cent

classificationstringRequired

AFS

credit_evidenceobjectRequired
credit_methodstringRequired

Reviewed_afs_credit_assessment

recognitionstringRequired

Trade_date

tax_evidenceobjectRequired
tax_methodstringRequired

Reviewed_external_tax_amounts

providerstringRequired
trading_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

lot_idstringRequired
lot_revisionintegerOptional
programobjectRequired
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
opening_inventory_emptybooleanRequired
ownershipobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
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
2 child attributes
referencestringRequired
sha256stringRequired
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
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
unit_basisstringRequired

Face_100_usd

unit_incrementintegerRequired
unit_scaleintegerRequired
zero_couponboolean or nullOptional
kindstringRequired
programobject or nullOptional
20 child attributes
authorityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bridge_subjectstringRequired
broker_namestringRequired
broker_referencestringRequired
custodian_namestringRequired
custodian_referencestringRequired
custody_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
dealersarray of objectsRequired
4 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

external_referencestringRequired
identityobjectRequired
legal_namestringRequired
enabledbooleanRequired
evidence_keysobjectRequired
legal_entitystringRequired
master_cash_external_account_referencestringRequired
master_cash_identityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_order_amountintegerRequired
policyobjectRequired
10 child attributes
accounting_evidenceobjectRequired
accrual_conventionstringRequired
acquisition_feesstringRequired

Capitalize_direct_acquisition_fees

cash_roundingstringRequired

Half_up_cent

classificationstringRequired

AFS

credit_evidenceobjectRequired
credit_methodstringRequired

Reviewed_afs_credit_assessment

recognitionstringRequired

Trade_date

tax_evidenceobjectRequired
tax_methodstringRequired

Reviewed_external_tax_amounts

providerstringRequired
trading_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

requestobjectRequired
15 child attributes
cash_limit_amountintegerRequired
currency_codestringRequired
custody_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

dealer_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

dealer_referencestringRequired
instrument_idstringRequired
limit_priceintegerRequired
lot_idstringOptional
max_fee_amountintegerRequired
program_idstringRequired
rationalestringRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

sidestringRequired
trade_datestring · dateRequired

A business date, YYYY-MM-DD

unitsintegerRequired
request_sha256stringRequired
resolutionsarray of objectsOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
settlementobject or nullOptional
29 child attributes
broker_referencestringRequired
cash_evidenceobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
cash_referencestringRequired
currency_codestringRequired
cusipstringRequired
custodian_referencestringRequired
delivery_evidenceobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
delivery_referencestringRequired
execution_sha256stringRequired
external_account_referencestringRequired
fee_amountintegerRequired
instruction_sha256stringRequired
key_idstringRequired
legal_entitystringRequired
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
order_idstringRequired
principal_amountintegerRequired
settled_atstring · date-timeRequired
settlement_datestring · dateRequired

A business date, YYYY-MM-DD

settlement_referencestringRequired
sidestringRequired
signaturestringRequired
unitsintegerRequired
versionstringRequired
sourceobjectRequired
5 child attributes
captured_atstring · date-timeRequired
cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

external_account_referencestringRequired
legal_entitystringRequired
master_cash_external_account_referencestringRequired
statusstringRequired
trade_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

trade_posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

to move to open esc to close