{
"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": "20231215MMQFMP2L017736",
"end_to_end_identification": "string",
"uetr": "e331acb3-e23f-42f4-8815-43da484a934b",
"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": {
"code": "enum",
"reason": "enum",
"additional_information": "string"
},
"rejection": {
"reason": "enum",
"additional_information": "string",
"message_identification": "string"
},
"metadata": {}
}
