This version of the module is deprecated: Renamed to cstoooo/moonpay_flow

README
E
XmlParseError
- ::addDecimal::add
- ::compareDecimal::compare
- ::is_positiveDecimal::is_positive
- ::parseDecimal::parse
- ::to_stringDecimal::to_string
- ::zeroDecimal::zero
T
Diagnostic
T
Event
T
EventKind
T
LifecycleCase
- ::to_jsonLifecycleReport::to_json
- ::to_markdownLifecycleReport::to_markdown
- ::to_textLifecycleReport::to_text
- ::nameLifecycleState::name
T
MessageInfo
- ::nameMessageKind::name
- ::is_validMessageValidation::is_valid
- ::to_jsonMessageValidation::to_json
- ::to_markdownMessageValidation::to_markdown
- ::to_textMessageValidation::to_text
- ::to_textPain001Summary::to_text
T
PaymentRecord
- ::to_jsonReconciliationReport::to_json
- ::to_markdownReconciliationReport::to_markdown
- ::to_textReconciliationReport::to_text
T
RuleInfo
T
StatementRecord
T
StatusRecord
- ::is_validValidationReport::is_valid
- ::to_jsonValidationReport::to_json
- ::to_markdownValidationReport::to_markdown
- ::to_textValidationReport::to_text
- ::getXmlElement::get
- ::get_attributeXmlField::get_attribute
- ::from_stringXmlReader::from_string
- ::read_eventXmlReader::read_event
V
detect_message_kind
V
elements_by_suffix
V
fields_by_suffix
V
first_text_by_suffix
V
flatten_xml
V
lifecycle_report
V
pain001_payment_records
V
reconcile_pain001_status
V
rule_catalog
V
statement_records
V
status_records
V
summarize_pain001
V
texts_by_suffix
V
validate_message
V
validate_pain001
V
version

mooniso_lite

MoonBit ISO 20022 pain.001 validator.

moonbit

iso20022

pain001

validator

finance

Download zip

Author

cstoooo

Version

0.5.0

License

Apache-2.0

Repository

github.com/cstoooo/mooniso-lite

Last updated

2 days ago

Downloads

moonbitlang/x0.5.5

#MoonISO Lite

MoonBit command-line validator for ISO 20022 pain.001 payment messages.

#Implementation

Project-local XML pull reader in xml_reader.mbt
Project-local fixed-point decimal module in decimal.mbt
Flat XML field extractor in flat_xml.mbt
Multi-message validation in message.mbt
Payment reconciliation in reconcile.mbt
File input through moonbitlang/x/fs
CLI in cmd/main
47 unit tests and 12 fixture messages

#Status

Version: 0.4.0

Current support: pain.001, pain.002, pacs.008, pacs.002 and camt.053.

#Run

scripts/check.sh

# Or run the commands directly:
moon check
moon test
moon run cmd/main -- fixtures/valid_pain001.xml
moon run cmd/main -- --format json fixtures/valid_pain001.xml
moon run cmd/main -- --format markdown fixtures/invalid_pain001.xml
moon run cmd/main -- fixtures/valid_pain002.xml
moon run cmd/main -- fixtures/valid_camt053.xml
moon run cmd/main -- reconcile fixtures/valid_pain001.xml fixtures/valid_pain002.xml
moon run cmd/main -- --list-rules
moon run cmd/main -- lifecycle fixtures/lifecycle_pain001.xml fixtures/lifecycle_pain002.xml fixtures/lifecycle_camt053.xml

#Rules

Message ID is required.
Creation date time is required.
At least one payment instruction is required.
Payment instruction ID is required.
Requested execution date is required.
End-to-end ID is required, must not exceed 35 characters and must be unique.
Payment instruction ID must not exceed 35 characters and must be unique.
Instructed amount and currency are required.
NbOfTxs must be an unsigned integer and match the parsed transaction count.
Date, datetime, currency and amount formats are checked.
Payment method and charge bearer values are checked.
IBAN checksum and BIC format are checked when present.
CtrlSum must match the sum of instructed amounts when present.
Status reports validate OrgnlEndToEndId, TxSts and duplicate status entries.
pacs.008 validates end-to-end IDs, settlement amounts and currencies.
camt.053 validates statement entries, amounts and currencies.
reconcile matches pain.001 transactions with status report entries.
camt.053 validates the CdtDbtInd credit/debit indicator.
--list-rules prints the rule catalog with codes and descriptions.
lifecycle classifies payment state across initiation, status and statement messages.
Version boundaries and a full lifecycle example are documented in docs/version-scope-and-cases.md.

#License

Apache-2.0

#Project description

See docs/proposal.md.

XmlParseError

source

pub(all) suberror XmlParseError {
  XmlParseError(String)
}

XML parsing error used by the project-local reader.

Decimal

source

pub struct Decimal {
  minor_units : Int
  scale : Int
}

Non-negative fixed-point decimal with a maximum scale of 2.

Decimal::add

source

fn Decimal::add(self : Decimal, other : Decimal) -> Decimal

Decimal::compare

source

fn Decimal::compare(self : Decimal, other : Decimal) -> Int

Decimal::is_positive

