Read a movement and the charge expected on it

GET/ledger/correspondent/movements/{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

amountintegerRequired

charge_bearerstringOptional

counter_entriesarray of objectsOptional

CounterEntries are the other side of the journal, netting against the nostro entry; none puts the other side on the bank's payments in transit and suspense account (GL 2320) in the movement's currency, where the leg that converts or pays it out picks it up.

3 child attributes

amountintegerRequired

directionstringRequired

Debit or credit

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

currency_codestringRequired

directionstringRequired

Credit or debit, as the account moves at the correspondent

effective_datestring · dateOptional

A business date, YYYY-MM-DD

end_to_end_idstringOptional

entry_sequenceintegerRequired

expected_chargeobject or nullOptional

ExpectedCharge is a correspondent charge the bank expects under the reviewed terms: one for a payment the SWIFT gateway posted, or a monthly fee for a period.

21 child attributes

accrual_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

billingstringRequired

charge_bearerstringOptional

charge_datestring · dateRequired

A business date, YYYY-MM-DD

codestringRequired

Payment_charge or the monthly fee code

created_atstring · date-timeRequired

currency_codestringRequired

directionstringOptional

idstringRequired

invoice_idstringOptional

movement_idstringOptional

nostro_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

periodstringOptional

YYYY-MM, a monthly fee

posting_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

sourcestringRequired

statement_item_refstringOptional

statusstringRequired

terms_idintegerRequired

uetrstringOptional

updated_atstring · date-timeRequired

idstringRequired

instruction_idstringOptional

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_kindstringRequired

kindstringRequired

Customer_transfer, bank_transfer, cover, return or funding

message_idstringOptional

nostro_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

original_movement_idstringOptional

A return: the movement it returns

prepaid_charges_amountintegerOptional

PrepaidChargesMinor is what a DEBT transfer added to the settlement amount to prepay the chain's charges; the correspondent's own charge is then taken from it and not billed again.

reasonstringOptional

registered_atstring · date-timeRequired

registered_bystringRequired

release_hold_idstringOptional

A customer's hold the debit consumes

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

sourcestringRequired

The posting service

source_refstringRequired

uetrstringOptional

value_datestring · dateRequired

A business date, YYYY-MM-DD

Errors

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

400401403404409412413422424429500503