swift-mt-message 3.1.5

A fast, type-safe Rust implementation of SWIFT MT message parsing with comprehensive field support, derive macros, and validation.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
use crate::errors::SwiftValidationError;
use crate::fields::{field34::Field34F, *};
use crate::parser::utils::*;
use serde::{Deserialize, Serialize};

/// **MT920: Request Message**
///
/// Requests specific account information or statement messages.
///
/// **Usage:** Statement requests, account information inquiries
/// **Category:** Category 9 (Cash Management & Customer Status)
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
pub struct MT920 {
    /// Transaction Reference Number (Field 20)
    #[serde(rename = "20")]
    pub field_20: Field20,

    /// Repetitive sequence (1-100 occurrences)
    #[serde(rename = "#")]
    pub sequence: Vec<MT920Sequence>,
}

/// Repetitive sequence for MT920 request message
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
pub struct MT920Sequence {
    /// Message Type (Field 12)
    #[serde(rename = "12")]
    pub field_12: Field12,

    /// Account Identification (Field 25)
    #[serde(rename = "25")]
    pub field_25: Field25,

    /// Debit Floor Limit (Field 34F)
    #[serde(rename = "34F_1")]
    pub floor_limit_debit: Option<Field34F>,

    /// Credit Floor Limit (Field 34F)
    #[serde(rename = "34F_2")]
    pub floor_limit_credit: Option<Field34F>,
}

impl MT920 {
    /// Parse message from Block 4 content
    pub fn parse_from_block4(block4: &str) -> Result<Self, crate::errors::ParseError> {
        let mut parser = crate::parser::MessageParser::new(block4, "920");

        // Parse header field
        let field_20 = parser.parse_field::<Field20>("20")?;

        // Parse repetitive sequences
        let mut sequence = Vec::new();

        // Enable duplicate field handling for repeated sequences
        parser = parser.with_duplicates(true);

        // Detect and parse each sequence (field 12 marks the start of a new sequence)
        while parser.detect_field("12") {
            let field_12 = parser.parse_field::<Field12>("12")?;
            let field_25 = parser.parse_field::<Field25>("25")?;
            let floor_limit_debit = parser.parse_optional_field::<Field34F>("34F")?;
            let floor_limit_credit = parser.parse_optional_field::<Field34F>("34F")?;

            // Apply max repetitions validation
            if sequence.len() >= 100 {
                return Err(crate::errors::ParseError::InvalidFormat {
                    message: "Maximum 100 repetitions allowed".to_string(),
                });
            }

            sequence.push(MT920Sequence {
                field_12,
                field_25,
                floor_limit_debit,
                floor_limit_credit,
            });
        }

        // Validate at least one sequence is present
        if sequence.is_empty() {
            return Err(crate::errors::ParseError::InvalidFormat {
                message: "At least one sequence is required in MT920".to_string(),
            });
        }

        // Verify all content is consumed
        verify_parser_complete(&parser)?;

        Ok(Self { field_20, sequence })
    }

    /// Parse from SWIFT MT text format
    pub fn parse(input: &str) -> Result<Self, crate::errors::ParseError> {
        let block4 = extract_block4(input)?;
        Self::parse_from_block4(&block4)
    }

    /// Convert to SWIFT MT text format
    pub fn to_mt_string(&self) -> String {
        let mut result = String::new();

        // Add header field
        append_field(&mut result, &self.field_20);

        // Add sequences
        for seq in &self.sequence {
            append_field(&mut result, &seq.field_12);
            append_field(&mut result, &seq.field_25);
            append_optional_field(&mut result, &seq.floor_limit_debit);
            append_optional_field(&mut result, &seq.floor_limit_credit);
        }

        finalize_mt_string(result, false)
    }

    // ========================================================================
    // NETWORK VALIDATION RULES (SR 2025 MT920)
    // ========================================================================