source

fn Decimal::is_positive(self : Decimal) -> Bool

Decimal::parse

source

fn Decimal::parse(value : String) -> Decimal?

Decimal::to_string

source

fn Decimal::to_string(self : Decimal) -> String

Decimal::zero

source

fn Decimal::zero() -> Decimal

Diagnostic

source

pub struct Diagnostic {
  code : String
  path : String
  message : String
}

Validation result for one pain.001 document.

Event

source

pub struct Event {
  kind : EventKind
}

EventKind

source

pub(all) enum EventKind {
  Start(XmlElement)
  Empty(XmlElement)
  Text(String)
  End(String)
  Eof
}

LifecycleCase

source

pub struct LifecycleCase {
  end_to_end_id : String
  amount : Decimal
  currency : String
  status : String?
  statement_amount : Decimal?
  statement_currency : String?
  state : LifecycleState
  action : String
}

LifecycleReport

source

pub struct LifecycleReport {
  cases : Array[LifecycleCase]
  orphan_statuses : Array[String]
  orphan_statements : Array[String]
}

LifecycleReport::to_json

source

fn LifecycleReport::to_json(self : LifecycleReport) -> String

LifecycleReport::to_markdown

source

fn LifecycleReport::to_markdown(self : LifecycleReport) -> String

LifecycleReport::to_text

source

fn LifecycleReport::to_text(self : LifecycleReport) -> String

LifecycleState

source

pub(all) enum LifecycleState {
  Settled
  SettledNotPosted
  Rejected
  Pending
  MissingStatus
  StatementMismatch
  StatementBeforeFinalStatus
}

LifecycleState::name

source

fn LifecycleState::name(self : LifecycleState) -> String

MessageInfo

source

pub struct MessageInfo {
  kind : MessageKind
  message_id : String?
  creation_datetime : String?
  original_message_id : String?
  entry_count : Int
}

MessageKind

source

pub(all) enum MessageKind {
  Pain001
  Pain002
  Pacs008
  Pacs002
  Camt053
  Unknown
}

MessageKind::name

source

fn MessageKind::name(self : MessageKind) -> String

MessageValidation

source

pub struct MessageValidation {
  info : MessageInfo
  diagnostics : Array[Diagnostic]
}

MessageValidation::is_valid

source

fn MessageValidation::is_valid(self : MessageValidation) -> Bool

MessageValidation::to_json

source

fn MessageValidation::to_json(self : MessageValidation) -> String

MessageValidation::to_markdown

source

fn MessageValidation::to_markdown(self : MessageValidation) -> String

MessageValidation::to_text

source

fn MessageValidation::to_text(self : MessageValidation) -> String

Pain001Summary

source

pub struct Pain001Summary {
  message_id : String?
  creation_datetime : String?
  payment_instruction_count : Int
  transaction_count : Int
}

Basic information extracted from an ISO 20022 pain.001 message.

Pain001Summary::to_text

source

fn Pain001Summary::to_text(self : Pain001Summary) -> String

PaymentRecord

source

pub struct PaymentRecord {
  end_to_end_id : String
  amount : Decimal
  currency : String
}

ReconciliationReport

source

pub struct ReconciliationReport {
  matched : Int
  missing_status : Array[String]
  missing_payment : Array[String]
  status_counts : Map[String, Int]
}

ReconciliationReport::to_json

source

fn ReconciliationReport::to_json(self : ReconciliationReport) -> String

ReconciliationReport::to_markdown

source

fn ReconciliationReport::to_markdown(self : ReconciliationReport) -> String

ReconciliationReport::to_text

source

fn ReconciliationReport::to_text(self : ReconciliationReport) -> String

RuleInfo

source

pub struct RuleInfo {
  code : String
  description : String
}

StatementRecord

source

pub struct StatementRecord {
  end_to_end_id : String
  amount : Decimal
  currency : String
  credit_debit : String
}

StatusRecord

source

pub struct StatusRecord {
  end_to_end_id : String
  status : String
}

ValidationReport

source

pub struct ValidationReport {
  summary : Pain001Summary
  diagnostics : Array[Diagnostic]
}

ValidationReport::is_valid

source

fn ValidationReport::is_valid(self : ValidationReport) -> Bool

ValidationReport::to_json

source

fn ValidationReport::to_json(self : ValidationReport) -> String

ValidationReport::to_markdown

source

fn ValidationReport::to_markdown(self : ValidationReport) -> String

ValidationReport::to_text

source

fn ValidationReport::to_text(self : ValidationReport) -> String

XmlElement

source

pub struct XmlElement {
  name : String
  attributes : Array[(String, String)]
}

XmlElement::get

source

fn XmlElement::get(self : XmlElement, name : String) -> String?

XmlField

source

pub struct XmlField {
  path : String
  attributes : Array[(String, String)]
  text : String?
}

One element or text event with its full XML path.

XmlField::get_attribute

source

fn XmlField::get_attribute(self : XmlField, name : String) -> String?

XmlReader

source

pub struct XmlReader {
  input : Array[Char]
  pos : Int
  line : Int
  column : Int
  tag_stack : Array[String]
  saw_root : Bool
  root_closed : Bool
}

