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
use crate::errors::SwiftValidationError;
use crate::fields::*;
use crate::parser::utils::*;
use serde::{Deserialize, Serialize};

/// **MT941: Balance Report**
///
/// Balance reporting with optional transaction summaries.
///
/// **Usage:** Balance monitoring, cash management without detailed transactions
/// **Category:** Category 9 (Cash Management & Customer Status)
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
pub struct MT941 {
    /// Transaction Reference Number (Field 20)
    #[serde(rename = "20")]
    pub field_20: Field20,

    /// Related Reference (Field 21)
    #[serde(rename = "21", skip_serializing_if = "Option::is_none")]
    pub field_21: Option<Field21NoOption>,

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

    /// Statement Number/Sequence Number (Field 28)
    #[serde(rename = "28")]
    pub field_28: Field28,

    /// Date/Time Indication (Field 13D)
    #[serde(rename = "13D", skip_serializing_if = "Option::is_none")]
    pub field_13d: Option<Field13D>,

    /// Opening Balance (Field 60F)
    #[serde(rename = "60F", skip_serializing_if = "Option::is_none")]
    pub field_60f: Option<Field60F>,

    /// Number and Sum of Debits (Field 90D)
    #[serde(rename = "90D", skip_serializing_if = "Option::is_none")]
    pub field_90d: Option<Field90D>,

    /// Number and Sum of Credits (Field 90C)
    #[serde(rename = "90C", skip_serializing_if = "Option::is_none")]
    pub field_90c: Option<Field90C>,

    /// Closing Balance (Field 62F)
    #[serde(rename = "62F")]
    pub field_62f: Field62F,

    /// Closing Available Balance (Field 64)
    #[serde(rename = "64", skip_serializing_if = "Option::is_none")]
    pub field_64: Option<Field64>,

    /// Forward Available Balance (Field 65)
    #[serde(rename = "65", skip_serializing_if = "Option::is_none")]
    pub field_65: Option<Vec<Field65>>,

    /// Information to Account Owner (Field 86)
    #[serde(rename = "86", skip_serializing_if = "Option::is_none")]
    pub field_86: Option<Field86>,
}

impl MT941 {
    /// 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, "941");

        // Parse mandatory fields
        let field_20 = parser.parse_field::<Field20>("20")?;
        let field_21 = parser.parse_optional_field::<Field21NoOption>("21")?;
        let field_25 = parser.parse_field::<Field25AccountIdentification>("25")?;
        let field_28 = parser.parse_field::<Field28>("28")?;

        // Parse optional date/time indication
        let field_13d = parser.parse_optional_field::<Field13D>("13D")?;

        // Parse optional opening balance
        let field_60f = parser.parse_optional_field::<Field60F>("60F")?;

        // Parse optional summary fields
        let field_90d = parser.parse_optional_field::<Field90D>("90D")?;
        let field_90c = parser.parse_optional_field::<Field90C>("90C")?;

        // Parse mandatory closing balance
        let field_62f = parser.parse_field::<Field62F>("62F")?;

        // Parse optional available balance
        let field_64 = parser.parse_optional_field::<Field64>("64")?;

        // Parse optional forward available balance (can be repetitive)
        let mut field_65_vec = Vec::new();
        while parser.detect_field("65") {
            if let Ok(field) = parser.parse_field::<Field65>("65") {
                field_65_vec.push(field);
            } else {
                break;
            }
        }
        let field_65 = if field_65_vec.is_empty() {
            None
        } else {
            Some(field_65_vec)
        };

        // Parse optional information field
        let field_86 = parser.parse_optional_field::<Field86>("86")?;

