A lender's live pledges as the schedule in force judges them, lendable value, advances outstanding and borrowing capacity; horizon names an advance maturity the collateral must outlast

GET/ledger/collateral/lenders/{id}/capacity

Every live pledge as the schedule in force judges it for an advance to the horizon (the latest open advance's maturity, or horizon when later), the lendable value of the acknowledged eligible pledges, the advances outstanding, capacity and shortfall. A read needs ledger:read or ledger:post.

Path parameters

idstringRequired

Query parameters

horizonstringOptional

Returns

200 OK

as_ofstring · dateRequired

A business date, YYYY-MM-DD

capacity_amountintegerRequired

gl_codestringRequired

horizonstring · dateRequired

A business date, YYYY-MM-DD

ineligible_pledgesintegerRequired

legal_namestringRequired

lendable_amountintegerRequired

lender_idintegerRequired

lender_kindstringRequired

outstanding_amountintegerRequired

pledged_value_amountintegerRequired

pledgesarray of objectsRequired

13 child attributes

assetobjectRequired

CollateralAsset is one bank-owned asset the register values.

12 child attributes

asset_classstringRequired

idintegerRequired

kindstringRequired

Securities_lot or loan

loanobject or nullOptional

LoanCollateralFacts are the lending service's facts about a loan as of a date.

12 child attributes

as_ofstring · dateRequired

A business date, YYYY-MM-DD

asset_classstringRequired

charged_offbooleanRequired

days_past_dueintegerRequired

loan_idstringRequired

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

maturity_unresolvedbooleanRequired

nonaccrualbooleanRequired

participations_sold_amountintegerRequired

product_codestringRequired

statusstringRequired

unpaid_principal_amountintegerRequired

maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

maturity_unresolvedbooleanRequired

referencestringRequired

updated_atstring · date-timeRequired

valuation_as_ofstring · dateRequired

A business date, YYYY-MM-DD

valuation_basisstringRequired

valuation_sha256stringOptional

value_amountintegerRequired

created_atstring · date-timeRequired

eligiblebooleanRequired

haircut_bpsintegerRequired

idintegerRequired

ineligibilityarray of stringsRequired

lendable_amountintegerRequired

lender_idintegerRequired

makerstringRequired

pledge_referencestringOptional

statestringRequired

Reserved, pledged, releasing or released

updated_atstring · date-timeRequired

value_amountintegerRequired

schedule_idintegerOptional

shortfall_amountintegerRequired

Errors

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

400401403404409412413422424429500503