MT940 (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.AbstractMessage
- - com.prowidesoftware.swift.model.mt.AbstractMT
  - - com.prowidesoftware.swift.model.mt.mt9xx.MT940

All Implemented Interfaces:

java.io.Serializable
```
@Generated
public class MT940
extends AbstractMT
implements java.io.Serializable
```
MT 940 - Customer Statement Message

SWIFT MT940 (ISO 15022) message structure:
- Field 20 (M)
- Field 21 (O)
- Field 25 P,NONE (M)
- Field 28 C (M)
- Field 60 F,M (M)
- Sequence _A (O) (repetitive)
  - Field 61 (O)
  - Field 86 (O)
- Field 62 F,M (M)
- Field 64 (O)
- Field 65 (O) (repetitive)
- Field 86 (O)
This source code is specific to release SRU 2017

For additional resources check http://www.prowidesoftware.com/resources
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`C` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsC.C
`static java.lang.String`	`D` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsD.D
`static java.lang.String`	`F` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsF.F
`static java.lang.String`	`N` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsN.N
`static java.lang.String`	`NAME` Constant for MT name, this is part of the classname, after `MT`
`static java.lang.String`	`RC` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsR.RC
`static java.lang.String`	`RD` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsR.RD
`static java.lang.String`	`S` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsS.S
`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 and Description
`MT940()` Creates and initializes a new MT940 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
`MT940(java.io.File file)` Creates a new MT940 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.
`MT940(java.io.InputStream stream)` Creates a new MT940 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.
`MT940(int messageType, java.lang.String sender, java.lang.String receiver)` Deprecated. Use instead `new MT940(sender, receiver)` instead
`MT940(MtSwiftMessage m)` Creates an MT940 initialized with the parameter MtSwiftMessage.
`MT940(java.lang.String fin)` Creates a new MT940 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.
`MT940(java.lang.String sender, java.lang.String receiver)` Creates and initializes a new MT940 input message from sender to receiver. All mandatory header attributes are completed with default values.
`MT940(SwiftMessage m)` Creates an MT940 initialized with the parameter SwiftMessage

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MT940`	`append(Field... fields)` Add all the fields to the end of the block4.
`MT940`	`append(SwiftTagListBlock block)` Add all tags from block to the end of the block4.
`MT940`	`append(Tag... tags)` Add all tags to the end of the block4.
`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 MT940 is expected to be the only one.
`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 MT940 is expected to be the only one.
`Field25`	`getField25()` Iterates through block4 fields and return the first one whose name matches 25, or `null` if none is found. The first occurrence of field 25 at MT940 is expected to be the only one.
`Field25P`	`getField25P()` Iterates through block4 fields and return the first one whose name matches 25P, or `null` if none is found. The first occurrence of field 25P at MT940 is expected to be the only one.
`Field28C`	`getField28C()` Iterates through block4 fields and return the first one whose name matches 28C, or `null` if none is found. The first occurrence of field 28C at MT940 is expected to be the only one.
`Field60F`	`getField60F()` Iterates through block4 fields and return the first one whose name matches 60F, or `null` if none is found. The first occurrence of field 60F at MT940 is expected to be the only one.
`Field60M`	`getField60M()` Iterates through block4 fields and return the first one whose name matches 60M, or `null` if none is found. The first occurrence of field 60M at MT940 is expected to be the only one.
`java.util.List<Field61>`	`getField61()` Iterates through block4 fields and return all occurrences of fields whose names matches 61, or `Collections.emptyList()` if none is found. Multiple occurrences of field 61 at MT940 are expected at one sequence or across several sequences.
`Field62F`	`getField62F()` Iterates through block4 fields and return the first one whose name matches 62F, or `null` if none is found. The first occurrence of field 62F at MT940 is expected to be the only one.
`Field62M`	`getField62M()` Iterates through block4 fields and return the first one whose name matches 62M, or `null` if none is found. The first occurrence of field 62M at MT940 is expected to be the only one.
`Field64`	`getField64()` Iterates through block4 fields and return the first one whose name matches 64, or `null` if none is found. The first occurrence of field 64 at MT940 is expected to be the only one.
`java.util.List<Field65>`	`getField65()` Iterates through block4 fields and return all occurrences of fields whose names matches 65, or `Collections.emptyList()` if none is found. Multiple occurrences of field 65 at MT940 are expected at one sequence or across several sequences.
`java.util.List<Field86>`	`getField86()` Iterates through block4 fields and return all occurrences of fields whose names matches 86, or `Collections.emptyList()` if none is found. Multiple occurrences of field 86 at MT940 are expected at one sequence or across several sequences.
`java.lang.String`	`getMessageType()` Returns this MT number
`static MT940`	`parse(java.io.File file)` Creates a new MT940 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.
`static MT940`	`parse(java.io.InputStream stream)` Creates a new MT940 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.
`static MT940`	`parse(MtSwiftMessage m)` Creates an MT940 initialized with the parameter MtSwiftMessage.
`static MT940`	`parse(java.lang.String fin)` Creates a new MT940 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT940 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.

Methods inherited from class com.prowidesoftware.swift.model.mt.AbstractMT
addField, containsSequence, containsSequenceList, create, create, FIN, getApplicationId, getLogicalTerminal, getMessagePriority, getMtId, getReceiver, getSender, getSequence, getSequence, getSequence, getSequenceList, getSequenceList, getSequenceNumber, getServiceId, getSessionNumber, getSwiftMessage, getSwiftMessageNotNullOrException, getVariant, isIncoming, isInput, isOutgoing, isOutput, isType, json, message, nameFromClass, read, setReceiver, setReceiver, setSender, setSender, setSwiftMessage, tag, tags, toString, write, write, xml

Methods inherited from class com.prowidesoftware.swift.model.AbstractMessage
getMessageStandardType, isMT, isMX

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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
  - C
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String C
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsC.C
    
    Constant for qualifier with value C
    
    See Also:
    
    SchemeConstantsC.C, Constant Field Values
  - D
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String D
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsD.D
    
    Constant for qualifier with value D
    
    See Also:
    
    SchemeConstantsD.D, Constant Field Values
  - F
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String F
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsF.F
    
    Constant for qualifier with value F
    
    See Also:
    
    SchemeConstantsF.F, Constant Field Values
  - N
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String N
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsN.N
    
    Constant for qualifier with value N
    
    See Also:
    
    SchemeConstantsN.N, Constant Field Values
  - RC
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String RC
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsR.RC
    
    Constant for qualifier with value RC
    
    See Also:
    
    SchemeConstantsR.RC, Constant Field Values
  - RD
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String RD
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsR.RD
    
    Constant for qualifier with value RD
    
    See Also:
    
    SchemeConstantsR.RD, Constant Field Values
  - S
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String S
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsS.S
    
    Constant for qualifier with value S
    
    See Also:
    
    SchemeConstantsS.S, Constant Field Values
- Constructor Detail
  - MT940
```
public MT940(SwiftMessage m)
```
    Creates an MT940 initialized with the parameter SwiftMessage
    
    Parameters:
    
    m - swift message with the MT940 content
  - MT940
```
public MT940(MtSwiftMessage m)
```
    Creates an MT940 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT940 content, the parameter can not be null
    
    See Also:
    
    MT940(String)
  - MT940
```
public MT940()
```
    Creates and initializes a new MT940 input message setting TEST BICS as sender and receiver.
    All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT940
```
public MT940(java.lang.String sender,
             java.lang.String receiver)
```
    Creates and initializes a new MT940 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
  - MT940
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public MT940(int messageType,
                                                           java.lang.String sender,
                                                           java.lang.String receiver)
```
    Deprecated. Use instead new MT940(sender, receiver) instead
    
    DO NOT USE THIS METHOD It is kept for compatibility but will be removed very soon, since the messageType parameter is actually ignored.
    
    See Also:
    
    MT940(String, String)
  - MT940
```
public MT940(java.lang.String fin)
```
    Creates a new MT940 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
  - MT940
```
public MT940(java.io.InputStream stream)
      throws java.io.IOException
```
    Creates a new MT940 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
    
    Since:
    
    7.7
  - MT940
```
public MT940(java.io.File file)
      throws java.io.IOException
```
    Creates a new MT940 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
    
    Since:
    
    7.7
- Method Detail
  - parse
```
public static MT940 parse(MtSwiftMessage m)
```
    Creates an MT940 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT940 content
    
    Returns:
    
    the created object or null if the parameter is null
    
    Since:
    
    7.7
    
    See Also:
    
    MT940(String)
  - parse
```
public static MT940 parse(java.lang.String fin)
```
    Creates a new MT940 by parsing a String with the message content in its swift FIN format.
    If the fin parameter cannot be parsed, the returned MT940 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 MT940 or null if fin is null
    
    Since:
    
    7.7
  - parse
```
public static MT940 parse(java.io.InputStream stream)
                   throws java.io.IOException
```
    Creates a new MT940 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 MT940 or null if stream is null or the message cannot be parsed
    
    Throws:
    
    java.io.IOException
    
    Since:
    
    7.7
  - parse
```
public static MT940 parse(java.io.File file)
                   throws java.io.IOException
```
    Creates a new MT940 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 MT940 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
    
    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
  - append
```
public MT940 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 MT940 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 MT940 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
  - 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 MT940 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 MT940 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)
  - getField25P
