Post a payment the SWIFT gateway settles through a nostro account: the journal and the references the statement will carry, in one idempotent transaction
/ledger/correspondent/movementsThe SWIFT gateway service (svc_payments) reaches this route with one scope and nothing else of the ledger's: ledger:correspondent:route reads settlement routes, ledger:correspondent:post posts movements, ledger:correspondent:statement delivers cash management messages. The ledger writes the nostro entry from the movement itself and posts the counter entries beside it (none puts the other side on payments in transit and suspense in the movement's currency), retains the references the correspondent's statement will carry and records the charge the terms expect. The Idempotency-Key replays the same movement and journal; another request under the same key is refused. A debit needs an open account at an active correspondent.
Headers
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
amountintegerRequiredcharge_bearerstringOptionalcounter_entriesarray of objectsOptionalCounterEntries 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
amountintegerRequireddirectionstringRequiredDebit or credit
ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
currency_codestringRequireddirectionstringRequiredCredit or debit, as the account moves at the correspondent
effective_datestring · dateOptionalA business date, YYYY-MM-DD
end_to_end_idstringOptionalinstruction_idstringOptionaljournal_kindstringRequiredkindstringRequiredCustomer_transfer, bank_transfer, cover, return or funding
message_idstringOptionalnostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
original_movement_idstringOptionalA return: the movement it returns
prepaid_charges_amountintegerOptionalPrepaidChargesMinor 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.
reasonstringOptionalrelease_hold_idstringOptionalA customer's hold the debit consumes
Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
source_refstringRequireduetrstringOptionalvalue_datestring · dateRequiredA business date, YYYY-MM-DD
Returns
200 OK
amountintegerRequiredcharge_bearerstringOptionalcounter_entriesarray of objectsOptionalCounterEntries 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
amountintegerRequireddirectionstringRequiredDebit or credit
ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
currency_codestringRequireddirectionstringRequiredCredit or debit, as the account moves at the correspondent
effective_datestring · dateOptionalA business date, YYYY-MM-DD
end_to_end_idstringOptionalentry_sequenceintegerRequiredexpected_chargeobject or nullOptionalExpectedCharge 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_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredbillingstringRequiredcharge_bearerstringOptionalcharge_datestring · dateRequiredA business date, YYYY-MM-DD
codestringRequiredPayment_charge or the monthly fee code
created_atstring · date-timeRequiredcurrency_codestringRequireddirectionstringOptionalidstringRequiredinvoice_idstringOptionalmovement_idstringOptionalnostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
periodstringOptionalYYYY-MM, a monthly fee
posting_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
sourcestringRequiredstatement_item_refstringOptionalstatusstringRequiredterms_idintegerRequireduetrstringOptionalupdated_atstring · date-timeRequiredidstringRequiredinstruction_idstringOptionaljournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_kindstringRequiredkindstringRequiredCustomer_transfer, bank_transfer, cover, return or funding
message_idstringOptionalnostro_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
original_movement_idstringOptionalA return: the movement it returns
prepaid_charges_amountintegerOptionalPrepaidChargesMinor 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.
reasonstringOptionalregistered_atstring · date-timeRequiredregistered_bystringRequiredrelease_hold_idstringOptionalA customer's hold the debit consumes
Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
sourcestringRequiredThe posting service
source_refstringRequireduetrstringOptionalvalue_datestring · dateRequiredA business date, YYYY-MM-DD
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503