Class MT103_STP

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

    @Generated
    public class MT103_STP
    extends AbstractMT
    implements java.io.Serializable
    MT 103_STP - Single Customer Credit Transfer.

    SWIFT MT103_STP (ISO 15022) message structure:

    • Field 20 (M)
    • Field 13 C (O) (repetitive)
    • Field 23 B (M)
    • Field 23 E (O) (repetitive)
    • Field 26 T (O)
    • Field 32 A (M)
    • Field 33 B (O)
    • Field 36 (O)
    • Field 50 A,F,K (M)
    • Field 52 A (O)
    • Field 53 A,B (O)
    • Field 54 A (O)
    • Field 55 A (O)
    • Field 56 A (O)
    • Field 57 A (O)
    • Field 59 A,F,NONE (M)
    • Field 70 (O)
    • Field 71 A (M)
    • Field 71 F (O) (repetitive)
    • Field 71 G (O)
    • Field 72 (O)
    • Field 77 B (O)

    This source code is specific to release SRU 2022

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

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NAME
      Constant for MT name, this is part of the classname, after MT.
      static int SRU
      Constant identifying the SRU to which this class belongs to.
      • Fields inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

        m
    • Constructor Summary

      Constructors 
      Constructor Description
      MT103_STP()
      Creates and initializes a new MT103_STP input message setting TEST BICS as sender and receiver.
      MT103_STP​(MtSwiftMessage m)
      Creates an MT103_STP initialized with the parameter MtSwiftMessage.
      MT103_STP​(SwiftMessage m)
      Creates an MT103_STP initialized with the parameter SwiftMessage.
      MT103_STP​(java.io.File file)
      Creates a new MT103_STP by parsing a file with the message content in its swift FIN format.
      MT103_STP​(java.io.InputStream stream)
      Creates a new MT103_STP by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
      MT103_STP​(java.lang.String fin)
      Creates a new MT103_STP by parsing a String with the message content in its swift FIN format.
      MT103_STP​(java.lang.String sender, java.lang.String receiver)
      Creates and initializes a new MT103_STP input message from sender to receiver.
    • 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

      • MT103_STP

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

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

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

        public MT103_STP​(java.lang.String sender,
                         java.lang.String receiver)
        Creates and initializes a new MT103_STP 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
      • MT103_STP

        public MT103_STP​(java.lang.String fin)
        Creates a new MT103_STP 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
      • MT103_STP

        public MT103_STP​(java.io.InputStream stream)
                  throws java.io.IOException
        Creates a new MT103_STP 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
      • MT103_STP

        public MT103_STP​(java.io.File file)
                  throws java.io.IOException
        Creates a new MT103_STP 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 MT103_STP parse​(MtSwiftMessage m)
        Creates an MT103_STP initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT103_STP content
        Returns:
        the created object or null if the parameter is null
        Since:
        7.7
        See Also:
        MT103_STP(String)
      • parse

        public static MT103_STP parse​(java.lang.String fin)
        Creates a new MT103_STP by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT103_STP 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 MT103_STP or null if fin is null
        Since:
        7.7
      • parse

        public static MT103_STP parse​(java.io.InputStream stream)
                               throws java.io.IOException
        Creates a new MT103_STP 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 MT103_STP 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 MT103_STP parse​(java.io.File file)
                               throws java.io.IOException
        Creates a new MT103_STP 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 MT103_STP 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 MT103_STP 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 MT103_STP 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 MT103_STP 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 MT103_STP fromJson​(java.lang.String json)
        Creates an MT103_STP 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 MT103_STP message
        Returns:
        a new instance of MT103_STP
        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 MT103_STP 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)
      • getField23B

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

        public Field26T getField26T()
        Iterates through block4 fields and return the first one whose name matches 26T, or null if none is found. The first occurrence of field 26T at MT103_STP is expected to be the only one.
        Returns:
        a Field26T 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 MT103_STP 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)
      • getField33B

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

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

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

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

        public Field50K getField50K()
        Iterates through block4 fields and return the first one whose name matches 50K, or null if none is found. The first occurrence of field 50K at MT103_STP is expected to be the only one.
        Returns:
        a Field50K 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 MT103_STP 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)
      • 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 MT103_STP 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 MT103_STP 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)
      • 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 MT103_STP 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)
      • getField55A

        public Field55A getField55A()
        Iterates through block4 fields and return the first one whose name matches 55A, or null if none is found. The first occurrence of field 55A at MT103_STP is expected to be the only one.
        Returns:
        a Field55A 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 MT103_STP 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)
      • 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 MT103_STP 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)
      • getField59A

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

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

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

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

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

        public Field71G getField71G()
        Iterates through block4 fields and return the first one whose name matches 71G, or null if none is found. The first occurrence of field 71G at MT103_STP is expected to be the only one.
        Returns:
        a Field71G 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 MT103_STP 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)
      • getField77B

        public Field77B getField77B()
        Iterates through block4 fields and return the first one whose name matches 77B, or null if none is found. The first occurrence of field 77B at MT103_STP is expected to be the only one.
        Returns:
        a Field77B 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 MT103_STP 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)
      • getField23E

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

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