Read customer agency positions distinct from originating-bank deposits
/deposit-placementsVerified owner reads their account's positions; verified placement staff/service readers may read the bank inventory. Cursor query supported.
Query parameters
limitintegerOptionalPage size
Default 10. Maximum 100.
starting_afterstringOptionalThe id of the last item seen; returns the page after it
ending_beforestringOptionalThe id of the first item seen; returns the page before it
Returns
200 OK
dataarray of objectsRequired25 child attributes
accounting_plan_sha256stringOptionalaccounting_plansarray of objectsOptional7 child attributes
correction_reasonstringOptionalcreated_atstring · date-timeRequiredjournalobjectRequiredJournal 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_periodstringOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequiredkindstringRequiredprotected_command_idstringRequiredreasonstringOptionalrelease_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredjournal_keystringRequiredjournal_sha256stringRequiredreceipt_sha256stringRequiredsupersedes_sha256stringOptionalactorstringRequiredcapacityobjectRequired8 child attributes
actorstringRequiredcapacityobject or nullOptional7 child attributes
capacitystringRequiredSingle only in this implementation
evidenceobjectRequiredexternal_amountinteger or nullOptionalIncludes principal + accrued interest, excludes this module's positions
fdic_certificatestringRequiredobserved_atstring · date-timeRequiredowner_idstringRequiredvalid_untilstring · date-timeRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredkindstringRequiredprogramobject or nullOptional24 child attributes
agency_agreementobjectRequiredagency_titlestringRequiredannual_rate_bpsintegerRequiredSame actual and customer-facing terms
bank_eligibilityobjectRequiredbridge_subjectstringRequiredcapacity_rulesobjectRequiredcustomer_disclosureobjectRequiredenabledbooleanRequiredfdic_certificatestringRequiredinterest_basisstringRequiredinterest_reserve_amountintegerRequiredlegal_entitystringRequiredmaturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
max_principal_amountintegerRequiredproductstringRequiredDemand or certificate
providerstringRequiredreceipt_keysobjectRequiredreceiver_referencestringRequiredreceiving_bank_namestringRequiredrouting_numberstringRequiredtax_reporterstringRequiredtax_reporting_agreementobjectRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
cash_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
created_atstring · date-timeRequiredcustomer_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
decisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredexceptionsarray of stringsRequiredidstringRequiredinstructionobject or nullOptionalInstruction is an immutable, authorized bridge command. Reading a draft is not dispatch.
22 child attributes
agency_titlestringRequiredannual_rate_bpsintegerRequiredcapacitystringRequiredcurrency_codestringRequiredexternal_account_referencestringOptionalfdic_certificatestringRequiredidstringRequiredinterest_basisstringRequiredissued_atstring · date-timeRequiredmaturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
operationstringRequiredowner_idstringRequiredplacement_idstringRequiredprincipal_amountintegerRequiredproductstringRequiredprogram_idstringRequiredprogram_sha256stringRequiredreceiver_referencestringRequiredrouting_numberstringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sha256stringRequiredstanding_authorization_sha256stringOptionaljournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
latest_statementobject or nullOptionalStatement 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_amountintegerRequiredas_ofstring · dateRequiredA business date, YYYY-MM-DD
capacitystringRequiredevidencestring · byteRequiredevidence_formatstringRequiredevidence_sha256stringRequiredexternal_account_referencestringRequiredfdic_certificatestringRequiredkey_idstringRequiredobserved_atstring · date-timeRequiredoriginal_instruction_sha256stringRequiredowner_idstringRequiredplacement_idstringRequiredprincipal_amountintegerRequiredsignaturestringRequiredversionstringRequiredposting_datestring · date or nullOptionalA business date, YYYY-MM-DD
prior_redemptionsarray of objectsOptional13 child attributes
accounting_plan_sha256stringOptionalaccounting_plansarray of objectsOptional7 child attributes
correction_reasonstringOptionalcreated_atstring · date-timeRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
journal_keystringRequiredjournal_sha256stringRequiredreceipt_sha256stringRequiredsupersedes_sha256stringOptionalactorstringRequiredcreated_atstring · date-timeRequiredidstringRequiredidempotency_keystringRequiredinstructionobjectRequiredInstruction is an immutable, authorized bridge command. Reading a draft is not dispatch.
22 child attributes
agency_titlestringRequiredannual_rate_bpsintegerRequiredcapacitystringRequiredcurrency_codestringRequiredexternal_account_referencestringOptionalfdic_certificatestringRequiredidstringRequiredinterest_basisstringRequiredissued_atstring · date-timeRequiredmaturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
operationstringRequiredowner_idstringRequiredplacement_idstringRequiredprincipal_amountintegerRequiredproductstringRequiredprogram_idstringRequiredprogram_sha256stringRequiredreceiver_referencestringRequiredrouting_numberstringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sha256stringRequiredstanding_authorization_sha256stringOptionaljournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
posting_datestring · date or nullOptionalA business date, YYYY-MM-DD
receiptobject or nullOptionalReceipt 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
capacitystringRequiredcurrency_codestringRequiredevidencestring · byteRequiredevidence_formatstringRequiredevidence_sha256stringRequiredexternal_account_referencestringRequiredfdic_certificatestringRequiredinstruction_sha256stringRequiredinterest_amountintegerRequiredkey_idstringRequiredobserved_atstring · date-timeRequiredoperationstringRequiredowner_idstringRequiredprincipal_amountintegerRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
settlement_referencestringRequiredsignaturestringRequiredstatusstringRequiredversionstringRequiredrequest_sha256stringRequiredstatusstringRequiredsweep_authorizationobject or nullOptionalGenerated 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_subjectstringRequiredmandateobjectRequiredrunobjectRequiredThe full run is independently durable. Its exact source and deterministic selection must be reverified by the application before issuing or claiming.
sha256stringRequiredversionstringRequiredprogramobjectRequired8 child attributes
actorstringRequiredcapacityobject or nullOptional7 child attributes
capacitystringRequiredSingle only in this implementation
evidenceobjectRequiredexternal_amountinteger or nullOptionalIncludes principal + accrued interest, excludes this module's positions
fdic_certificatestringRequiredobserved_atstring · date-timeRequiredowner_idstringRequiredvalid_untilstring · date-timeRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredkindstringRequiredprogramobject or nullOptional24 child attributes
agency_agreementobjectRequiredagency_titlestringRequiredannual_rate_bpsintegerRequiredSame actual and customer-facing terms
bank_eligibilityobjectRequiredbridge_subjectstringRequiredcapacity_rulesobjectRequiredcustomer_disclosureobjectRequiredenabledbooleanRequiredfdic_certificatestringRequiredinterest_basisstringRequiredinterest_reserve_amountintegerRequiredlegal_entitystringRequiredmaturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
max_principal_amountintegerRequiredproductstringRequiredDemand or certificate
providerstringRequiredreceipt_keysobjectRequiredreceiver_referencestringRequiredreceiving_bank_namestringRequiredrouting_numberstringRequiredtax_reporterstringRequiredtax_reporting_agreementobjectRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
receiptobject or nullOptionalReceipt 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
capacitystringRequiredcurrency_codestringRequiredevidencestring · byteRequiredevidence_formatstringRequiredevidence_sha256stringRequiredexternal_account_referencestringRequiredfdic_certificatestringRequiredinstruction_sha256stringRequiredinterest_amountintegerRequiredkey_idstringRequiredobserved_atstring · date-timeRequiredoperationstringRequiredowner_idstringRequiredprincipal_amountintegerRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
settlement_referencestringRequiredsignaturestringRequiredstatusstringRequiredversionstringRequiredredemptionobject or nullOptional13 child attributes
accounting_plan_sha256stringOptionalaccounting_plansarray of objectsOptional7 child attributes
correction_reasonstringOptionalcreated_atstring · date-timeRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
journal_keystringRequiredjournal_sha256stringRequiredreceipt_sha256stringRequiredsupersedes_sha256stringOptionalactorstringRequiredcreated_atstring · date-timeRequiredidstringRequiredidempotency_keystringRequiredinstructionobjectRequiredInstruction is an immutable, authorized bridge command. Reading a draft is not dispatch.
22 child attributes
agency_titlestringRequiredannual_rate_bpsintegerRequiredcapacitystringRequiredcurrency_codestringRequiredexternal_account_referencestringOptionalfdic_certificatestringRequiredidstringRequiredinterest_basisstringRequiredissued_atstring · date-timeRequiredmaturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
operationstringRequiredowner_idstringRequiredplacement_idstringRequiredprincipal_amountintegerRequiredproductstringRequiredprogram_idstringRequiredprogram_sha256stringRequiredreceiver_referencestringRequiredrouting_numberstringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sha256stringRequiredstanding_authorization_sha256stringOptionaljournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
posting_datestring · date or nullOptionalA business date, YYYY-MM-DD
receiptobject or nullOptionalReceipt 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
capacitystringRequiredcurrency_codestringRequiredevidencestring · byteRequiredevidence_formatstringRequiredevidence_sha256stringRequiredexternal_account_referencestringRequiredfdic_certificatestringRequiredinstruction_sha256stringRequiredinterest_amountintegerRequiredkey_idstringRequiredobserved_atstring · date-timeRequiredoperationstringRequiredowner_idstringRequiredprincipal_amountintegerRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
settlement_referencestringRequiredsignaturestringRequiredstatusstringRequiredversionstringRequiredrequest_sha256stringRequiredstatusstringRequiredsweep_authorizationobject or nullOptionalGenerated 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_subjectstringRequiredmandateobjectRequiredrunobjectRequiredThe full run is independently durable. Its exact source and deterministic selection must be reverified by the application before issuing or claiming.
sha256stringRequiredversionstringRequiredrequestobjectRequired9 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
agency_consentbooleanRequiredamountintegerRequiredcapacity_idstringRequiredcurrency_codestringRequireddisclosure_sha256stringRequiredprogram_idstringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
standing_authorization_sha256stringOptionalrequest_sha256stringRequiredscreening_atstring · date-time or nullOptionalscreening_idsarray of stringsOptionalsourceobjectRequired6 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
captured_atstring · date-timeRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
owner_idstringRequiredownership_revisionintegerRequiredownership_sha256stringRequiredstatusstringRequiredsweep_authorizationobject or nullOptionalGenerated 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_subjectstringRequiredmandateobjectRequired10 child attributes
actorstringRequiredconsentobject or nullOptionalcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptionaldisclosureobjectRequiredidstringRequiredprogramobjectRequiredsourceobjectRequiredtermsobjectRequiredSweepTerms authorize one demand program and full-position redemption only. The source service must prove this is an open USD DDA with exactly one owner.
runobjectRequiredThe full run is independently durable. Its exact source and deterministic selection must be reverified by the application before issuing or claiming.
8 child attributes
actorstringRequiredbusiness_datestring · dateRequiredA business date, YYYY-MM-DD
content_sha256stringRequiredcreated_atstring · date-timeRequiredidstringRequiredobservation_sha256stringRequiredselectionobjectRequiredsourceobjectRequiredsha256stringRequiredversionstringRequiredhas_morebooleanRequiredWhether another page follows
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503