{
"id": "wire_xyz123",
"account_id": "account_xyz123",
"account_number_id": "account_number_xyz123",
"created_at": "ISO-8601",
"updated_at": "ISO-8601",
"settlement_date": "YYYY-MM-DD",
"direction": "enum(incoming|outgoing)",
"type": "enum(transfer|return)",
"status": "enum(created|scheduled|processing|posted|under_review|rejected|canceled|cancel_pending)",
"amounts": {
"settlement_amount": 20000,
"settlement_currency_code": "USD",
"instructed_amount": 15500,
"instructed_currency_code": "USD",
"instructed_to_settlement_exchange_rate": "1.29"
},
"debtor": {
"name": "Alex Smith",
"account_identifier": {
"type": "enum(IBAN|other)",
"value": "1234567890"
},
"address": {
"department": "string",
"sub_department": "string",
"street_name": "string",
"building_number": "string",
"building_name": "string",
"floor": "string",
"post_box": "string",
"room": "string",
"post_code": "string",
"town_name": "string",
"town_location_name": "string",
"district_name": "string",
"country_sub_division": "string",
"country": "string",
"line_one": "string",
"line_two": "string",
"line_three": "string"
}
},
"debtor_agent": {
"business_identifier_code": "CHASUS33",
"name": "JPMorgan Chase Bank",
"routing_number": "987654321",
"address": { ... },
"local_routing_identifier": {
"scheme": "string",
"value": "string"
}
},
"instructing_agent": {
"name": "Lead Bank",
"routing_number": "123456789",
"business_identifier_code": "CHASUS33"
},
"instructed_agent": {
"name": "JPMorgan Chase Bank",
"routing_number": "987654321",
"business_identifier_code": "CHASUS33"
},
"creditor_agent": {
"business_identifier_code": "CHASUS33",
"name": "JPMorgan Chase Bank",
"routing_number": "987654321",
"address": { ... },
"local_routing_identifier": {
"scheme": "string",
"value": "string"
}
},
"creditor": {
"name": "Alex Smith",
"account_identifier": {
"type": "enum(IBAN|other)",
"value": "1234567890"
},
"address": { ... }
},
"ultimate_debtor": {
"name": "string",
"account_identifier": {
"type": "enum(IBAN|other)",
"value": "1234567890"
},
"address": { ... }
},
"ultimate_creditor": {
"name": "string",
"account_identifier": {
"type": "enum(IBAN|other)",
"value": "1234567890"
},
"address": { ... }
},
"other_agents": {
"previous_instructing_agent_one": { ... },
"previous_instructing_agent_two": { ... },
"previous_instructing_agent_three": { ... },
"intermediary_agent_one": { ... },
"intermediary_agent_two": { ... },
"intermediary_agent_three": { ... }
},
"payment_identifiers": {
"message_identification": "20231215MMQFMP2L017726",
"end_to_end_identification": "string",
"uetr": "e331acb3-e23f-42f4-8815-43da484a939b",
"instruction_identification": "string",
"return_identification": "string"
},
"remittance_details": {
"payment_notification": "string",
"message_to_creditor": "string",
"message_to_receiving_fi": "string",
"fi_to_fi_message": "string",
"transfer_purpose": {
"type": "enum(salary_payment|invoice_payment|gift|payment_for_goods|payment_for_services|insurance_premium_payment|interest_payment|loan|loan_repayment|account_management|cash_management_transfer|other|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_details": "string"
}
},
"charges": {
"charge_bearer": "enum(debtor|shared|creditor)",
"breakdown": [
{
"amount": "string",
"currency_code": "USD",
"charging_agent": {
"business_identifier_code": "string",
"name": "string",
"routing_number": "string",
"address": { ... },
"local_routing_identifier": {
"scheme": "string",
"value": "string"
}
}
}
]
},
"related_wires": {
"original_wire_id": "wire_xyz321",
"return_wire_ids": ["wire_xyz456"]
},
"return": {
"reason": "enum(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)",
"code": "string",
"additional_information": "string"
},
"rejection": {
"reason": "enum(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)",
"additional_information": "string",
"message_identification": "string"
},
"return_requests": [
{
"created_at": "ISO-8601",
"status": "enum(response_needed|pending|accepted|rejected)",
"reason": "enum(creditor_account_number_invalid|wrong_amount|customer_requested|duplication|fraud_suspected|narrative|technical_problem|undue_payment|per_agent_request|other)",
"details": "string",
"deadline": "ISO-8601",
"resolution": {
"resolved_at": "ISO-8601",
"resolved_by": "enum(lead|client|counterparty)",
"rejection_reason": "enum(account_closed|non_sufficient_funds|customer_requested|legal_decision|customer_no_response|returned_previously|narrative|per_agent_request|other)",
"rejection_details": "string"
}
}
],
"metadata": {}
}
Wire
The Wire Object
Field-level reference for the Wire object across V1 and V2, including debtor/creditor details and return-request entries.