        Ok(MT941 {
            field_20,
            field_21,
            field_25,
            field_28,
            field_13d,
            field_60f,
            field_90d,
            field_90c,
            field_62f,
            field_64,
            field_65,
            field_86,
        })
    }

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

    // No validation constants needed for MT941 - only currency consistency check

    // ========================================================================
    // HELPER METHODS
    // ========================================================================

    /// Get the base currency (first two characters) from mandatory field 62F
    fn get_base_currency(&self) -> &str {
        &self.field_62f.currency[0..2]
    }

    // ========================================================================
    // VALIDATION RULES
    // ========================================================================

    /// C1: Currency Code Consistency (Error code: C27)
    /// The first two characters of the three character currency code in fields 60F, 90D,
    /// 90C, 62F, 64 and 65 must be the same for all occurrences of these fields
    fn validate_c1_currency_consistency(
        &self,
        stop_on_first_error: bool,
    ) -> Vec<SwiftValidationError> {
        let mut errors = Vec::new();
        let base_currency = self.get_base_currency();

        // Check 60F if present
        if let Some(ref field_60f) = self.field_60f
            && &field_60f.currency[0..2] != base_currency
        {
            errors.push(SwiftValidationError::content_error(
                    "C27",
                    "60F",
                    &field_60f.currency,
                    &format!(
                        "Currency code in field 60F ({}) must have the same first two characters as field 62F ({})",
                        &field_60f.currency[0..2],
                        base_currency
                    ),
                    "The first two characters of the three character currency code in fields 60F, 90D, 90C, 62F, 64 and 65 must be the same for all occurrences of these fields",
                ));
            if stop_on_first_error {
                return errors;
            }
        }

        // Check 90D if present
        if let Some(ref field_90d) = self.field_90d
            && &field_90d.currency[0..2] != base_currency
        {
            errors.push(SwiftValidationError::content_error(
                    "C27",
                    "90D",
                    &field_90d.currency,
                    &format!(
                        "Currency code in field 90D ({}) must have the same first two characters as field 62F ({})",
                        &field_90d.currency[0..2],
                        base_currency
                    ),
                    "The first two characters of the three character currency code in fields 60F, 90D, 90C, 62F, 64 and 65 must be the same for all occurrences of these fields",
                ));
            if stop_on_first_error {
                return errors;
            }
        }

        // Check 90C if present
        if let Some(ref field_90c) = self.field_90c
            && &field_90c.currency[0..2] != base_currency
        {
            errors.push(SwiftValidationError::content_error(
                    "C27",
                    "90C",
                    &field_90c.currency,
                    &format!(
                        "Currency code in field 90C ({}) must have the same first two characters as field 62F ({})",
                        &field_90c.currency[0..2],
                        base_currency
                    ),
                    "The first two characters of the three character currency code in fields 60F, 90D, 90C, 62F, 64 and 65 must be the same for all occurrences of these fields",
                ));
            if stop_on_first_error {
                return errors;
            }
        }

        // Check 64 if present
        if let Some(ref field_64) = self.field_64
            && &field_64.currency[0..2] != base_currency
        {
            errors.push(SwiftValidationError::content_error(
                    "C27",
                    "64",
                    &field_64.currency,
                    &format!(
                        "Currency code in field 64 ({}) must have the same first two characters as field 62F ({})",
                        &field_64.currency[0..2],
                        base_currency
                    ),
                    "The first two characters of the three character currency code in fields 60F, 90D, 90C, 62F, 64 and 65 must be the same for all occurrences of these fields",
                ));
            if stop_on_first_error {
                return errors;
            }
        }

        // Check 65 if present (can be repetitive)
        if let Some(ref field_65_vec) = self.field_65 {
            for (idx, field_65) in field_65_vec.iter().enumerate() {
                if &field_65.currency[0..2] != base_currency {
                    errors.push(SwiftValidationError::content_error(
                        "C27",
                        "65",
                        &field_65.currency,
                        &format!(
                            "Currency code in field 65[{}] ({}) must have the same first two characters as field 62F ({})",
                            idx,
                            &field_65.currency[0..2],
                            base_currency
                        ),
                        "The first two characters of the three character currency code in fields 60F, 90D, 90C, 62F, 64 and 65 must be the same for all occurrences of these fields",
                    ));
                    if stop_on_first_error {
                        return errors;
                    }
                }
            }
        }

        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();

        // C1: Currency Code Consistency
        let c1_errors = self.validate_c1_currency_consistency(stop_on_first_error);
        all_errors.extend(c1_errors);
        if stop_on_first_error && !all_errors.is_empty() {
            return all_errors;
        }

        all_errors
    }
}

