Class MT202

  • All Implemented Interfaces:
    JsonSerializable, java.io.Serializable

    @Generated
    public class MT202
    extends AbstractMT
    implements java.io.Serializable
    MT 202 - General Financial Institution Transfer.

    SWIFT MT202 (ISO 15022) message structure:

    • Field 20 (M)
    • Field 21 (M)
    • Field 13 C (O) (repetitive)
    • Field 32 A (M)
    • Field 52 A,D (O)
    • Field 53 A,B,D (O)
    • Field 54 A,B,D (O)
    • Field 56 A,D (O)
    • Field 57 A,B,D (O)
    • Field 58 A,D (M)
    • Field 72 (O)

    This source code is specific to release SRU 2023

    For additional resources check https://www.prowidesoftware.com/resources

    See Also:
    Serialized Form
    • Field Detail

      • SRU

        public static final int SRU
        Constant identifying the SRU to which this class belongs to.
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Constant for MT name, this is part of the classname, after MT.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MT202

        public MT202​(SwiftMessage m)
        Creates an MT202 initialized with the parameter SwiftMessage.
        Parameters:
        m - swift message with the MT202 content
      • MT202

        public MT202​(MtSwiftMessage m)
        Creates an MT202 initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT202 content, the parameter can not be null
        See Also:
        MT202(String)
      • MT202

        public MT202()
        Creates and initializes a new MT202 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
        Since:
        7.6
      • MT202

        public MT202​(java.lang.String sender,
                     java.lang.String receiver)
        Creates and initializes a new MT202 input message from sender to receiver. All mandatory header attributes are completed with default values. In particular the sender and receiver addresses will be filled with proper default LT identifier and branch codes if not provided,
        Parameters:
        sender - the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters
        receiver - the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters
        Since:
        7.7
      • MT202

        public MT202​(java.lang.String fin)
        Creates a new MT202 by parsing a String with the message content in its swift FIN format. If the fin parameter is null or the message cannot be parsed, the internal message object will be initialized (blocks will be created) but empty. If the string contains multiple messages, only the first one will be parsed.
        Parameters:
        fin - a string with the MT message in its FIN swift format
        Since:
        7.7
      • MT202

        public MT202​(java.io.InputStream stream)
              throws java.io.IOException
        Creates a new MT202 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding. If the message content is null or cannot be parsed, the internal message object will be initialized (blocks will be created) but empty. If the stream contains multiple messages, only the first one will be parsed.
        Parameters:
        stream - an input stream in UTF-8 encoding with the MT message in its FIN swift format.
        Throws:
        java.io.IOException - if the stream data cannot be read
        Since:
        7.7
      • MT202

        public MT202​(java.io.File file)
              throws java.io.IOException
        Creates a new MT202 by parsing a file with the message content in its swift FIN format. If the file content is null or cannot be parsed as a message, the internal message object will be initialized (blocks will be created) but empty. If the file contains multiple messages, only the first one will be parsed.
        Parameters:
        file - a file with the MT message in its FIN swift format.
        Throws:
        java.io.IOException - if the file content cannot be read
        Since:
        7.7
    • Method Detail

      • parse

        public static MT202 parse​(MtSwiftMessage m)
        Creates an MT202 initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT202 content
        Returns:
        the created object or null if the parameter is null
        Since:
        7.7
        See Also:
        MT202(String)
      • parse

        public static MT202 parse​(java.lang.String fin)
        Creates a new MT202 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT202 will have its internal message object initialized (blocks will be created) but empty. If the string contains multiple messages, only the first one will be parsed.
        Parameters:
        fin - a string with the MT message in its FIN swift format. fin may be null in which case this method returns null
        Returns:
        a new instance of MT202 or null if fin is null
        Since:
        7.7
      • parse

        public static MT202 parse​(java.io.InputStream stream)
                           throws java.io.IOException
        Creates a new MT202 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding. If the stream contains multiple messages, only the first one will be parsed.
        Parameters:
        stream - an input stream in UTF-8 encoding with the MT message in its FIN swift format.
        Returns:
        a new instance of MT202 or null if stream is null or the message cannot be parsed
        Throws:
        java.io.IOException - if the stream data cannot be read
        Since:
        7.7
      • parse

        public static MT202 parse​(java.io.File file)
                           throws java.io.IOException
        Creates a new MT202 by parsing a file with the message content in its swift FIN format. If the file contains multiple messages, only the first one will be parsed.
        Parameters:
        file - a file with the MT message in its FIN swift format.
        Returns:
        a new instance of MT202 or null if; file is null, does not exist, can't be read, is not a file or the message cannot be parsed
        Throws:
        java.io.IOException - if the file content cannot be read
        Since:
        7.7
      • getMessageType

        public java.lang.String getMessageType()
        Returns this MT number.
        Specified by:
        getMessageType in class AbstractMT
        Returns:
        the message type number of this MT
        Since:
        6.4
      • getUETR

        public java.lang.String getUETR()
        Gets the Unique End to End Transaction Reference (field 121 from block 3).

        This field is used by the SWIFT gpi service to track payments messages.

        Returns:
        the UETR value or null if block3 or field 121 in block3 are not present
        Since:
        7.10.0
      • append

        public MT202 append​(SwiftTagListBlock block)
        Add all tags from block to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        block - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • append

        public MT202 append​(Tag... tags)
        Add all tags to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        tags - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • append

        public MT202 append​(Field... fields)
        Add all the fields to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        fields - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • fromJson

        public static MT202 fromJson​(java.lang.String json)
        Creates an MT202 messages from its JSON representation.

        For generic conversion of JSON into the corresponding MT instance see AbstractMT.fromJson(String)

        Parameters:
        json - a JSON representation of an MT202 message
        Returns:
        a new instance of MT202
        Since:
        7.10.3
      • getField20

        public Field20 getField20()
        Iterates through block4 fields and return the first one whose name matches 20, or null if none is found. The first occurrence of field 20 at MT202 is expected to be the only one.
        Returns:
        a Field20 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField21

        public Field21 getField21()
        Iterates through block4 fields and return the first one whose name matches 21, or null if none is found. The first occurrence of field 21 at MT202 is expected to be the only one.
        Returns:
        a Field21 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField32A

        public Field32A getField32A()
        Iterates through block4 fields and return the first one whose name matches 32A, or null if none is found. The first occurrence of field 32A at MT202 is expected to be the only one.
        Returns:
        a Field32A object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField52A

        public Field52A getField52A()
        Iterates through block4 fields and return the first one whose name matches 52A, or null if none is found. The first occurrence of field 52A at MT202 is expected to be the only one.
        Returns:
        a Field52A object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField52D

        public Field52D getField52D()
        Iterates through block4 fields and return the first one whose name matches 52D, or null if none is found. The first occurrence of field 52D at MT202 is expected to be the only one.
        Returns:
        a Field52D object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField53A

        public Field53A getField53A()
        Iterates through block4 fields and return the first one whose name matches 53A, or null if none is found. The first occurrence of field 53A at MT202 is expected to be the only one.
        Returns:
        a Field53A object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField53B

        public Field53B getField53B()
        Iterates through block4 fields and return the first one whose name matches 53B, or null if none is found. The first occurrence of field 53B at MT202 is expected to be the only one.
        Returns:
        a Field53B object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField53D

        public Field53D getField53D()
        Iterates through block4 fields and return the first one whose name matches 53D, or null if none is found. The first occurrence of field 53D at MT202 is expected to be the only one.
        Returns:
        a Field53D object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField54A

        public Field54A getField54A()
        Iterates through block4 fields and return the first one whose name matches 54A, or null if none is found. The first occurrence of field 54A at MT202 is expected to be the only one.
        Returns:
        a Field54A object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField54B

        public Field54B getField54B()
        Iterates through block4 fields and return the first one whose name matches 54B, or null if none is found. The first occurrence of field 54B at MT202 is expected to be the only one.
        Returns:
        a Field54B object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField54D

        public Field54D getField54D()
        Iterates through block4 fields and return the first one whose name matches 54D, or null if none is found. The first occurrence of field 54D at MT202 is expected to be the only one.
        Returns:
        a Field54D object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField56A

        public Field56A getField56A()
        Iterates through block4 fields and return the first one whose name matches 56A, or null if none is found. The first occurrence of field 56A at MT202 is expected to be the only one.
        Returns:
        a Field56A object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField56D

        public Field56D getField56D()
        Iterates through block4 fields and return the first one whose name matches 56D, or null if none is found. The first occurrence of field 56D at MT202 is expected to be the only one.
        Returns:
        a Field56D object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField57A

        public Field57A getField57A()
        Iterates through block4 fields and return the first one whose name matches 57A, or null if none is found. The first occurrence of field 57A at MT202 is expected to be the only one.
        Returns:
        a Field57A object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField57B

        public Field57B getField57B()
        Iterates through block4 fields and return the first one whose name matches 57B, or null if none is found. The first occurrence of field 57B at MT202 is expected to be the only one.
        Returns:
        a Field57B object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField57D

        public Field57D getField57D()
        Iterates through block4 fields and return the first one whose name matches 57D, or null if none is found. The first occurrence of field 57D at MT202 is expected to be the only one.
        Returns:
        a Field57D object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField58A

        public Field58A getField58A()
        Iterates through block4 fields and return the first one whose name matches 58A, or null if none is found. The first occurrence of field 58A at MT202 is expected to be the only one.
        Returns:
        a Field58A object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField58D

        public Field58D getField58D()
        Iterates through block4 fields and return the first one whose name matches 58D, or null if none is found. The first occurrence of field 58D at MT202 is expected to be the only one.
        Returns:
        a Field58D object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField72

        public Field72 getField72()
        Iterates through block4 fields and return the first one whose name matches 72, or null if none is found. The first occurrence of field 72 at MT202 is expected to be the only one.
        Returns:
        a Field72 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField13C

        public java.util.List<Field13C> getField13C()
        Iterates through block4 fields and return all occurrences of fields whose names matches 13C, or Collections.emptyList() if none is found. Multiple occurrences of field 13C at MT202 are expected at one sequence or across several sequences.
        Returns:
        a List of Field13C objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)