Read reviewed standing terms, actual customer acceptance and lifecycle state

GET/placement-sweeps/{id}

Bound owner, verified payments:placements:read/write reader or exact retained program bridge sees retained reviewed terms, exact current customer acceptance and current state. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.

Path parameters

idstringRequired

Returns

200 OK

mandateobjectRequired

10 child attributes

actorstringRequired

consentobject or nullOptional

7 child attributes

accepted_atstring · date-timeRequired

actorstringRequired

content_sha256stringRequired

idstringRequired

mandate_idstringRequired

requestobjectRequired

6 child attributes

agency_consentbooleanRequired

disclosure_sha256stringRequired

full_position_redemptionbooleanRequired

mandate_sha256stringRequired

standing_sweep_consentbooleanRequired

target_overshootbooleanRequired

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

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

2 child attributes

referencestringRequired

sha256stringRequired

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

2 child attributes

referencestringRequired

sha256stringRequired

idstringRequired

programobjectRequired

8 child attributes

actorstringRequired

capacityobject or nullOptional

7 child attributes

capacitystringRequired

Single only in this implementation

evidenceobjectRequired

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

agency_titlestringRequired

annual_rate_bpsintegerRequired

Same actual and customer-facing terms

bank_eligibilityobjectRequired

bridge_subjectstringRequired

capacity_rulesobjectRequired

customer_disclosureobjectRequired

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

valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

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

stateobjectRequired

Lifecycle is separate from immutable review, acceptance and run evidence. A pause needs a new current customer acceptance before execution resumes.

7 child attributes

actorstringRequired

atstring · date-timeRequired

consent_idstringOptional

mandate_idstringRequired

reasonstringRequired

revisionintegerRequired

statusstringRequired

Errors

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

400401403404409412413422424429500503