Corgi BankDocumentation
OpenAPI

List a nostro account's terms versions, latest effective first

GET/ledger/correspondent/nostro-accounts/{id}/terms

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

Returns

200 OK

dataarray of objectsRequired
15 child attributes
cutoffobjectRequired

CutoffWindow 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
cutoffstringRequired

HH:MM

holidaysarray of stringsOptional

YYYY-MM-DD weekdays the correspondent's market is closed

opensstringRequired

HH:MM

time_zonestringRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

idintegerRequired
interestobjectRequired

InterestTerms 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_bpsintegerRequired
day_countstringRequired
debit_rate_bpsintegerRequired
liquidityobjectRequired

LiquidityTerms 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_balanceintegerRequired
minimum_balanceintegerRequired
target_balanceintegerRequired
makerstringRequired
monthly_feesarray of objectsRequired
3 child attributes
amountintegerRequired
billingstringRequired

Item_debit or invoice

codestringRequired
nostro_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payment_chargesarray of objectsRequired
4 child attributes
amountintegerRequired
billingstringRequired

Item_debit, invoice or deducted

charge_bearerstringRequired
directionstringRequired

Outbound or inbound

reconciliationobjectRequired

ReconciliationTerms 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_daysintegerRequired
value_date_window_daysintegerRequired
recorded_atstring · date-timeRequired
reviewobject or nullOptional

ReviewRecord is a retained decision.

4 child attributes
approvebooleanRequired
checkerstringRequired
reasonstringRequired
recorded_atstring · date-timeRequired
routed_bic_prefixesarray of stringsOptional

RoutedBICPrefixes 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_refstringRequired
statusstringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close