Create an international wire
/transfers/international-wireSend an international wire from an account: a CBPR+ customer credit transfer (pacs.008) to the creditor's agent, through the simulated international messaging network
Headers
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
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredMinor units of the currency (cents for USD)
charge_bearerstringOptionalDEBT, CRED or SHAR (the default)
confirm_duplicatebooleanOptionalcreditorobjectRequiredName, structured or hybrid address (town and country) and account (IBAN or other)
9 child attributes
accountstringOptionalAn IBAN when its check digits pass, another identifier otherwise
addressobjectRequiredAddress is a postal address in the elements of PostalAddress24.
15 child attributes
building_namestringOptionalbuilding_numberstringOptionalcountrystringOptionalcountry_sub_divisionstringOptionaldepartmentstringOptionaldistrict_namestringOptionalfloorstringOptionallinesarray of stringsOptionalpost_boxstringOptionalpost_codestringOptionalroomstringOptionalstreet_namestringOptionalsub_departmentstringOptionaltown_location_namestringOptionaltown_namestringOptionalany_bicstringOptionalcountry_of_residencestringOptionalleistringOptionalnamestringOptionalother_idstringOptionalother_id_schemestringOptionalExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code
privatebooleanOptionalThe other identification is a person's (PrvtId), not an organisation's
creditor_agent_bicstringRequiredcurrency_codestringRequiredISO 4217 code
end_to_end_idstringOptionalNOTPROVIDED when empty
fx_quote_idstringOptionalA foreign exchange quote booked elsewhere in the bank
intermediary_bicstringOptionalpurposestringOptionalExternalPurpose1Code
remittancestringOptionalUp to 140 characters
ultimate_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.
15 child attributes
building_namestringOptionalbuilding_numberstringOptionalcountrystringOptionalcountry_sub_divisionstringOptionaldepartmentstringOptionaldistrict_namestringOptionalfloorstringOptionallinesarray of stringsOptionalpost_boxstringOptionalpost_codestringOptionalroomstringOptionalstreet_namestringOptionalsub_departmentstringOptionaltown_location_namestringOptionaltown_namestringOptionalany_bicstringOptionalcountry_of_residencestringOptionalleistringOptionalnamestringOptionalother_idstringOptionalother_id_schemestringOptionalExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code
privatebooleanOptionalThe other identification is a person's (PrvtId), not an organisation's
ultimate_debtorobject 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.
15 child attributes
building_namestringOptionalbuilding_numberstringOptionalcountrystringOptionalcountry_sub_divisionstringOptionaldepartmentstringOptionaldistrict_namestringOptionalfloorstringOptionallinesarray of stringsOptionalpost_boxstringOptionalpost_codestringOptionalroomstringOptionalstreet_namestringOptionalsub_departmentstringOptionaltown_location_namestringOptionaltown_namestringOptionalany_bicstringOptionalcountry_of_residencestringOptionalleistringOptionalnamestringOptionalother_idstringOptionalother_id_schemestringOptionalExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code
privatebooleanOptionalThe other identification is a person's (PrvtId), not an organisation's
Returns
201 Created
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503