Corgi BankDocumentation
OpenAPI

Record the next version of an advance's fixed-rate structure terms (call, conversion, put, cap, floor or other embedded derivative) from an effective date, pending independent review (treasury staff)

POST/ledger/borrowings/{id}/structure-terms

The 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. Records the next version of an advance's terms from effective_date (on or after the draw, before maturity): rate_type fixed (a floating rate is refused 422: the ledger accrues each advance at one annual rate with no repricing), one options entry per kind the agreement contains (call, conversion or put with its first exercise date; cap, floor or other_embedded_derivative), an empty list attesting none, and the agreement's source_ref and SHA-256. A call the lender exercised or a put the bank exercised carries exercised_date, the date it repays the advance, in a version effective from the notice (on or after the first exercise date, on or before maturity, at most one per version); a conversion has none, since a converted advance floats. Schedule RC-M item 5.a reports such an advance by its exercise date and a convertible one by its next conversion date. The database refuses the same option records. A version waiting for review, or one not effective after the approved version, is refused 409 conflict. The same key and terms replay; other terms under the key are 409.

Path parameters

idstringRequired

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

effective_datestring · dateRequired

A business date, YYYY-MM-DD

optionsarray of objectsRequired
4 child attributes
descriptionstringRequired
exercised_datestring · date or nullOptional

Call or put exercised: the date it repays the advance

first_exercise_datestring · date or nullOptional

Call, conversion and put

kindstringRequired
rate_typestringRequired

Fixed; floating is refused

source_refstringRequired
source_sha256stringRequired

Returns

200 OK

borrowing_idstringRequired
content_sha256stringRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

makerstringRequired
optionsarray of objectsRequired
4 child attributes
descriptionstringRequired
exercised_datestring · date or nullOptional

Call or put exercised: the date it repays the advance

first_exercise_datestring · date or nullOptional

Call, conversion and put

kindstringRequired
rate_typestringRequired
recorded_atstring · date-timeRequired
reviewobject or nullOptional

ReviewRecord is a retained review.

5 child attributes
approvebooleanRequired
checkerstringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

reasonstringRequired
recorded_atstring · date-timeRequired
source_refstringRequired
source_sha256stringRequired
statusstringRequired

Pending_review, approved or rejected

versionintegerRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close