Corgi BankDocumentation
OpenAPI

Accrue a closed month's interest on the account's daily balances (idempotent per month)

POST/ledger/correspondent/nostro-accounts/{id}/interest-accruals

Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

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

periodstringRequired

Returns

200 OK

accrual_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_atstring · date-timeRequired
currency_codestringRequired
daysintegerRequired
expense_accruedstringRequired

Exact minor units, rounded to twelve decimal places for display

expense_amountintegerRequired

Recognised: Dr 5205 / Cr 2393

idstringRequired
income_accruedstringRequired

Exact minor units, rounded to twelve decimal places for display

income_amountintegerRequired

Recognised: Dr 1475 / Cr 4025 (a negative rate reverses it)

net_amountintegerRequired

What the correspondent should credit (positive) or debit (negative)

nostro_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

periodstringRequired
run_bystringRequired
settled_amountinteger or nullOptional
settled_atstring · date-timeOptional
settlement_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

statement_item_refstringOptional
statusstringRequired

Accrued or settled

variance_amountintegerRequired

Settled less net, once settled

Errors

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

400401403404409412413422424429500503

to move to open esc to close