Propose returning a credited international wire the bank received (pacs.004); a second operator approves it in the repair queue
/transfers/international-wire/{id}/returnsPath parameters
idstringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
amountintegerOptionalnotestringOptionaloperatorstringOptionalreasonstringOptionalreason_codestringRequiredExternalReturnReason1Code
Returns
200 OK
actionsarray of stringsRequiredcancellation_idstringOptionalcreated_atstring · date-timeRequireddecided_atstring · date-time or nullOptionaldecided_bystringOptionalidstringRequiredkindstringRequiredoutcomestringOptionalpayment_idstringOptionalExample lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm
proposalobject or nullOptionalSwiftRepairProposal is a maker's proposed decision on a repair.
10 child attributes
account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
actionstringRequiredamountintegerOptionalcorrectionsobject or nullOptionalSwiftCorrections are what a resend from the repair queue may correct.
3 child attributes
creditorobject or nullOptionalParty is a debtor, creditor or ultimate party: a name and address, or a BIC, with an account and further identification. The Travel Rule (31 CFR 1010.410(f)) data of a transmittal of funds travels in these fields.
9 child attributes
accountstringOptionalAn IBAN when its check digits pass, another identifier otherwise
addressobjectRequiredAddress is a postal address in the elements of PostalAddress24.
any_bicstringOptionalcountry_of_residencestringOptionalleistringOptionalnamestringOptionalother_idstringOptionalother_id_schemestringOptionalExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code
privatebooleanOptionalThe other identification is a person's (PrvtId), not an organisation's
creditor_agent_bicstringOptionalremittancestring or nullOptionalgl_codestringOptionalmakerstringRequirednotestringOptionalproposed_atstring · date-timeRequiredreasonstringOptionalreason_codestringOptionalreasonstringRequiredstatusstringRequiredOpen, proposed, executing or resolved
updated_atstring · date-timeRequiredviolationsarray of objectsOptional3 child attributes
detailstringRequiredelementstringRequiredrulestringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503