Accrue a closed month's interest on the account's daily balances (idempotent per month)
/ledger/correspondent/nostro-accounts/{id}/interest-accrualsCorrespondent 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
idstringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
periodstringRequiredReturns
200 OK
accrual_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
created_atstring · date-timeRequiredcurrency_codestringRequireddaysintegerRequiredexpense_accruedstringRequiredExact minor units, rounded to twelve decimal places for display
expense_amountintegerRequiredRecognised: Dr 5205 / Cr 2393
idstringRequiredincome_accruedstringRequiredExact minor units, rounded to twelve decimal places for display
income_amountintegerRequiredRecognised: Dr 1475 / Cr 4025 (a negative rate reverses it)
net_amountintegerRequiredWhat the correspondent should credit (positive) or debit (negative)
nostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
periodstringRequiredrun_bystringRequiredsettled_amountinteger or nullOptionalsettled_atstring · date-timeOptionalsettlement_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
statement_item_refstringOptionalstatusstringRequiredAccrued or settled
variance_amountintegerRequiredSettled less net, once settled
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503