Corgi BankDocumentation
OpenAPI

Record the FedNow Service's account activity details report (camt.052) as the instant lines of the master account statement

POST/reconciliations/statements/fednow

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.

Returns

200 OK

business_datestring · dateRequired

A business date, YYYY-MM-DD

closing_amountinteger or nullOptional

The statement's closing balance, compared with the ledger

currency_codestringOptional
idstringOptional
linesarray of objectsRequired
5 child attributes
amountintegerRequired

Minor units, always positive

descriptionstringRequired

Free text from the statement

directionstringRequired

Debit takes money out of the bank's account, credit brings it in

kindstringRequired

Wire, ach_file, instant, card_settlement, ...

referencestringRequired

The rail's reference: IMAD, message id, operator file id, network:date

opening_amountinteger or nullOptional

The statement's opening balance, when the source reports one

received_atstring · date-timeOptional
reserve_interest_creditsarray of objectsOptional

ReserveInterestCredits answers the Federal Reserve account report that carried them, in the order the report listed them; reads of a stored statement leave it empty.

10 child attributes
amountintegerRequired
detailstringOptional
directionstringRequired
expected_amountintegerOptional

The period's accrual, to the cent

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

period_endstring · dateRequired

A business date, YYYY-MM-DD

period_startstring · dateRequired

A business date, YYYY-MM-DD

referencestringRequired
settlement_idintegerOptional
statusstringRequired
sourcestringRequired

Fed_master, rtp or card_network

superseded_atstring · date-time or nullOptional
versionintegerOptional

Versions of one source and date are retained; a later one supersedes

Errors

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

400401403404409412413422424429500503

to move to open esc to close