Corgi BankDocumentation
OpenAPI

Read a retained Federal Reserve interest credit

GET/ledger/reserve-interest/settlements/{id}

Read one recorded credit, its accrued period and its review. A read needs ledger:read or ledger:post.

Path parameters

idstringRequired

Returns

200 OK

accrual_matchedbooleanRequired

The credit equals the accrual rounded to the cent

accruedstringRequired

The period's accrual, dollars to eight places

amountintegerRequired
currency_codestringRequired
difference_amountintegerRequired

The credit less that accrual

expected_amountintegerRequired

That accrual rounded to the cent

idintegerRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

makerstringRequired
matchedbooleanRequired

Settled when recorded (statement credits before proposals were reviewed)

period_endstring · dateRequired

A business date, YYYY-MM-DD

period_startstring · dateRequired

A business date, YYYY-MM-DD

recorded_atstring · date-timeRequired
referencestringRequired
reviewobject or nullOptional

ReserveReviewRecord is a retained review.

5 child attributes
approvebooleanRequired
checkerstringRequired

The verified treasury checker, never the maker

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

reasonstringRequired
recorded_atstring · date-timeRequired
sourcestringRequired

Fed_statement (the Fed account statement) or treasury (entered by hand)

statement_refstringOptional
statusstringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close