Prowide ISO 20022 API Reference

Prowide ISO 20022

The Prowide ISO 20022 library implements the foundation classes to manage ISO 20022 (MX) messages in Java

The scope of this javadoc is the features distributed in the pw-iso20022-SRUYYYY-version.jar

The Javadoc is not comprehensive. Due to the large number of classes in the library, many have been excluded from this Javadoc to reduce the overall generated HTML size. Representative examples of some message categories were kept.

This library provides a comprehensive parser and model for all ISO 20022 message categories. The API features include parsing messages from XML format to Java, serializing Java model objects into the XML format and the conversion between ISO messages and JSON.

The library implements the general ISO 20022 standard. Complementary packages with restricted ISO versions such as SIC, SEPA and CBPR+ are provided in the complementary, proprietary (not open source) library Prowide Integrator.

This library is based on some components from the Prowide Core base library. So in order to use this, you will need also the dependency for the pw-swift-core jar.

MX classes are split in two main packages:

  1. com.prowidesoftware.swift.mx.model.dic: which contains all dictionary classes, in other words, classes representing business entities which are used inside MX messages. Due to the large number of classes in this package, it is excluded from the generated javadoc. This model objects are simple POJO implementations for each element within an ISO 20022 messages. The key feature of the generated model is that business dictionary elements are shared across all message types (they are not coupled to any specific namespace).
  2. com.prowidesoftware.swift.mx.model: which contains classes that represent MX messages and provides the entry point to parse, build or serialize a message.

The sys subpackage includes classes for the MX system messages.

Creating MX messages

          MxPacs00800108 mx = new MxPacs00800108();
          // fill objects with setters (there is one setter per available element)
          String xml = mx.message();

Parsing MX messages

          String xml = "..."; // xml here
          MxPacs00800108 mx = MxPacs00800108.parse(xml);

Additional resources

  1. http://dev.prowidesoftware.com


For ISO 20022 messages validation, SEPA, CBPR+, TARGET2 and other restricted ISO versions, please check the Integrator version at http://www.prowidesoftware.com/products/integrator

SWIFT is a trademark of S.W.I.F.T. SCRL.

Packages 
Package Description
com.prowidesoftware.swift.model  
com.prowidesoftware.swift.model.mx
Base package for classes that model SWIFT MX messages.
com.prowidesoftware.swift.model.mx.adapters  
com.prowidesoftware.swift.model.mx.sys