// Implement the SwiftMessageBody trait for MT941
impl crate::traits::SwiftMessageBody for MT941 {
    fn message_type() -> &'static str {
        "941"
    }

    fn parse_from_block4(block4: &str) -> Result<Self, crate::errors::ParseError> {
        Self::parse_from_block4(block4)
    }

    fn to_mt_string(&self) -> String {
        let mut result = String::new();

        append_field(&mut result, &self.field_20);
        append_optional_field(&mut result, &self.field_21);
        append_field(&mut result, &self.field_25);
        append_field(&mut result, &self.field_28);
        append_optional_field(&mut result, &self.field_13d);
        append_optional_field(&mut result, &self.field_60f);
        append_optional_field(&mut result, &self.field_90d);
        append_optional_field(&mut result, &self.field_90c);
        append_field(&mut result, &self.field_62f);
        append_optional_field(&mut result, &self.field_64);
        append_vec_field(&mut result, &self.field_65);
        append_optional_field(&mut result, &self.field_86);

        finalize_mt_string(result, false)
    }

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

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

    #[test]
    fn test_mt941_validate_c1_currency_consistency_pass() {
        // Valid message - all currency codes have the same first two characters
        let mt941 = MT941 {
            field_20: Field20::parse("BALREP001").unwrap(),
            field_21: None,
            field_25: Field25AccountIdentification::parse("1234567890").unwrap(),
            field_28: Field28::parse("1").unwrap(),
            field_13d: None,
            field_60f: Some(Field60F::parse("C251003EUR595771,95").unwrap()),
            field_90d: Some(Field90D::parse("72EUR385920,").unwrap()),
            field_90c: Some(Field90C::parse("44EUR450000,").unwrap()),
            field_62f: Field62F::parse("C251003EUR659851,95").unwrap(),
            field_64: Some(Field64::parse("C251003EUR480525,87").unwrap()),
            field_65: Some(vec![Field65::parse("C251004EUR530691,95").unwrap()]),
            field_86: None,
        };

        let errors = mt941.validate_network_rules(false);
        assert!(
            errors.is_empty(),
            "Expected no validation errors, got: {:?}",
            errors
        );
    }

    #[test]
    fn test_mt941_validate_c1_currency_consistency_fail_60f() {
        // Invalid message - field 60F has different currency prefix
        let mt941 = MT941 {
            field_20: Field20::parse("BALREP001").unwrap(),
            field_21: None,
            field_25: Field25AccountIdentification::parse("1234567890").unwrap(),
            field_28: Field28::parse("1").unwrap(),
            field_13d: None,
            field_60f: Some(Field60F::parse("C251003USD595771,95").unwrap()), // USD instead of EUR
            field_90d: None,
            field_90c: None,
            field_62f: Field62F::parse("C251003EUR659851,95").unwrap(),
            field_64: None,
            field_65: None,
            field_86: None,
        };

        let errors = mt941.validate_network_rules(false);
        assert_eq!(errors.len(), 1);
        assert!(errors[0].message().contains("60F"));
        assert!(errors[0].message().contains("US"));
        assert!(errors[0].message().contains("EU"));
    }

    #[test]
    fn test_mt941_validate_c1_currency_consistency_fail_multiple() {
        // Invalid message - multiple fields have different currency prefixes
        let mt941 = MT941 {
            field_20: Field20::parse("BALREP001").unwrap(),
            field_21: None,
            field_25: Field25AccountIdentification::parse("1234567890").unwrap(),
            field_28: Field28::parse("1").unwrap(),
            field_13d: None,
            field_60f: Some(Field60F::parse("C251003USD595771,95").unwrap()), // USD
            field_90d: Some(Field90D::parse("72GBP385920,").unwrap()),        // GBP
            field_90c: Some(Field90C::parse("44JPY450000,").unwrap()),        // JPY
            field_62f: Field62F::parse("C251003EUR659851,95").unwrap(),       // EUR
            field_64: Some(Field64::parse("C251003CHF480525,87").unwrap()),   // CHF
            field_65: Some(vec![
                Field65::parse("C251004AUD530691,95").unwrap(), // AUD
                Field65::parse("C251005CAD530691,95").unwrap(), // CAD
            ]),
            field_86: None,
        };

        let errors = mt941.validate_network_rules(false);
        assert_eq!(errors.len(), 6); // 60F, 90D, 90C, 64, 65[0], 65[1]
    }

    #[test]
    fn test_mt941_validate_c1_stop_on_first_error() {
        // Invalid message - multiple fields have different currency prefixes
        let mt941 = MT941 {
            field_20: Field20::parse("BALREP001").unwrap(),
            field_21: None,
            field_25: Field25AccountIdentification::parse("1234567890").unwrap(),
            field_28: Field28::parse("1").unwrap(),
            field_13d: None,
            field_60f: Some(Field60F::parse("C251003USD595771,95").unwrap()),
            field_90d: Some(Field90D::parse("72GBP385920,").unwrap()),
            field_90c: None,
            field_62f: Field62F::parse("C251003EUR659851,95").unwrap(),
            field_64: None,
            field_65: None,
            field_86: None,
        };

        let errors = mt941.validate_network_rules(true); // stop on first error
        assert_eq!(errors.len(), 1); // Should only return the first error (60F)
    }
}