Corgi BankDocumentation
OpenAPI

Request an agency deposit under authenticated owner consent

POST/deposit-placements

Fresh bound individual customer consents to exact disclosure, amount, account and program. Independently approved outside exposure plus all pending/active placements share owner/bank/single-capacity headroom. Staff cannot manufacture customer consent. Unsupported ownership, restricted/protected/overdraft accounts, stale evidence and missing capacity refuse.

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

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

Returns

200 OK

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.

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
receipt_sha256stringRequired
supersedes_sha256stringOptional
actorstringRequired
capacityobjectRequired
8 child attributes
actorstringRequired
capacityobject or nullOptional
7 child attributes
capacitystringRequired

Single only in this implementation

evidenceobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
external_amountinteger or nullOptional

Includes principal + accrued interest, excludes this module's positions

fdic_certificatestringRequired
observed_atstring · date-timeRequired
owner_idstringRequired
valid_untilstring · date-timeRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
idstringRequired
kindstringRequired
programobject or nullOptional
24 child attributes
agency_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
agency_titlestringRequired
annual_rate_bpsintegerRequired

Same actual and customer-facing terms

bank_eligibilityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bridge_subjectstringRequired
capacity_rulesobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
customer_disclosureobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
fdic_certificatestringRequired
interest_basisstringRequired
interest_reserve_amountintegerRequired
legal_entitystringRequired
maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

max_principal_amountintegerRequired
productstringRequired

Demand or certificate

providerstringRequired
receipt_keysobjectRequired
receiver_referencestringRequired
receiving_bank_namestringRequired
routing_numberstringRequired
tax_reporterstringRequired
tax_reporting_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

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

11 child attributes
adjusts_periodstringOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired
kindstringRequired
protected_command_idstringRequired
reasonstringOptional
release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
reversal_ofstringOptional
source_refstringRequired
source_servicestringRequired
journal_keystringRequired
journal_sha256stringRequired
receipt_sha256stringRequired
supersedes_sha256stringOptional
actorstringRequired
created_atstring · date-timeRequired
idstringRequired
idempotency_keystringRequired
instructionobjectRequired

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

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.

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

5 child attributes
bridge_subjectstringRequired
mandateobjectRequired
10 child attributes
actorstringRequired
consentobject or nullOptional
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
disclosureobjectRequired
idstringRequired
programobjectRequired
sourceobjectRequired
termsobjectRequired

SweepTerms authorize one demand program and full-position redemption only. The source service must prove this is an open USD DDA with exactly one owner.

runobjectRequired

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

8 child attributes
actorstringRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

content_sha256stringRequired
created_atstring · date-timeRequired
idstringRequired
observation_sha256stringRequired
selectionobjectRequired
sourceobjectRequired
sha256stringRequired
versionstringRequired
programobjectRequired
8 child attributes
actorstringRequired
capacityobject or nullOptional
7 child attributes
capacitystringRequired

Single only in this implementation

evidenceobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
external_amountinteger or nullOptional

Includes principal + accrued interest, excludes this module's positions

fdic_certificatestringRequired
observed_atstring · date-timeRequired
owner_idstringRequired
valid_untilstring · date-timeRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
idstringRequired
kindstringRequired
programobject or nullOptional
24 child attributes
agency_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
agency_titlestringRequired
annual_rate_bpsintegerRequired

Same actual and customer-facing terms

bank_eligibilityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bridge_subjectstringRequired
capacity_rulesobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
customer_disclosureobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
fdic_certificatestringRequired
interest_basisstringRequired
interest_reserve_amountintegerRequired
legal_entitystringRequired
maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

max_principal_amountintegerRequired
productstringRequired

Demand or certificate

providerstringRequired
receipt_keysobjectRequired
receiver_referencestringRequired
receiving_bank_namestringRequired
routing_numberstringRequired
tax_reporterstringRequired
tax_reporting_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

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.

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

11 child attributes
adjusts_periodstringOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired
kindstringRequired
protected_command_idstringRequired
reasonstringOptional
release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
reversal_ofstringOptional
source_refstringRequired
source_servicestringRequired
journal_keystringRequired
journal_sha256stringRequired
receipt_sha256stringRequired
supersedes_sha256stringOptional
actorstringRequired
created_atstring · date-timeRequired
idstringRequired
idempotency_keystringRequired
instructionobjectRequired

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

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.

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

5 child attributes
bridge_subjectstringRequired
mandateobjectRequired
10 child attributes
actorstringRequired
consentobject or nullOptional
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
disclosureobjectRequired
idstringRequired
programobjectRequired
sourceobjectRequired
termsobjectRequired

SweepTerms authorize one demand program and full-position redemption only. The source service must prove this is an open USD DDA with exactly one owner.

runobjectRequired

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

8 child attributes
actorstringRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

content_sha256stringRequired
created_atstring · date-timeRequired
idstringRequired
observation_sha256stringRequired
selectionobjectRequired
sourceobjectRequired
sha256stringRequired
versionstringRequired
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
10 child attributes
actorstringRequired
consentobject or nullOptional
7 child attributes
accepted_atstring · date-timeRequired
actorstringRequired
content_sha256stringRequired
idstringRequired
mandate_idstringRequired
requestobjectRequired
sourceobjectRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
disclosureobjectRequired
14 child attributes
agency_titlestringRequired
annual_rate_bpsintegerRequired
customer_disclosureobjectRequired
fdic_certificatestringRequired
insurance_noticestringRequired
interest_basisstringRequired
maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

productstringRequired
program_idstringRequired
program_sha256stringRequired
receiving_bank_namestringRequired
sha256stringRequired
tax_reporterstringRequired
tax_reporting_agreementobjectRequired
idstringRequired
programobjectRequired
8 child attributes
actorstringRequired
capacityobject or nullOptional
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
idstringRequired
kindstringRequired
programobject or nullOptional
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
termsobjectRequired

SweepTerms authorize one demand program and full-position redemption only. The source service must prove this is an open USD DDA with exactly one owner.

10 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

full_position_redemptionbooleanRequired
high_watermarkintegerRequired
low_watermarkintegerRequired
max_daily_outward_amountintegerRequired
program_idstringRequired
target_balanceintegerRequired
target_overshootbooleanRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

runobjectRequired

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

8 child attributes
actorstringRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

content_sha256stringRequired
created_atstring · date-timeRequired
idstringRequired
observation_sha256stringRequired
selectionobjectRequired
6 child attributes
amountintegerRequired

Principal; redemption interest remains actual receipt evidence

blockersarray of stringsRequired
operationstringRequired

Place, redeem, noop, refused

placement_idstringOptional
reasonstringRequired
redemption_idstringOptional
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
sha256stringRequired
versionstringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close