Propose a nostro account's cutoffs, charges, interest, liquidity limits and reconciliation tolerances from an effective date
/ledger/correspondent/nostro-accounts/{id}/termsCorrespondent 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-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
cutoffobjectRequiredCutoffWindow is when the correspondent values a payment in the currency on the same day: from the opening to the cutoff, local to the correspondent's time zone, on its business days. The times and the market holidays come from the account agreement; SWIFT delivers at any hour.
4 child attributes
cutoffstringRequiredHH:MM
holidaysarray of stringsOptionalYYYY-MM-DD weekdays the correspondent's market is closed
opensstringRequiredHH:MM
time_zonestringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
interestobjectRequiredInterestTerms are the rates the correspondent pays on a credit balance (a negative rate is a charge on it) and charges on an overdrawn one.
3 child attributes
credit_rate_bpsintegerRequiredday_countstringRequireddebit_rate_bpsintegerRequiredliquidityobjectRequiredLiquidityTerms are the bank's own limits for the account: the least it keeps to settle the day's payments, what a funding brings it back to, and the most it leaves at the correspondent, the internal exposure limit its correspondent policy sets under Regulation F (12 CFR 206.3).
3 child attributes
maximum_balanceintegerRequiredminimum_balanceintegerRequiredtarget_balanceintegerRequiredmonthly_feesarray of objectsRequired3 child attributes
amountintegerRequiredbillingstringRequiredItem_debit or invoice
codestringRequiredpayment_chargesarray of objectsRequired4 child attributes
amountintegerRequiredbillingstringRequiredItem_debit, invoice or deducted
charge_bearerstringRequireddirectionstringRequiredOutbound or inbound
reconciliationobjectRequiredReconciliationTerms are the tolerances of the automated reconciliation: how far apart a statement entry's value date and the ledger's effective date may be for a match, and how many days an unmatched item waits (a timing difference) before it opens a break.
2 child attributes
unmatched_age_daysintegerRequiredvalue_date_window_daysintegerRequiredrouted_bic_prefixesarray of stringsOptionalRoutedBICPrefixes are the destination banks this account reaches, as BIC prefixes at the lengths a BIC is meaningful at: four characters for an institution anywhere, six for it in one country, eight for one of its offices and eleven for one branch. A payment to a destination one of them heads settles through this account rather than the currency's primary one, which is how a currency with more than one correspondent is split by where the money is going. Empty leaves the account to the primary route.
source_refstringRequiredReturns
200 OK
cutoffobjectRequiredCutoffWindow is when the correspondent values a payment in the currency on the same day: from the opening to the cutoff, local to the correspondent's time zone, on its business days. The times and the market holidays come from the account agreement; SWIFT delivers at any hour.
4 child attributes
cutoffstringRequiredHH:MM
holidaysarray of stringsOptionalYYYY-MM-DD weekdays the correspondent's market is closed
opensstringRequiredHH:MM
time_zonestringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
idintegerRequiredinterestobjectRequiredInterestTerms are the rates the correspondent pays on a credit balance (a negative rate is a charge on it) and charges on an overdrawn one.
3 child attributes
credit_rate_bpsintegerRequiredday_countstringRequireddebit_rate_bpsintegerRequiredliquidityobjectRequiredLiquidityTerms are the bank's own limits for the account: the least it keeps to settle the day's payments, what a funding brings it back to, and the most it leaves at the correspondent, the internal exposure limit its correspondent policy sets under Regulation F (12 CFR 206.3).
3 child attributes
maximum_balanceintegerRequiredminimum_balanceintegerRequiredtarget_balanceintegerRequiredmakerstringRequiredmonthly_feesarray of objectsRequired3 child attributes
amountintegerRequiredbillingstringRequiredItem_debit or invoice
codestringRequirednostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
payment_chargesarray of objectsRequired4 child attributes
amountintegerRequiredbillingstringRequiredItem_debit, invoice or deducted
charge_bearerstringRequireddirectionstringRequiredOutbound or inbound
reconciliationobjectRequiredReconciliationTerms are the tolerances of the automated reconciliation: how far apart a statement entry's value date and the ledger's effective date may be for a match, and how many days an unmatched item waits (a timing difference) before it opens a break.
2 child attributes
unmatched_age_daysintegerRequiredvalue_date_window_daysintegerRequiredrecorded_atstring · date-timeRequiredreviewobject or nullOptionalReviewRecord is a retained decision.
4 child attributes
approvebooleanRequiredcheckerstringRequiredreasonstringRequiredrecorded_atstring · date-timeRequiredrouted_bic_prefixesarray of stringsOptionalRoutedBICPrefixes are the destination banks this account reaches, as BIC prefixes at the lengths a BIC is meaningful at: four characters for an institution anywhere, six for it in one country, eight for one of its offices and eleven for one branch. A payment to a destination one of them heads settles through this account rather than the currency's primary one, which is how a currency with more than one correspondent is split by where the money is going. Empty leaves the account to the primary route.
source_refstringRequiredstatusstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503