Read a retained page with its entries

GET/ledger/correspondent/statements/{id}

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

completebooleanRequired

A camt.053 whose every page to the last is retained

idstringRequired

message_sha256stringRequired

nostro_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

pageobjectRequired

NormalizedStatement is a report, statement or notification page read at its currency's scale.

25 child attributes

account_identifierstringRequired

account_is_ibanbooleanOptional

closing_available_amountinteger or nullOptional

closing_booked_amountinteger or nullOptional

closing_booked_datestringOptional

created_atstringOptional

currency_codestringRequired

cyclestringOptional

electronic_sequenceinteger or nullOptional

entriesarray of objectsRequired

27 child attributes

additional_infostringOptional

amountintegerRequired

booking_datestringOptional

YYYY-MM-DD, the date part of a date-time

charge_bearerstringOptional

currency_codestringRequired

directionstringRequired

Credit or debit

domainstringOptional

end_to_end_idstringOptional

entry_referencestringOptional

familystringOptional

included_charges_amountintegerOptional

Charges records marked included in the amount

indexintegerRequired

Zero-based position of the entry on its page

instruction_idstringOptional

interest_fromstringOptional

interest_tostringOptional

message_idstringOptional

owner_transaction_idstringOptional

proprietary_codestringOptional

proprietary_issuerstringOptional

remittancestringOptional

reversalbooleanOptional

servicer_referencestringOptional

statusstringRequired

BOOK, PDNG or INFO

sub_familystringOptional

transaction_idstringOptional

uetrstringOptional

value_datestringOptional

from_datestringOptional

YYYY-MM-DD

interim_atstringOptional

interim_available_amountinteger or nullOptional

interim_booked_amountinteger or nullOptional

last_pagebooleanRequired

legal_sequencestringOptional

message_created_atstringRequired

message_definitionstringRequired

message_idstringRequired

opening_booked_amountinteger or nullOptional

Signed: a debit balance is negative

opening_booked_datestringOptional

page_numberintegerRequired

servicer_bicstringOptional

statement_idstringRequired

to_datestringOptional

received_atstring · date-timeRequired

received_bystringRequired

sourcestringRequired

Pull:<adapter>, gateway or staff

Errors

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

400401403404409412413422424429500503