XmlReader::from_string

source

fn XmlReader::from_string(text : String) -> XmlReader

XmlReader::read_event

source

fn XmlReader::read_event(self : XmlReader) -> Event raise XmlParseError

detect_message_kind

source

fn detect_message_kind(xml_text : String) -> MessageKind raise XmlParseError

elements_by_suffix

source

fn elements_by_suffix(fields : Array[XmlField], suffix : String) -> Array[XmlField]

fields_by_suffix

source

fn fields_by_suffix(fields : Array[XmlField], suffix : String) -> Array[XmlField]

first_text_by_suffix

source

fn first_text_by_suffix(fields : Array[XmlField], suffix : String) -> String?

flatten_xml

source

fn flatten_xml(xml_text : String) -> Array[XmlField] raise XmlParseError

lifecycle_report

source

fn lifecycle_report(pain_xml : String, status_xml : String, statement_xml : String) -> LifecycleReport raise XmlParseError

pain001_payment_records

source

fn pain001_payment_records(xml_text : String) -> Array[PaymentRecord] raise XmlParseError

reconcile_pain001_status

source

fn reconcile_pain001_status(pain_xml : String, status_xml : String) -> ReconciliationReport raise XmlParseError

rule_catalog

source

fn rule_catalog() -> Array[RuleInfo]

statement_records

source

fn statement_records(xml_text : String) -> Array[StatementRecord] raise XmlParseError

status_records

source

fn status_records(xml_text : String) -> Array[StatusRecord] raise XmlParseError

summarize_pain001

source

fn summarize_pain001(xml_text : String) -> Pain001Summary raise XmlParseError

texts_by_suffix

source

fn texts_by_suffix(fields : Array[XmlField], suffix : String) -> Array[String]

validate_message

source

fn validate_message(xml_text : String) -> MessageValidation raise XmlParseError

validate_pain001

source

fn validate_pain001(xml_text : String) -> ValidationReport raise XmlParseError

version

source

fn version() -> String

Public version marker used by the CLI and tests.

Source Files

Site source Report issue Packages Build queue Skills Statistics

mooniso_lite

#MoonISO Lite

#Implementation

#Status

#Run

#Rules

#License

#Project description

#XmlParseError

#Decimal

#Decimal::add

#Decimal::compare

#Decimal::is_positive

#Decimal::parse

#Decimal::to_string

#Decimal::zero

#Diagnostic

#Event

#EventKind

#LifecycleCase

#LifecycleReport

#LifecycleReport::to_json

#LifecycleReport::to_markdown

#LifecycleReport::to_text

#LifecycleState

#LifecycleState::name

#MessageInfo

#MessageKind

#MessageKind::name

#MessageValidation

#MessageValidation::is_valid

#MessageValidation::to_json

#MessageValidation::to_markdown

#MessageValidation::to_text

#Pain001Summary

#Pain001Summary::to_text

#PaymentRecord

#ReconciliationReport

#ReconciliationReport::to_json

#ReconciliationReport::to_markdown

#ReconciliationReport::to_text

#RuleInfo

#StatementRecord

#StatusRecord

#ValidationReport

#ValidationReport::is_valid

#ValidationReport::to_json

#ValidationReport::to_markdown

#ValidationReport::to_text

#XmlElement

#XmlElement::get

#XmlField

#XmlField::get_attribute

#XmlReader

#XmlReader::from_string

#XmlReader::read_event

#detect_message_kind

#elements_by_suffix

#fields_by_suffix

#first_text_by_suffix

#flatten_xml

#lifecycle_report

#pain001_payment_records

#reconcile_pain001_status

#rule_catalog

#statement_records

#status_records

#summarize_pain001

#texts_by_suffix

#validate_message

#validate_pain001

#version

Source Files

XmlParseError

Decimal

Decimal::add

Decimal::compare

Decimal::is_positive

Decimal::parse

Decimal::to_string

Decimal::zero

Diagnostic

Event

EventKind

LifecycleCase

LifecycleReport

LifecycleReport::to_json

LifecycleReport::to_markdown

LifecycleReport::to_text

LifecycleState

LifecycleState::name

MessageInfo

MessageKind

MessageKind::name

MessageValidation

MessageValidation::is_valid

MessageValidation::to_json

MessageValidation::to_markdown

MessageValidation::to_text

Pain001Summary

Pain001Summary::to_text

PaymentRecord

ReconciliationReport

ReconciliationReport::to_json

ReconciliationReport::to_markdown

ReconciliationReport::to_text

RuleInfo

StatementRecord

StatusRecord

ValidationReport

ValidationReport::is_valid

ValidationReport::to_json

ValidationReport::to_markdown

ValidationReport::to_text

XmlElement

XmlElement::get

XmlField

XmlField::get_attribute

XmlReader

XmlReader::from_string

XmlReader::read_event

detect_message_kind

elements_by_suffix

fields_by_suffix

first_text_by_suffix

flatten_xml

lifecycle_report

pain001_payment_records

reconcile_pain001_status

rule_catalog

statement_records

status_records

summarize_pain001

texts_by_suffix

validate_message

validate_pain001

version