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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
//! # sepa — SEPA payment utilities for Rust
//!
//! Provides:
//! - **IBAN validation** ([`iban`]) — ISO 13616 mod-97 **and** the registered
//! national BBAN structure, 89-country registry, SEPA membership
//! - **BIC validation** ([`bic`]) — ISO 9362:2022, including the country code
//! - **Creditor Identifier validation** ([`creditor_id`]) — EPC AT-02
//! - **Postal addresses** ([`address`]) — structured and hybrid `PstlAdr`
//! - **pain.001 builder** ([`pain001`]) — SEPA Credit Transfer + SCT Instant
//! - **pain.008 builder** ([`pain008`]) — SEPA Direct Debit (CORE + B2B)
//! - **pain.007 builder** ([`pain007`]) — SEPA Direct Debit reversal
//! - **pain.002 parser** ([`pain002`]) — Payment Status Report, incl. Verification of Payee
//! - **camt.055 builder** ([`camt055`]) — Payment Cancellation Request (recall)
//! - **camt.029 parser** ([`camt029`]) — Resolution of Investigation — the answer to a recall
//! - **camt.052 parser** ([`camt052`]) — Bank-to-Customer Report (intraday)
//! - **camt.053 parser** ([`camt053`]) — Bank-to-Customer Statement (end-of-day)
//! - **camt.054 parser** ([`camt054`]) — Bank-to-Customer Notification, returns
//! - **EPC field validation** ([`validate`]) — the rules the XSD does not enforce
//! - **SEPA character set** ([`charset`]) — validation and transliteration
//! - **Typed dates** ([`date`]) — [`IsoDate`] / [`IsoDateTime`] for every date field
//! - **Integer-safe money utilities** ([`ct_to_eur_str`], [`ct_from_eur_str`])
//!
//! All monetary amounts use `i64` cents (1 ct = 0.01 EUR) — **never `f64`**.
//! Every date is an [`IsoDate`] — never a hand-formatted string.
//!
//! **Dependencies:** [`thiserror`](https://crates.io/crates/thiserror) and
//! [`quick-xml`](https://crates.io/crates/quick-xml) (required);
//! [`serde`](https://crates.io/crates/serde),
//! [`time`](https://crates.io/crates/time) and
//! [`chrono`](https://crates.io/crates/chrono) (optional features).
//!
//! ## Schema versions
//!
//! The builders default to the versions the EPC 2023 rulebooks mandated from
//! 19 November 2023 — `pain.001.001.09` and `pain.008.001.08`. Which version a
//! bank actually requires varies by bank and by regulatory cutover, so it is a
//! per-message choice:
//!
//! | Message | Variants |
//! |---|---|
//! | pain.001 | `pain.001.001.09` (default), `pain.001.001.03`, `pain.001.003.03` |
//! | pain.008 | `pain.008.001.08` (default), `pain.008.001.02`, `pain.008.003.02` |
//! | pain.007 | `pain.007.001.09` — the only version SEPA defines |
//! | camt.055 / camt.029 | `camt.055.001.05` / `camt.029.001.06` — the pair the DFÜ-Abkommen names |
//!
//! Select one with [`Pain001Builder::schema`] / [`Pain008Builder::schema`].
//! Both enums implement `FromStr` over the message identifier and the namespace
//! URN, so the target version can come from configuration:
//!
//! ```
//! use sepa::pain008::DirectDebitSchema;
//! let schema: DirectDebitSchema = "pain.008.001.02".parse()?;
//! # Ok::<(), sepa::UnknownSchema>(())
//! ```
//!
//! Every generated document is validated against the real ISO 20022 schema in
//! CI, one test per version.
//!
//! ### These are deliberately not ISO's newest versions
//!
//! ISO advises using the most recent message definition available, and has
//! published `pain.001.001.13`, `pain.008.001.12` and `pain.002.001.15`. That
//! advice is aimed at communities free to choose their own version; a SEPA
//! participant is not one, because the version is fixed by the scheme rulebook.
//! Sending `pain.001.001.13` to a SEPA bank gets it rejected. The versions
//! above are the ones the EPC rulebooks have mandated since 19 November 2023,
//! and nothing on the published roadmap moves SEPA past them — the
//! 15 November 2026 deadline is about structured *addresses*, not about a newer
//! message version.
//!
//! ## Regulatory references
//!
//! | Standard | Module | Usage |
//! |---|---|---|
//! | ISO 13616-1 + SWIFT IBAN Registry | [`iban`] | IBAN validation + country-length registry |
//! | EPC409-09 v8.0 | [`iban`] | SEPA scheme country list |
//! | ISO 9362 | [`bic`] | BIC/SWIFT validation |
//! | ISO 3166-1 alpha-2 | [`country`] | Country codes for BICs and addresses |
//! | EPC153-22 v2.1 | [`address`] | Structured addresses, 15 Nov 2026 cut-over |
//! | EPC262-08 | [`creditor_id`] | Creditor Identifier check digits |
//! | ISO 20022 pain.001 | [`pain001`] | SEPA Credit Transfer (SCT + SCT Inst) |
//! | ISO 20022 pain.008 | [`pain008`] | SEPA Direct Debit (CORE + B2B) |
//! | ISO 20022 pain.007 | [`pain007`] | SEPA Direct Debit reversal |
//! | ISO 20022 pain.002 | [`pain002`] | Payment Status Report |
//! | EPC103-24 | [`pain002`] | Verification of Payee outcomes |
//! | ISO 20022 camt.052 | [`camt052`] | Bank-to-Customer Report (intraday) |
//! | ISO 20022 camt.053 | [`camt053`] | Bank-to-Customer Statement |
//! | ISO 20022 camt.054 | [`camt054`] | Payment notifications |
//! | ISO 20022 camt.055 | [`camt055`] | Payment Cancellation Request (recall) |
//! | ISO 20022 camt.029 | [`camt029`] | Resolution of Investigation |
//! | EPC217-08 | [`charset`] | SEPA character set + conversion table |
//! | EPC SEPA Rulebooks 2023/2025 | all | Governs all SEPA transactions |
//!
//! ## Quick start
//!
//! ```rust
//! use sepa::{
//! CreditTransferEntry, CreditTransferGroup, DirectDebitEntry, DirectDebitGroup, IsoDate,
//! Pain001Builder, Pain008Builder, SequenceType, validate_creditor_id, validate_iban,
//! };
//!
//! let iban = validate_iban("DE89 3704 0044 0532 0130 00")?;
//! assert_eq!(iban.as_str(), "DE89370400440532013000");
//! assert_eq!(iban.to_string(), "DE89 3704 0044 0532 0130 00");
//!
//! // pain.001 — Credit Transfer (Überweisung)
//! let ct_xml = Pain001Builder::new("Debtor GmbH", "CT-2026-07-001")
//! .add_group(
//! CreditTransferGroup::new("Debtor GmbH", &iban, IsoDate::new(2026, 7, 20)?)
//! .add_entry(CreditTransferEntry::new(
//! "Supplier AG", iban.clone(), 12_000, "INV-2026-001",
//! )),
//! )
//! .build()?;
//! assert!(ct_xml.contains("pain.001.001.09"));
//!
//! // pain.008 — a direct debit run carrying FRST and RCUR in one file.
//! let ci = validate_creditor_id("DE98ZZZ09999999999")?;
//! let dd_xml = Pain008Builder::new("Creditor GmbH", "DD-2026-07-001")
//! .add_group(
//! DirectDebitGroup::new("Creditor GmbH", &iban, &ci, IsoDate::new(2026, 7, 20)?)
//! .sequence_type(SequenceType::Frst)
//! .add_entry(DirectDebitEntry::new(
//! "MND-1", "2026-06-01".parse()?, "Neu Kunde", iban.clone(), 5_000, "R-001",
//! )),
//! )
//! .add_group(
//! DirectDebitGroup::new("Creditor GmbH", &iban, &ci, IsoDate::new(2026, 7, 18)?)
//! .sequence_type(SequenceType::Rcur)
//! .add_entry(DirectDebitEntry::new(
//! "MND-2", "2024-06-01".parse()?, "Alt Kunde", iban.clone(), 7_500, "R-002",
//! )),
//! )
//! .build()?;
//! assert!(dd_xml.contains("<SeqTp>FRST</SeqTp>"));
//! assert!(dd_xml.contains("<SeqTp>RCUR</SeqTp>"));
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! ## Payment groups
//!
//! A message carries one or more [`CreditTransferGroup`] / [`DirectDebitGroup`]
//! blocks, each becoming a `PmtInf`. Sequence type, execution date, debtor
//! account, batch booking and category purpose all live at that level, so
//! several groups are what let a single file mix `FRST` with `RCUR`, or carry
//! two execution dates — rather than forcing a separate submission per
//! combination.
//!
//! ## Validation
//!
//! [`Pain001Builder::build`] and [`Pain008Builder::build`] return a
//! [`Result`]: they enforce the EPC field rules that the XSD does not — amount
//! range, identifier and name lengths, non-empty batches, schema-feature
//! compatibility — and by default transliterate text into the SEPA character
//! set, so `Müller & Söhne` is emitted as `Mueller + Soehne`. See [`validate`]
//! and [`charset`].
//!
//! Failures come back as a [`BuildError`]: a typed [`ValidationError`] naming
//! the ISO 20022 element, plus the [`Location`] — group and transaction index —
//! it came from, so a rejected collection run points at the row to fix.
//!
//! Two classes of mistake are absent from that list because they cannot fail
//! there — they are unrepresentable rather than caught late. [`IsoDate`]
//! validates at construction, so an impossible `ReqdColltnDt` never reaches a
//! batch; and [`PostalAddress`] requires a town and a country, so the
//! unstructured address form the EPC schemes reject from 15 November 2026 is
//! not a value this crate can be asked to emit.
//!
//! ## Nothing that matters is defaulted from a clock
//!
//! `MsgId` and the payment date are constructor arguments, because neither has
//! a safe default. `MsgId` is the key a bank de-duplicates submissions by, so
//! it has to come from a sequence that survives a restart. `ReqdExctnDt` and
//! `ReqdColltnDt` are the day money leaves an account, which depends on the
//! scheme, the sequence type, TARGET2 and the bank's cut-off — a
//! banking-calendar question this crate cannot answer.
//!
//! One implicit clock read remains: `GrpHdr/CreDtTm`. Pin it with
//! `created_at()` and a submitted file regenerates byte-for-byte.
//!
//! ## Undoing a payment
//!
//! Three messages undo one, and they are not interchangeable — picking the
//! wrong one wastes the window in which anything can still be done:
//!
//! | You want to | Message | Note |
//! |---|---|---|
//! | Stop a file you just sent | [`camt055`] | A **request**. The bank may refuse; the answer is [`camt029`] |
//! | Give back a collection that settled | [`pain007`] | An instruction, and only for a direct debit |
//! | Learn a payment came back | [`camt054`] | The bank telling you, after the fact |
//!
//! ```
//! use sepa::{Camt055Builder, CancellationEntry, CancellationGroup, CancellationReason,
//! OriginalMessage, Pain008Builder, parse_camt029, validate_bic};
//!
//! # let submitted = Pain008Builder::new("Stadtwerke GmbH", "DD-2026-07-001");
//! let recall = Camt055Builder::new(
//! "CXL-2026-07-001",
//! "Stadtwerke GmbH",
//! validate_bic("COBADEFFXXX")?,
//! OriginalMessage::from_direct_debit(&submitted),
//! )
//! .add_group(
//! CancellationGroup::new("PMT-2026-07-A")
//! .add_entry(CancellationEntry::new("E2E-1", CancellationReason::Dupl)),
//! );
//! # let _ = recall;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! Nothing has been cancelled until the camt.029 says so, and `PDCR` — pending
//! — is neither answer. [`Camt029Document::is_final`] is what separates the two.
//!
//! [`Camt029Document::is_final`]: camt029::Camt029Document::is_final
//!
//! ## Reading bank files
//!
//! Every parser returns a `Result` with a typed error naming what it could not
//! read — a reconciliation import can always say *why* it skipped a row, not
//! just that it did. For a batch-booked camt entry, read
//! [`EntryDetail::signed_ct`] per transaction and check
//! [`CashEntry::details_reconcile`] before posting; [`CashEntry::batch`] carries
//! the `PmtInfId` of the group you submitted, which is what matches a booking
//! back to your own file.
//!
//! Bank input is kept verbatim and typed alongside, never in place of, the raw
//! value: [`CashEntry::booking_date`] returns an [`IsoDate`] and
//! `booking_date_raw` the text that arrived, so a non-conforming file is
//! readable rather than rejected.
//!
//! Two things a ledger needs are reported beside the amount rather than inside
//! it. [`CashEntry::charges`] carries the return fee on a bounced collection —
//! check [`Charges::all_included_in_amount`] before posting it, since a charge
//! already inside the entry amount must not be booked twice. And a `pain.002`
//! rejection explains itself at exactly one of three levels depending on how
//! far the bank got, so [`Pain002Document::reason_codes`] gathers all of them:
//! a submission refused outright carries its reason at group level with no
//! transaction blocks to inspect at all.
//!
//! [`EntryDetail::signed_ct`]: camt::EntryDetail::signed_ct
//! [`CashEntry::details_reconcile`]: camt::CashEntry::details_reconcile
//! [`CashEntry::booking_date`]: camt::CashEntry::booking_date
//! [`CashEntry::batch`]: camt::CashEntry::batch
//! [`CashEntry::charges`]: camt::CashEntry::charges
//! [`Charges::all_included_in_amount`]: camt::Charges::all_included_in_amount
//! [`Pain002Document::reason_codes`]: pain002::Pain002Document::reason_codes
// The panic-oriented lints (`unwrap_used`, `indexing_slicing`, …) guard the
// library's own code paths, where a panic on bank input is a real defect.
// Inside tests, `unwrap()` *is* the assertion, so they are relaxed there.
/// Compile-tests every example in `README.md`, so the README cannot drift out
/// of sync with the API.
;
/// Compile-tests every Rust example on the documentation site.
///
/// A published guide that no longer compiles is worse than no guide, so the
/// site's pages are run through the same doctest harness as the crate's own
/// documentation. Adding a page without adding it here is the one way a sample
/// could drift, which is why the list is explicit rather than a glob.