--- title: "Update a wire V2" method: PATCH path: "/v2/wires/{wire_id}" tags: ["Wire"] --- # Update a wire V2 `PATCH /v2/wires/{wire_id}` Update a wire. ## Path parameters - `wire_id` string, required ## Headers - `Idempotency-Key` string, required ## Request body - object - `metadata` Metadata — A set of key-value pairs that can be used to store additional information related to this object. ## Response `200` Updated wire object. - WireV2 — A wire object. - `id` string — Unique identifier of the wire object. - `account_number_id` string — The ID of the Lead Bank Account Number object. - `core_transaction_ids` string[] — Linked core transaction ID(s) associated with the wire. - `created_at` string, date-time — ISO 8601 format timestamp representing when the wire object was created. - `updated_at` string, date-time — ISO 8601 format timestamp representing when the wire object was last updated. - `settlement_date` string, date — The ISO-8601 datestamp indicating the wire settlement date based on Fedwire's business day definition. - `direction` 'outgoing' | 'incoming' — Who is initiating the transaction. outgoing: You are sending a wire transaction to a counterparty. incoming: You are receiving an wire transaction from a counterparty. - `type` 'transfer' | 'return' — Indicates the type of wire message that the object represents. - `corridor_type` 'domestic' | 'international' — Indicates whether the wire is domestic or international. - `status` 'created' | 'scheduled' | 'processing' | 'posted' | 'under_review' | 'rejected' | 'canceled' | 'cancel_pending' — The current status of the wire object. - `amounts` WireAmounts - `settlement_amount` integer — The amount of the wire transaction in cents. - `settlement_currency_code` 'USD' — A three-letter currency code as defined in ISO 4217. - `instructed_amount` integer — The amount of the wire transaction in cents. - `instructed_currency_code` string — The currency code of the instructed amount. A three-letter currency code as defined in ISO 4217. - `instructed_to_settlement_exchange_rate` string — Factor used to convert an amount from the instructed currency to the settlement currency. - `debtor` WireParty — Wire party information. - `name` string — Name of the party. - `account_identifier` WirePartyAccountIdentifier — Object representing the account that the party holds at its financial institution - `type` 'other' | 'IBAN' — The type of account identifier. - `value` string — The value of the account identifier where the wire is being sent. For U.S. domestic wires, this should always be the full account number. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `debtor_agent` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `instructing_agent` WireInstructAgentV2 — Wire instruct agent information. - `name` string — Name of the financial institution. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `instructed_agent` WireInstructAgentV2 — Wire instruct agent information. - `name` string — Name of the financial institution. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `creditor_agent` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `creditor` WireParty — Wire party information. - `name` string — Name of the party. - `account_identifier` WirePartyAccountIdentifier — Object representing the account that the party holds at its financial institution - `type` 'other' | 'IBAN' — The type of account identifier. - `value` string — The value of the account identifier where the wire is being sent. For U.S. domestic wires, this should always be the full account number. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `initiating_party` WireParty — Wire party information. - `name` string — Name of the party. - `account_identifier` WirePartyAccountIdentifier — Object representing the account that the party holds at its financial institution - `type` 'other' | 'IBAN' — The type of account identifier. - `value` string — The value of the account identifier where the wire is being sent. For U.S. domestic wires, this should always be the full account number. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `ultimate_debtor` WireParty — Wire party information. - `name` string — Name of the party. - `account_identifier` WirePartyAccountIdentifier — Object representing the account that the party holds at its financial institution - `type` 'other' | 'IBAN' — The type of account identifier. - `value` string — The value of the account identifier where the wire is being sent. For U.S. domestic wires, this should always be the full account number. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `ultimate_creditor` WireParty — Wire party information. - `name` string — Name of the party. - `account_identifier` WirePartyAccountIdentifier — Object representing the account that the party holds at its financial institution - `type` 'other' | 'IBAN' — The type of account identifier. - `value` string — The value of the account identifier where the wire is being sent. For U.S. domestic wires, this should always be the full account number. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `other_agents` WireOtherAgentsV2 — Details of any other agents involved in the wire transfer. - `previous_instructing_agent_one` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `previous_instructing_agent_two` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `previous_instructing_agent_three` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `intermediary_agent_one` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `intermediary_agent_two` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `intermediary_agent_three` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `payment_identifiers` WirePaymentIdentifiers — Wire payment identifiers. - `message_identification` string — Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.. - `end_to_end_identification` string — Unique identification that the initiating party in a wire message can use to unambiguously identify the transaction. This is passed through, unchanged, throughout the entire wire chain. - `uetr` string, uuid — Universally unique identifier to provide an end-to-end reference of a payment transaction. - `instruction_identification` string — Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. - `return_identification` string — Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the returned transaction. - `remittance_details` WireRemittanceDetails — Wire remittance details. - `payment_notification` string — Information about the payment notification. - `message_to_creditor` string — Information intended specifically for the creditor. - `message_to_receiving_fi` string — Information intended specifically for the receiving financial institution. - `fi_to_fi_message` string — Financial institution to financial institution information, most often used by a financial institution to explain additional detail of a wire. - `transfer_purpose` WireTransferPurposeV1 — The purpose or reason for which the wire is being sent. - `type` 'salary_payment' | 'invoice_payment' | 'gift' | 'payment_for_goods' | 'payment_for_services' | 'insurance_premium_payment' | 'interest_payment' | 'loan' | 'loan_repayment' | 'account_management' | 'cash_management_transfer' | 'tax_payment' | 'government_payment' | 'benefits_payment' | 'pension_payment' | 'rent_payment' | 'utilities_payment' | 'education_payment' | 'healthcare_payment' | 'charitable_payment' | 'refund' | 'fee_payment' | 'intercompany_transfer' | 'investment_payment' | 'fx_or_treasury' | 'derivatives_payment' | 'card_network_settlement' | 'other', required — Code representing the purpose of the transfer. - `other_details` string — Free-formatted text for wire sender if `other` is selected for `type`. - `charges` WireChargesV2 — Information about charges associated with the wire transfer. - `charge_bearer` 'debtor' | 'shared' | 'creditor' — Specifies which party bears the charges associated with the wire transfer. - `breakdown` WireChargeInfoV2[] — Itemized list of charges assessed during wire transfer processing. - `amount` string, required — The amount of the charge. - `currency_code` string, required — ISO 4217 three-letter currency code for the charge. - `charging_agent` WireAgentV2 — Wire agent information. - `business_identifier_code` string — Business Identifier Code (BIC) of the financial institution. - `name` string — Name of the financial institution. - `local_routing_identifier` LocalRoutingIdentifier — Routing or transit code used by the financial institution's local clearing system for international wire transfers, such as a sort code, IFSC, or BSB. - `scheme` string — The scheme or type of the local routing identifier (e.g. GBDSC for UK sort codes). - `value` string — The value of the local routing identifier. - `address` WirePostalAddress - `department` string — Identification of a division of a large organization or building. - `sub_department` string — Identification of a sub-division of a large organization or building. - `street_name` string — Name of a street or thoroughfare. - `building_number` string — Number that identifies the position of a building on a street. - `building_name` string — Name of the building or house. - `floor` string — Floor or storey within a building. - `post_box` string — Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. - `room` string — Building room number. - `post_code` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `town_name` string — Name of a built-up area, with defined boundaries, and a local government. - `town_location_name` string — Specific location name within the town. Note that this field is not commonly used for US-based addresses. - `district_name` string — Identifies a subdivision within a country sub-division. Note that this field is not commonly used for US-based addresses. - `country_sub_division` string — Identifies a subdivision of a country such as state, region, county. - `country` string — ISO 3166, alpha-2 code representing a nation with its own government. - `line_one` string — Line one address of the party represented in an unstructured format. - `line_two` string — Line two address of the party represented in an unstructured format. - `line_three` string — Line three address of the party represented in an unstructured format. - `related_wires` RelatedWiresV1 — Related wire objects. - `original_wire_id` string — If this wire is a return wire (i.e., returning a wire previously received), this field will provide the preceding wire's identifier (wire_id). - `return_wire_ids` string[] — If this wire has been returned by any following wires, you can find the returning wire id(s) here. - `return_requests` WireReturnRequest[] — Return requests associated with the wire, sorted oldest first. Empty when no return requests exist. - `created_at` string, date-time, required — ISO 8601 timestamp when the return request was created. - `status` 'response_needed' | 'pending' | 'accepted' | 'rejected', required — Current status of the return request. - For incoming return requests: `response_needed`, `accepted`, `rejected`. - For outgoing return requests: `pending`, `accepted`, `rejected`. `accepted` and `rejected` are terminal. - `reason` 'creditor_account_number_invalid' | 'wrong_amount' | 'customer_requested' | 'duplication' | 'fraud_suspected' | 'narrative' | 'technical_problem' | 'undue_payment' | 'per_agent_request' | 'other', required — Reason for the return request. - `creditor_account_number_invalid` — ISO `AC03`. Wire was sent to the wrong account number. - `wrong_amount` — ISO `AM09`. Wire amount is not the agreed amount or expected. - `customer_requested` — ISO `CUST`. The partner's end customer requested the return. - `duplication` — ISO `DUPL`. Duplicate wire sent. - `fraud_suspected` — ISO `FRAD`. Fraud suspected. - `narrative` — ISO `NARR`. Catch-all when no structured reason fits; details field carries the explanation. - `technical_problem` — ISO `TECH`. A technical issue caused the wire to be sent. - `undue_payment` — ISO `UPAY`. Payment was not due or for services not performed. - `per_agent_request` — ISO `AGNT`. Incoming only — Lead is the agent for outgoing payments. - `other` — Incoming only. Catch-all for unmapped ISO codes received from the counterparty. - `details` string — Details of the reason for the return request including the 4-character ISO code when possible. - `deadline` string, date-time — The deadline by which a final response to the return request is expected. For incoming return requests, you must respond by 11:30PM ET on the 10th business day. If you do not respond, we will respond on your behalf with a rejection at midnight. For outgoing return requests, this field will not be populated. - `resolution` WireReturnRequestResolution — Resolution details. Populated once the return request reaches a terminal status (`accepted` or `rejected`). - `resolved_at` string, date-time — ISO 8601 timestamp when the resolution occurred. - `resolved_by` 'lead' | 'client' | 'counterparty' — The party that resolved the return request. - `lead` — Resolved by Lead through validation or manual review. - `client` — Resolved by the partner via API or by initiating a return. - `counterparty` — Resolved by the counterparty financial institution's response. Outgoing return requests only. - `rejection_reason` 'account_closed' | 'non_sufficient_funds' | 'customer_requested' | 'legal_decision' | 'customer_no_response' | 'returned_previously' | 'narrative' | 'per_agent_request' | 'other' — Reason the return request was rejected. - `account_closed` — ISO `AC04`. - `non_sufficient_funds` — ISO `AM04`. - `customer_requested` — ISO `CUST`. Customer declined the return. - `legal_decision` — ISO `LEGL`. - `customer_no_response` — ISO `NOAS`. Customer did not respond by the deadline. - `returned_previously` — ISO `ARDT`. Wire already fully returned. Auto-set by Lead when applicable. - `narrative` — ISO `NARR`. Catch-all; details field carries the explanation. - `per_agent_request` — ISO `AGNT`. Incoming only. - `other` — Incoming only. Catch-all for unmapped ISO codes received from the counterparty. - `rejection_details` string — Free-text explanation of the rejection. For incoming responses, includes the original 4-character ISO code. - `return` WireReturnV2 — Return details associated with a returned wire. - `reason` 'account_number_incorrect' | 'creditor_account_number_invalid' | 'account_closed' | 'account_blocked' | 'debtor_account_type_invalid' | 'agent_invalid' | 'account_details_changed' | 'account_sequestered' | 'account_liquidated' | 'transaction_forbidden' | 'bank_operation_code_invalid' | 'zero_amount' | 'amount_too_high' | 'currency_not_allowed' | 'non_sufficient_funds' | 'duplication' | 'amount_too_low' | 'amount_blocked' | 'wrong_amount' | 'control_sum_invalid' | 'returned_previously' | 'creditor_name_mismatch' | 'creditor_address_incorrect' | 'initiating_party_unrecognized' | 'unknown_customer' | 'debtor_address_invalid' | 'bank_error' | 'authorization_canceled' | 'creditor_bank_not_registered' | 'currency_incorrect' | 'customer_requested' | 'debtor_bank_not_registered' | 'return_for_technical_reason' | 'settlement_date_invalid' | 'correspondent_bank_unattainable' | 'balance_information_requested' | 'settlement_failed' | 'emv_liability_shifted' | 'eri_option_unsupported' | 'local_instrument_code_invalid' | 'honor_return_request' | 'fraud_suspected' | 'final_response_mandate_canceled' | 'no_mandate' | 'missing_mandate_information' | 'end_customer_requested' | 'end_customer_deceased' | 'creditor_request' | 'per_agent_request' | 'narrative' | 'customer_no_response' | 'non_compliant' | 'transaction_not_found' | 'pin_liability_shifted' | 'routing_number_format_incorrect' | 'creditor_bic_incorrect' | 'transaction_reference_not_unique' | 'missing_debtor_account_number' | 'missing_debtor_data' | 'missing_creditor_data' | 'regulatory_reason' | 'returned_unable_to_apply' | 'debtor_agent_specific_service' | 'creditor_agent_specific_service' | 'creditor_not_whitelisted_by_debtor' | 'creditor_blacklisted_by_debtor' | 'direct_debit_count_exceeded' | 'direct_debit_limit_exceeded' | 'payment_stopped' | 'payment_stopped_previously' | 'service_not_rendered' | 'untimely_transaction' | 'removed_from_tracking' | 'undue_payment' | 'other' — Reason to return a wire payment. - `additional_information` string — If the return reason is `narrative`, an accompanying free-form explanation is required and will appear here. When the reason is `other`, this is populated with the raw ISO code in the format "ISO Code: ;
". For other reasons, participants may optionally send additional information as well. - `rejection` WireRejectionReasonV1 - `reason` 'account_blocked' | 'account_closed' | 'account_number_incorrect' | 'amount_blocked' | 'creditor_account_number_invalid' | 'creditor_address_incorrect' | 'creditor_name_mismatch' | 'creditor_request' | 'debtor_address_invalid' | 'honor_return_request' | 'narrative' | 'per_agent_request' | 'non_sufficient_funds' | 'regulatory_reason' | 'routing_number_format_incorrect' | 'aggregate_limit_exceeded' — Reason to return a wire payment. - `additional_information` string — If the rejection reason is “narrative”, then an accompanying free-form explanation is required and will appear here. For other reasons, participants may optionally send additional information as well. - `message_identification` string — Input Message Accountability Data (IMAD), a unique identifier available to originating and receiving banks of a wire message. - `metadata` Metadata — A set of key-value pairs that can be used to store additional information related to this object. ## Other responses - `400` — Your request parameters did not validate. - `404` — wire_id passed in is not a valid wire object. - `422` — We couldn't parse your request body, please check that your request body is valid JSON. --- [API](https://skmtc.net/lead/apis/lead-bank.md) · [All operations](https://skmtc.net/lead/apis/lead-bank/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lead/lead-bank/revisions/25c2a92d55e2/schema)