Record a lender's effective-dated collateral schedule: eligible classes, haircuts, valuation bases and ineligibility conditions, pending independent review (treasury staff)
/ledger/collateral/schedulesThe ledger's guard admits ledger:treasury:write on this route and refuses ledger:post; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. Names an approved lender, an effective date, one entry per asset class it rules on (haircut 0 to 9999 bps; securities valued at market value, loans at unpaid principal) and the lender's source. Nonaccrual, charge-off, payoff and maturity always make an asset ineligible. Applies only once a different treasury checker approves it.
Headers
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
classesarray of objectsRequired5 child attributes
asset_classstringRequiredUs_treasury, agency_mbs, residential_mortgage_1_4, commercial_real_estate, commercial_and_industrial, consumer, other
eligiblebooleanRequiredhaircut_bpsintegerRequiredmax_days_past_dueintegerOptionalvaluation_basisstringOptionalMarket_value for securities, unpaid_principal for loans
effective_datestring · dateRequiredA business date, YYYY-MM-DD
lender_idintegerRequiredmaturity_beyond_advancebooleanRequiredAn asset maturing inside the advance term is ineligible
source_refstringRequiredReturns
200 OK
classesarray of objectsRequired5 child attributes
asset_classstringRequiredUs_treasury, agency_mbs, residential_mortgage_1_4, commercial_real_estate, commercial_and_industrial, consumer, other
eligiblebooleanRequiredhaircut_bpsintegerRequiredmax_days_past_dueintegerOptionalvaluation_basisstringOptionalMarket_value for securities, unpaid_principal for loans
effective_datestring · dateRequiredA business date, YYYY-MM-DD
excludes_charged_offbooleanRequiredexcludes_nonaccrualbooleanRequiredexcludes_sold_portionbooleanRequiredidintegerRequiredlender_idintegerRequiredmakerstringRequiredmaturity_beyond_advancebooleanRequiredrecorded_atstring · date-timeRequiredreviewobject or nullOptionalReviewRecord is a retained review.
5 child attributes
approvebooleanRequiredcheckerstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringRequiredrecorded_atstring · date-timeRequiredsource_refstringRequiredstatusstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503