    /// Field 12 valid message type codes for MT920
    const VALID_MESSAGE_TYPES: &'static [&'static str] = &["940", "941", "942", "950"];

    // ========================================================================
    // VALIDATION RULES (T88, C1, C2, C3)
    // ========================================================================

    /// T88: Field 12 Message Type Validation (Error code: T88)
    /// Field 12 must contain one of: 940, 941, 942, 950
    fn validate_t88_message_type(&self) -> Vec<SwiftValidationError> {
        let mut errors = Vec::new();

        for (idx, seq) in self.sequence.iter().enumerate() {
            let type_code = &seq.field_12.type_code;
            if !Self::VALID_MESSAGE_TYPES.contains(&type_code.as_str()) {
                errors.push(SwiftValidationError::format_error(
                    "T88",
                    "12",
                    type_code,
                    &format!("One of: {}", Self::VALID_MESSAGE_TYPES.join(", ")),
                    &format!(
                        "Sequence {}: Field 12 message type '{}' is not valid. Valid types: {}",
                        idx + 1,
                        type_code,
                        Self::VALID_MESSAGE_TYPES.join(", ")
                    ),
                ));
            }
        }

        errors
    }

    /// C1: Field 34F Requirement for MT 942 Requests (Error code: C22)
    /// If field 12 contains '942', at least field 34F Debit/(Debit and Credit) must be present
    fn validate_c1_field_34f_requirement(&self) -> Vec<SwiftValidationError> {
        let mut errors = Vec::new();

        for (idx, seq) in self.sequence.iter().enumerate() {
            if seq.field_12.type_code == "942" && seq.floor_limit_debit.is_none() {
                errors.push(SwiftValidationError::business_error(
                    "C22",
                    "34F",
                    vec!["12".to_string()],
                    &format!(
                        "Sequence {}: Field 34F (Debit/Debit and Credit Floor Limit) is mandatory when field 12 contains '942'",
                        idx + 1
                    ),
                    "When requesting MT 942 (Interim Transaction Report), at least the debit floor limit must be specified",
                ));
            }
        }

        errors
    }

    /// C2: Field 34F D/C Mark Usage (Error code: C23)
    /// When only one 34F present: D/C Mark must NOT be used
    /// When both 34F present: First must have 'D', second must have 'C'
    fn validate_c2_dc_mark_usage(&self) -> Vec<SwiftValidationError> {
        let mut errors = Vec::new();

        for (idx, seq) in self.sequence.iter().enumerate() {
            let has_debit = seq.floor_limit_debit.is_some();
            let has_credit = seq.floor_limit_credit.is_some();

            if has_debit && !has_credit {
                // Only debit field present - D/C Mark must NOT be used
                if let Some(ref debit_field) = seq.floor_limit_debit
                    && debit_field.indicator.is_some()
                {
                    errors.push(SwiftValidationError::business_error(
                            "C23",
                            "34F",
                            vec![],
                            &format!(
                                "Sequence {}: D/C Mark must not be used when only one field 34F is present",
                                idx + 1
                            ),
                            "When only one field 34F is present, the floor limit applies to both debit and credit amounts, and the D/C Mark subfield must not be used",
                        ));
                }
            } else if has_debit && has_credit {
                // Both fields present - First must have 'D', second must have 'C'
                let debit_field = seq.floor_limit_debit.as_ref().unwrap();
                let credit_field = seq.floor_limit_credit.as_ref().unwrap();

                if debit_field.indicator != Some('D') {
                    errors.push(SwiftValidationError::business_error(
                        "C23",
                        "34F",
                        vec![],
                        &format!(
                            "Sequence {}: First field 34F must contain D/C Mark 'D' when both floor limits are present",
                            idx + 1
                        ),
                        "When both fields 34F are present, the first field (debit floor limit) must contain D/C Mark = 'D'",
                    ));
                }

                if credit_field.indicator != Some('C') {
                    errors.push(SwiftValidationError::business_error(
                        "C23",
                        "34F",
                        vec![],
                        &format!(
                            "Sequence {}: Second field 34F must contain D/C Mark 'C' when both floor limits are present",
                            idx + 1
                        ),
                        "When both fields 34F are present, the second field (credit floor limit) must contain D/C Mark = 'C'",
                    ));
                }
            }
        }

        errors
    }

    /// C3: Currency Consistency Within Repetitive Sequence (Error code: C40)
    /// Currency code must be the same for each occurrence of field 34F within each sequence
    fn validate_c3_currency_consistency(&self) -> Vec<SwiftValidationError> {
        let mut errors = Vec::new();

        for (idx, seq) in self.sequence.iter().enumerate() {
            if let (Some(debit_field), Some(credit_field)) =
                (&seq.floor_limit_debit, &seq.floor_limit_credit)
                && debit_field.currency != credit_field.currency
            {
                errors.push(SwiftValidationError::business_error(
                        "C40",
                        "34F",
                        vec![],
                        &format!(
                            "Sequence {}: Currency code must be the same for all field 34F occurrences. Found '{}' and '{}'",
                            idx + 1,
                            debit_field.currency,
                            credit_field.currency
                        ),
                        "Within each repetitive sequence, the currency code must be the same for each occurrence of field 34F",
                    ));
            }
        }

        errors
    }

    /// Main validation method - validates all network rules
    /// Returns array of validation errors, respects stop_on_first_error flag
    pub fn validate_network_rules(&self, stop_on_first_error: bool) -> Vec<SwiftValidationError> {
        let mut all_errors = Vec::new();

        // T88: Message Type Validation
        let t88_errors = self.validate_t88_message_type();
        all_errors.extend(t88_errors);
        if stop_on_first_error && !all_errors.is_empty() {
            return all_errors;
        }

        // C1: Field 34F Requirement for MT 942
        let c1_errors = self.validate_c1_field_34f_requirement();
        all_errors.extend(c1_errors);
        if stop_on_first_error && !all_errors.is_empty() {
            return all_errors;
        }

        // C2: Field 34F D/C Mark Usage
        let c2_errors = self.validate_c2_dc_mark_usage();
        all_errors.extend(c2_errors);
        if stop_on_first_error && !all_errors.is_empty() {
            return all_errors;
        }

        // C3: Currency Consistency
        let c3_errors = self.validate_c3_currency_consistency();
        all_errors.extend(c3_errors);

        all_errors
    }
}

