Judge the account's balance readings against its liquidity limits, raising and resolving alerts
/ledger/correspondent/nostro-accounts/{id}/liquidity-evaluationsCorrespondent 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.
Returns
200 OK
breachesarray of objectsRequired4 child attributes
kindstringRequiredobservationobjectRequiredLiquidityObservation is one reading of a nostro balance: the ledger's posted balance, the correspondent's intraday available or booked balance (camt.052) or its closing balance (camt.053).
3 child attributes
balanceintegerRequiredobserved_atstring · date-timeRequiredsourcestringRequiredLedger, intraday_report or statement
suggested_amountintegerRequiredSuggestedMinor is the funding that brings the balance back to the target (below minimum, overdrawn) or the excess above the target to bring home (above maximum).
thresholdintegerRequirednostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
openarray of objectsRequired15 child attributes
acknowledged_atstring · date-time or nullOptionalacknowledged_bystringOptionalacknowledgement_notestringOptionalcurrency_codestringRequiredidstringRequiredkindstringRequirednostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
observed_atstring · date-timeRequiredobserved_balanceintegerRequiredraised_atstring · date-timeRequiredresolved_atstring · date-time or nullOptionalsourcestringRequiredstatusstringRequiredsuggested_amountintegerRequiredthresholdintegerRequiredraisedarray of objectsRequired15 child attributes
acknowledged_atstring · date-time or nullOptionalacknowledged_bystringOptionalacknowledgement_notestringOptionalcurrency_codestringRequiredidstringRequiredkindstringRequirednostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
observed_atstring · date-timeRequiredobserved_balanceintegerRequiredraised_atstring · date-timeRequiredresolved_atstring · date-time or nullOptionalsourcestringRequiredstatusstringRequiredsuggested_amountintegerRequiredthresholdintegerRequiredreadingsarray of objectsRequired3 child attributes
balanceintegerRequiredobserved_atstring · date-timeRequiredsourcestringRequiredLedger, intraday_report or statement
resolvedarray of objectsRequired15 child attributes
acknowledged_atstring · date-time or nullOptionalacknowledged_bystringOptionalacknowledgement_notestringOptionalcurrency_codestringRequiredidstringRequiredkindstringRequirednostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
observed_atstring · date-timeRequiredobserved_balanceintegerRequiredraised_atstring · date-timeRequiredresolved_atstring · date-time or nullOptionalsourcestringRequiredstatusstringRequiredsuggested_amountintegerRequiredthresholdintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503