```
public Field25P getField25P()
```
    Iterates through block4 fields and return the first one whose name matches 25P, or null if none is found.
    The first occurrence of field 25P at MT940 is expected to be the only one.
    
    Returns:
    
    a Field25P object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField25
```
public Field25 getField25()
```
    Iterates through block4 fields and return the first one whose name matches 25, or null if none is found.
    The first occurrence of field 25 at MT940 is expected to be the only one.
    
    Returns:
    
    a Field25 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField28C
```
public Field28C getField28C()
```
    Iterates through block4 fields and return the first one whose name matches 28C, or null if none is found.
    The first occurrence of field 28C at MT940 is expected to be the only one.
    
    Returns:
    
    a Field28C object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField60F
```
public Field60F getField60F()
```
    Iterates through block4 fields and return the first one whose name matches 60F, or null if none is found.
    The first occurrence of field 60F at MT940 is expected to be the only one.
    
    Returns:
    
    a Field60F object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField60M
```
public Field60M getField60M()
```
    Iterates through block4 fields and return the first one whose name matches 60M, or null if none is found.
    The first occurrence of field 60M at MT940 is expected to be the only one.
    
    Returns:
    
    a Field60M object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField62F
```
public Field62F getField62F()
```
    Iterates through block4 fields and return the first one whose name matches 62F, or null if none is found.
    The first occurrence of field 62F at MT940 is expected to be the only one.
    
    Returns:
    
    a Field62F object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField62M