impl crate::traits::SwiftMessageBody for MT920 {
    fn message_type() -> &'static str {
        "920"
    }

    fn parse_from_block4(block4: &str) -> Result<Self, crate::errors::ParseError> {
        // Call the existing public method implementation
        MT920::parse_from_block4(block4)
    }

    fn to_mt_string(&self) -> String {
        // Call the existing public method implementation
        MT920::to_mt_string(self)
    }

    fn validate_network_rules(&self, stop_on_first_error: bool) -> Vec<SwiftValidationError> {
        // Call the existing public method implementation
        MT920::validate_network_rules(self, stop_on_first_error)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_mt920_parse() {
        let mt920_text = r#":20:REQ123456
:12:100
:25:/GB12ABCD12345678901234
:12:200
:25:/US98EFGH98765432109876
-"#;
        let result = MT920::parse_from_block4(mt920_text);
        if let Err(ref e) = result {
            eprintln!("MT920 parse error: {:?}", e);
        }
        assert!(result.is_ok());
        let mt920 = result.unwrap();
        assert_eq!(mt920.field_20.reference, "REQ123456");
        assert_eq!(mt920.sequence.len(), 2);
        assert_eq!(mt920.sequence[0].field_12.type_code, "100");
        assert_eq!(mt920.sequence[1].field_12.type_code, "200");
    }

    #[test]
    fn test_mt920_validation() {
        // Test empty sequence - should fail
        let mt920_text = r#":20:REQ123456
-"#;
        let result = MT920::parse(mt920_text);
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("At least one sequence")
        );
    }

    #[test]
    fn test_mt920_json_deserialization() {
        // Test JSON deserialization for MT920
        let json = r##"{
            "20": {
                "reference": "REQ123456"
            },
            "#": [
                {
                    "12": {
                        "type_code": "940"
                    },
                    "25": {
                        "authorisation": "1234567890"
                    }
                }
            ]
        }"##;

        let result = serde_json::from_str::<MT920>(json);
        if let Err(ref e) = result {
            eprintln!("MT920 JSON deserialization error: {}", e);
        }
        assert!(result.is_ok(), "Failed to deserialize MT920 from JSON");
        let mt920 = result.unwrap();
        assert_eq!(mt920.field_20.reference, "REQ123456");
        assert_eq!(mt920.sequence.len(), 1);
        assert_eq!(mt920.sequence[0].field_12.type_code, "940");
        assert_eq!(mt920.sequence[0].field_25.authorisation, "1234567890");
    }

    #[test]
    fn test_mt920_swift_message_json() {
        use crate::swift_message::SwiftMessage;

        // Test complete SwiftMessage<MT920> JSON deserialization
        let json = r##"{
            "basic_header": {
                "application_id": "F",
                "service_id": "01",
                "sender_bic": "DEUTDEFF",
                "logical_terminal": "DEUTDEFFXXXX",
                "session_number": "0001",
                "sequence_number": "000123"
            },
            "application_header": {
                "direction": "I",
                "message_type": "920",
                "receiver_bic": "DEUTDEFF",
                "destination_address": "DEUTDEFFXXXX",
                "priority": "N"
            },
            "message_type": "920",
            "fields": {
                "20": {
                    "reference": "REQ123456"
                },
                "#": [
                    {
                        "12": {
                            "type_code": "940"
                        },
                        "25": {
                            "authorisation": "1234567890"
                        }
                    }
                ]
            }
        }"##;

        let result = serde_json::from_str::<SwiftMessage<MT920>>(json);
        if let Err(ref e) = result {
            eprintln!("SwiftMessage<MT920> JSON deserialization error: {}", e);
        }
        assert!(
            result.is_ok(),
            "Failed to deserialize SwiftMessage<MT920> from JSON"
        );
        let swift_msg = result.unwrap();
        assert_eq!(swift_msg.message_type, "920");
        assert_eq!(swift_msg.fields.field_20.reference, "REQ123456");
        assert_eq!(swift_msg.fields.sequence.len(), 1);
    }
}