Read an international wire with every message exchanged about it, its tracking events, cancellation cases and returns
/transfers/international-wire/{id}/detailPath parameters
idstringRequiredReturns
200 OK
cancellationsarray of objectsRequired17 child attributes
assignment_idstringRequiredcase_idstringRequiredExample case_2tVh8nqLxq4GbDe0K1F6S9zRcWm
counterparty_bicstringRequiredcreated_atstring · date-timeRequireddirectionstringRequiredidstringRequirednetwork_refstringOptionalpayment_idstringRequiredExample lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringOptionalreason_codestringRequiredrequested_bystringRequiredresolutionstringOptionalresolution_reasonstringOptionalresolution_reason_codestringOptionalreturn_payment_idstringOptionalExample lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm
statusstringRequiredupdated_atstring · date-timeRequiredmessagesarray of objectsRequired19 child attributes
biz_msg_idstringRequiredcancellation_idstringOptionalcreated_atstring · date-timeRequireddirectionstringRequiredidintegerRequiredmsg_defstringRequirednetwork_refstringOptionalnetwork_statusstringRequiredpayment_idstringOptionalExample lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm
possible_duplicatebooleanOptionalraw_sha256stringRequiredreceiver_bicstringRequiredrefusal_codestringOptionalrefusal_reasonstringOptionalrolestringRequiredsender_bicstringRequireduetrstringOptionalupdated_atstring · date-timeRequiredviolationsarray of objectsOptional3 child attributes
detailstringRequiredelementstringRequiredrulestringRequiredpaymentobjectRequiredSwiftPayment is a SWIFT payment in either direction: a customer transfer, a bank transfer or a return.
57 child attributes
account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredThe instructed amount
approved_bystringOptionalcharge_bearerstringOptionalcorrespondent_bicstringOptionalThe next agent outbound, the previous one inbound
cover_bicstringOptionalcover_msg_idstringOptionalcover_network_refstringOptionalcover_network_statusstringOptionalcreated_atstring · date-timeRequiredcreditorobjectRequiredParty 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
creditor_agent_bicstringOptionalcurrency_codestringRequiredcustomer_idstringOptionalExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
debit_amountintegerOptionalOutbound: the amount, the bank's fee and prepaid charges
debtorobjectRequiredParty 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
debtor_agent_bicstringOptionaldeducted_charges_amountintegerOptionaldirectionstringRequiredOutbound or inbound
end_to_end_idstringOptionalfee_amountintegerOptionalfx_quote_idstringOptionalgl_codestringOptionalhold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredinstr_idstringOptionalintermediary_bicstringOptionaljournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredCustomer, bank or return
ledger_account_idstringOptionalExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
msg_idstringOptionalnetwork_refstringOptionalnetwork_statusstringOptionaloperatorstringOptionaloriginal_payment_idstringOptionalExample lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm
prepaid_charges_amountintegerOptionalpurposestringOptionalqueued_untilstring · date-time or nullOptionalreasonstringOptionalremittancestringOptionalrepair_idstringOptionalreturn_reasonstringOptionalreturn_reason_codestringOptionalreturned_amountintegerOptionalreversal_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
screening_idstringOptionalExample scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm
screening_resultstringOptionalsettlement_amountintegerRequiredsettlement_methodstringOptionalINDA, INGA or COVE
statusstringRequiredReceived, held_for_review, queued, sending, sent, completed, repair, rejected, returned, cancelled, credited or blocked
tracker_reasonstringOptionaltracker_statusstringOptionaluetrstringRequiredultimate_creditorobjectRequiredParty 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_debtorobjectRequiredParty 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
updated_atstring · date-timeRequiredvalue_datestring · date or nullOptionalA business date, YYYY-MM-DD
returnsarray of objectsRequired57 child attributes
account_idstringOptionalExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredThe instructed amount
approved_bystringOptionalcharge_bearerstringOptionalcorrespondent_bicstringOptionalThe next agent outbound, the previous one inbound
cover_bicstringOptionalcover_msg_idstringOptionalcover_network_refstringOptionalcover_network_statusstringOptionalcreated_atstring · date-timeRequiredcreditorobjectRequiredParty 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
creditor_agent_bicstringOptionalcurrency_codestringRequiredcustomer_idstringOptionalExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
debit_amountintegerOptionalOutbound: the amount, the bank's fee and prepaid charges
debtorobjectRequiredParty 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
debtor_agent_bicstringOptionaldeducted_charges_amountintegerOptionaldirectionstringRequiredOutbound or inbound
end_to_end_idstringOptionalfee_amountintegerOptionalfx_quote_idstringOptionalgl_codestringOptionalhold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
idstringRequiredinstr_idstringOptionalintermediary_bicstringOptionaljournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredCustomer, bank or return
ledger_account_idstringOptionalExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
msg_idstringOptionalnetwork_refstringOptionalnetwork_statusstringOptionaloperatorstringOptionaloriginal_payment_idstringOptionalExample lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm
prepaid_charges_amountintegerOptionalpurposestringOptionalqueued_untilstring · date-time or nullOptionalreasonstringOptionalremittancestringOptionalrepair_idstringOptionalreturn_reasonstringOptionalreturn_reason_codestringOptionalreturned_amountintegerOptionalreversal_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
screening_idstringOptionalExample scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm
screening_resultstringOptionalsettlement_amountintegerRequiredsettlement_methodstringOptionalINDA, INGA or COVE
statusstringRequiredReceived, held_for_review, queued, sending, sent, completed, repair, rejected, returned, cancelled, credited or blocked
tracker_reasonstringOptionaltracker_statusstringOptionaluetrstringRequiredultimate_creditorobjectRequiredParty 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_debtorobjectRequiredParty 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
updated_atstring · date-timeRequiredvalue_datestring · date or nullOptionalA business date, YYYY-MM-DD
trackerarray of objectsRequired6 child attributes
confirmed_atstring · date-time or nullOptionaleventobjectRequiredTrackerEvent is one status a party in the chain recorded against a UETR.
12 child attributes
agent_bicstringRequiredWho reported the status
amountintegerOptionalThe amount the agent confirmed (credited, or forwarded)
charges_amountintegerOptionalCharges the agent deducted
charges_currency_codestringOptionalcurrency_codestringOptionalexchange_ratestringOptionalforwarded_to_bicstringOptionaloccurred_atstring · date-timeRequiredreasonstringOptionalA G code on ACSP, an ExternalStatusReason1Code on RJCT
source_messagestringOptionalThe message definition behind the status, when there is one
statusstringRequiredACSP, ACSC, ACCC or RJCT
uetrstringRequiredidintegerRequiredpayment_idstringOptionalExample lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm
recorded_atstring · date-timeRequiredsourcestringRequiredNetwork, bank or message
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503