```
public Field62M getField62M()
```
    Iterates through block4 fields and return the first one whose name matches 62M, or null if none is found.
    The first occurrence of field 62M at MT940 is expected to be the only one.
    
    Returns:
    
    a Field62M object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField64
```
public Field64 getField64()
```
    Iterates through block4 fields and return the first one whose name matches 64, or null if none is found.
    The first occurrence of field 64 at MT940 is expected to be the only one.
    
    Returns:
    
    a Field64 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField61
```
public java.util.List<Field61> getField61()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 61, or Collections.emptyList() if none is found.
    Multiple occurrences of field 61 at MT940 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field61 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField86
```
public java.util.List<Field86> getField86()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 86, or Collections.emptyList() if none is found.
    Multiple occurrences of field 86 at MT940 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field86 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField65
```
public java.util.List<Field65> getField65()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 65, or Collections.emptyList() if none is found.
    Multiple occurrences of field 65 at MT940 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field65 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)

Class MT940

MT 940 - Customer Statement Message

SWIFT MT940 (ISO 15022) message structure:

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

Constructor Summary

Method Summary

Methods inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

Methods inherited from class com.prowidesoftware.swift.model.AbstractMessage

Methods inherited from class java.lang.Object

Field Detail

SRU

NAME

C

D

F

N

RC

RD

S

Constructor Detail

MT940

MT940

MT940

MT940

MT940

MT940

MT940

MT940

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

getField20

getField21

getField25P

getField25

getField28C

getField60F

getField60M

getField62F

getField62M

getField64

getField61

getField86

getField65