MT559 (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.AbstractMessage
- - com.prowidesoftware.swift.model.mt.AbstractMT
  - - com.prowidesoftware.swift.model.mt.mt5xx.MT559

All Implemented Interfaces:

java.io.Serializable
```
@Generated
public class MT559
extends AbstractMT
implements java.io.Serializable
```
MT 559 - Paying Agent's Claim

SWIFT MT559 (ISO 15022) message structure:
- Field 19 (M)
- Field 23 (M)
- Field 53 A,C,D (O)
- Field 57 A,B,D (O)
- Field 72 (O)
- Sequence _A (M) (repetitive)
  - Field 20 (M)
  - Field 35 A (M)
  - Field 35 B (M)
  - Field 35 C,D (O)
  - Field 35 E (O)
  - Field 35 U (O)
  - Field 31 E (O)
  - Field 31 L (O)
  - Field 31 C (O)
  - Field 31 S (O)
  - Field 80 C (O)
  - Field 33 T (O)
  - Field 35 L (O)
  - Field 32 M (O)
  - Field 32 G (O)
  - Field 71 C (O)
  - Field 71 B (O)
  - Field 36 (O)
  - Field 34 A (M)
  - Field 75 (O)
  - Field 72 (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`	`A` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsA.A
`static java.lang.String`	`BON` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsB.BON
`static java.lang.String`	`CER` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsC.CER
`static java.lang.String`	`CPN` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsC.CPN
`static java.lang.String`	`F` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsF.F
`static java.lang.String`	`FMT` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsF.FMT
`static java.lang.String`	`M` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsM.M
`static java.lang.String`	`MSC` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsM.MSC
`static java.lang.String`	`NAME` Constant for MT name, this is part of the classname, after `MT`
`static java.lang.String`	`OPC` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsO.OPC
`static java.lang.String`	`OPS` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsO.OPS
`static java.lang.String`	`PRC` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsP.PRC
`static java.lang.String`	`PRS` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsP.PRS
`static java.lang.String`	`Q` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsQ.Q
`static java.lang.String`	`RTE` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsR.RTE
`static java.lang.String`	`RTS` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsR.RTS
`static java.lang.String`	`S` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsS.S
`static java.lang.String`	`SHS` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsS.SHS
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.
`static java.lang.String`	`UNT` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsU.UNT
`static java.lang.String`	`WTS` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsW.WTS
`static java.lang.String`	`X` Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsX.X

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

Constructor Summary

Constructors
Constructor and Description
`MT559()` Creates and initializes a new MT559 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
`MT559(java.io.File file)` Creates a new MT559 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.
`MT559(java.io.InputStream stream)` Creates a new MT559 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.
`MT559(int messageType, java.lang.String sender, java.lang.String receiver)` Deprecated. Use instead `new MT559(sender, receiver)` instead
`MT559(MtSwiftMessage m)` Creates an MT559 initialized with the parameter MtSwiftMessage.
`MT559(java.lang.String fin)` Creates a new MT559 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.
`MT559(java.lang.String sender, java.lang.String receiver)` Creates and initializes a new MT559 input message from sender to receiver. All mandatory header attributes are completed with default values.
`MT559(SwiftMessage m)` Creates an MT559 initialized with the parameter SwiftMessage

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MT559`	`append(Field... fields)` Add all the fields to the end of the block4.
`MT559`	`append(SwiftTagListBlock block)` Add all tags from block to the end of the block4.
`MT559`	`append(Tag... tags)` Add all tags to the end of the block4.
`Field19`	`getField19()` Iterates through block4 fields and return the first one whose name matches 19, or `null` if none is found. The first occurrence of field 19 at MT559 is expected to be the only one.
`java.util.List<Field20>`	`getField20()` Iterates through block4 fields and return all occurrences of fields whose names matches 20, or `Collections.emptyList()` if none is found. Multiple occurrences of field 20 at MT559 are expected at one sequence or across several sequences.
`Field23`	`getField23()` Iterates through block4 fields and return the first one whose name matches 23, or `null` if none is found. The first occurrence of field 23 at MT559 is expected to be the only one.
`java.util.List<Field31C>`	`getField31C()` Iterates through block4 fields and return all occurrences of fields whose names matches 31C, or `Collections.emptyList()` if none is found. Multiple occurrences of field 31C at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field31E>`	`getField31E()` Iterates through block4 fields and return all occurrences of fields whose names matches 31E, or `Collections.emptyList()` if none is found. Multiple occurrences of field 31E at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field31L>`	`getField31L()` Iterates through block4 fields and return all occurrences of fields whose names matches 31L, or `Collections.emptyList()` if none is found. Multiple occurrences of field 31L at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field31S>`	`getField31S()` Iterates through block4 fields and return all occurrences of fields whose names matches 31S, or `Collections.emptyList()` if none is found. Multiple occurrences of field 31S at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field32G>`	`getField32G()` Iterates through block4 fields and return all occurrences of fields whose names matches 32G, or `Collections.emptyList()` if none is found. Multiple occurrences of field 32G at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field32M>`	`getField32M()` Iterates through block4 fields and return all occurrences of fields whose names matches 32M, or `Collections.emptyList()` if none is found. Multiple occurrences of field 32M at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field33T>`	`getField33T()` Iterates through block4 fields and return all occurrences of fields whose names matches 33T, or `Collections.emptyList()` if none is found. Multiple occurrences of field 33T at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field34A>`	`getField34A()` Iterates through block4 fields and return all occurrences of fields whose names matches 34A, or `Collections.emptyList()` if none is found. Multiple occurrences of field 34A at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field35A>`	`getField35A()` Iterates through block4 fields and return all occurrences of fields whose names matches 35A, or `Collections.emptyList()` if none is found. Multiple occurrences of field 35A at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field35B>`	`getField35B()` Iterates through block4 fields and return all occurrences of fields whose names matches 35B, or `Collections.emptyList()` if none is found. Multiple occurrences of field 35B at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field35C>`	`getField35C()` Iterates through block4 fields and return all occurrences of fields whose names matches 35C, or `Collections.emptyList()` if none is found. Multiple occurrences of field 35C at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field35D>`	`getField35D()` Iterates through block4 fields and return all occurrences of fields whose names matches 35D, or `Collections.emptyList()` if none is found. Multiple occurrences of field 35D at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field35E>`	`getField35E()` Iterates through block4 fields and return all occurrences of fields whose names matches 35E, or `Collections.emptyList()` if none is found. Multiple occurrences of field 35E at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field35L>`	`getField35L()` Iterates through block4 fields and return all occurrences of fields whose names matches 35L, or `Collections.emptyList()` if none is found. Multiple occurrences of field 35L at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field35U>`	`getField35U()` Iterates through block4 fields and return all occurrences of fields whose names matches 35U, or `Collections.emptyList()` if none is found. Multiple occurrences of field 35U at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field36>`	`getField36()` Iterates through block4 fields and return all occurrences of fields whose names matches 36, or `Collections.emptyList()` if none is found. Multiple occurrences of field 36 at MT559 are expected at one sequence or across several sequences.
`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 MT559 is expected to be the only one.
`Field53C`	`getField53C()` Iterates through block4 fields and return the first one whose name matches 53C, or `null` if none is found. The first occurrence of field 53C at MT559 is expected to be the only one.
`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 MT559 is expected to be the only one.
`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 MT559 is expected to be the only one.
`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 MT559 is expected to be the only one.
`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 MT559 is expected to be the only one.
`java.util.List<Field71B>`	`getField71B()` Iterates through block4 fields and return all occurrences of fields whose names matches 71B, or `Collections.emptyList()` if none is found. Multiple occurrences of field 71B at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field71C>`	`getField71C()` Iterates through block4 fields and return all occurrences of fields whose names matches 71C, or `Collections.emptyList()` if none is found. Multiple occurrences of field 71C at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field72>`	`getField72()` Iterates through block4 fields and return all occurrences of fields whose names matches 72, or `Collections.emptyList()` if none is found. Multiple occurrences of field 72 at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field75>`	`getField75()` Iterates through block4 fields and return all occurrences of fields whose names matches 75, or `Collections.emptyList()` if none is found. Multiple occurrences of field 75 at MT559 are expected at one sequence or across several sequences.
`java.util.List<Field80C>`	`getField80C()` Iterates through block4 fields and return all occurrences of fields whose names matches 80C, or `Collections.emptyList()` if none is found. Multiple occurrences of field 80C at MT559 are expected at one sequence or across several sequences.
`java.lang.String`	`getMessageType()` Returns this MT number
`static MT559`	`parse(java.io.File file)` Creates a new MT559 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 MT559`	`parse(java.io.InputStream stream)` Creates a new MT559 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 MT559`	`parse(MtSwiftMessage m)` Creates an MT559 initialized with the parameter MtSwiftMessage.
`static MT559`	`parse(java.lang.String fin)` Creates a new MT559 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT559 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
  - A
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String A
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsA.A
    
    Constant for qualifier with value A
    
    See Also:
    
    SchemeConstantsA.A, Constant Field Values
  - BON
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String BON
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsB.BON
    
    Constant for qualifier with value BON
    
    See Also:
    
    SchemeConstantsB.BON, Constant Field Values
  - CER
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String CER
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsC.CER
    
    Constant for qualifier with value CER
    
    See Also:
    
    SchemeConstantsC.CER, Constant Field Values
  - CPN
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String CPN
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsC.CPN
    
    Constant for qualifier with value CPN
    
    See Also:
    
    SchemeConstantsC.CPN, 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
  - FMT
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String FMT
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsF.FMT
    
    Constant for qualifier with value FMT
    
    See Also:
    
    SchemeConstantsF.FMT, Constant Field Values
  - M
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String M
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsM.M
    
    Constant for qualifier with value M
    
    See Also:
    
    SchemeConstantsM.M, Constant Field Values
  - MSC
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String MSC
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsM.MSC
    
    Constant for qualifier with value MSC
    
    See Also:
    
    SchemeConstantsM.MSC, Constant Field Values
  - OPC
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String OPC
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsO.OPC
    
    Constant for qualifier with value OPC
    
    See Also:
    
    SchemeConstantsO.OPC, Constant Field Values
  - OPS
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String OPS
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsO.OPS
    
    Constant for qualifier with value OPS
    
    See Also:
    
    SchemeConstantsO.OPS, Constant Field Values
  - PRC
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String PRC
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsP.PRC
    
    Constant for qualifier with value PRC
    
    See Also:
    
    SchemeConstantsP.PRC, Constant Field Values
  - PRS
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String PRS
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsP.PRS
    
    Constant for qualifier with value PRS
    
    See Also:
    
    SchemeConstantsP.PRS, Constant Field Values
  - Q
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String Q
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsQ.Q
    
    Constant for qualifier with value Q
    
    See Also:
    
    SchemeConstantsQ.Q, Constant Field Values
  - RTE
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String RTE
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsR.RTE
    
    Constant for qualifier with value RTE
    
    See Also:
    
    SchemeConstantsR.RTE, Constant Field Values
  - RTS
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String RTS
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsR.RTS
    
    Constant for qualifier with value RTS
    
    See Also:
    
    SchemeConstantsR.RTS, 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
  - SHS
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String SHS
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsS.SHS
    
    Constant for qualifier with value SHS
    
    See Also:
    
    SchemeConstantsS.SHS, Constant Field Values
  - UNT
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String UNT
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsU.UNT
    
    Constant for qualifier with value UNT
    
    See Also:
    
    SchemeConstantsU.UNT, Constant Field Values
  - WTS
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String WTS
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsW.WTS
    
    Constant for qualifier with value WTS
    
    See Also:
    
    SchemeConstantsW.WTS, Constant Field Values
  - X
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public static final java.lang.String X
```
    Deprecated. use instead com.prowidesoftware.swift.SchemeConstantsX.X
    
    Constant for qualifier with value X
    
    See Also:
    
    SchemeConstantsX.X, Constant Field Values
- Constructor Detail
  - MT559
```
public MT559(SwiftMessage m)
```
    Creates an MT559 initialized with the parameter SwiftMessage
    
    Parameters:
    
    m - swift message with the MT559 content
  - MT559
```
public MT559(MtSwiftMessage m)
```
    Creates an MT559 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT559 content, the parameter can not be null
    
    See Also:
    
    MT559(String)
  - MT559
```
public MT559()
```
    Creates and initializes a new MT559 input message setting TEST BICS as sender and receiver.
    All mandatory header attributes are completed with default values.
    
    Since:
    
    7.6
  - MT559
```
public MT559(java.lang.String sender,
             java.lang.String receiver)
```
    Creates and initializes a new MT559 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
  - MT559
```
@Deprecated
 @ProwideDeprecated(phase3=_2018)
public MT559(int messageType,
                                                           java.lang.String sender,
                                                           java.lang.String receiver)
```
    Deprecated. Use instead new MT559(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:
    
    MT559(String, String)
  - MT559
```
public MT559(java.lang.String fin)
```
    Creates a new MT559 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
  - MT559
```
public MT559(java.io.InputStream stream)
      throws java.io.IOException
```
    Creates a new MT559 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
  - MT559
```
public MT559(java.io.File file)
      throws java.io.IOException
```
    Creates a new MT559 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 MT559 parse(MtSwiftMessage m)
```
    Creates an MT559 initialized with the parameter MtSwiftMessage.
    
    Parameters:
    
    m - swift message with the MT559 content
    
    Returns:
    
    the created object or null if the parameter is null
    
    Since:
    
    7.7
    
    See Also:
    
    MT559(String)
  - parse
```
public static MT559 parse(java.lang.String fin)
```
    Creates a new MT559 by parsing a String with the message content in its swift FIN format.
    If the fin parameter cannot be parsed, the returned MT559 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 MT559 or null if fin is null
    
    Since:
    
    7.7
  - parse
```
public static MT559 parse(java.io.InputStream stream)
                   throws java.io.IOException
```
    Creates a new MT559 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 MT559 or null if stream is null or the message cannot be parsed
    
    Throws:
    
    java.io.IOException
    
    Since:
    
    7.7
  - parse
```
public static MT559 parse(java.io.File file)
                   throws java.io.IOException
```
    Creates a new MT559 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 MT559 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 MT559 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 MT559 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 MT559 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
  - getField19
```
public Field19 getField19()
```
    Iterates through block4 fields and return the first one whose name matches 19, or null if none is found.
    The first occurrence of field 19 at MT559 is expected to be the only one.
    
    Returns:
    
    a Field19 object or null if the field is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagByName(String)
  - getField23
```
public Field23 getField23()
```
    Iterates through block4 fields and return the first one whose name matches 23, or null if none is found.
    The first occurrence of field 23 at MT559 is expected to be the only one.
    
    Returns:
    
    a Field23 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 MT559 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)
  - getField53C
```
public Field53C getField53C()
```
    Iterates through block4 fields and return the first one whose name matches 53C, or null if none is found.
    The first occurrence of field 53C at MT559 is expected to be the only one.
    
    Returns:
    
    a Field53C 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 MT559 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)
  - 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 MT559 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 MT559 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 MT559 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)
  - getField20
```
public java.util.List<Field20> getField20()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 20, or Collections.emptyList() if none is found.
    Multiple occurrences of field 20 at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field20 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField35A
```
public java.util.List<Field35A> getField35A()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 35A, or Collections.emptyList() if none is found.
    Multiple occurrences of field 35A at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field35A objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField35B
```
public java.util.List<Field35B> getField35B()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 35B, or Collections.emptyList() if none is found.
    Multiple occurrences of field 35B at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field35B objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField35C
```
public java.util.List<Field35C> getField35C()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 35C, or Collections.emptyList() if none is found.
    Multiple occurrences of field 35C at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field35C objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField35D
```
public java.util.List<Field35D> getField35D()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 35D, or Collections.emptyList() if none is found.
    Multiple occurrences of field 35D at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field35D objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField35E
```
public java.util.List<Field35E> getField35E()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 35E, or Collections.emptyList() if none is found.
    Multiple occurrences of field 35E at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field35E objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField35U
```
public java.util.List<Field35U> getField35U()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 35U, or Collections.emptyList() if none is found.
    Multiple occurrences of field 35U at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field35U objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField31E
```
public java.util.List<Field31E> getField31E()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 31E, or Collections.emptyList() if none is found.
    Multiple occurrences of field 31E at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field31E objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField31L
```
public java.util.List<Field31L> getField31L()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 31L, or Collections.emptyList() if none is found.
    Multiple occurrences of field 31L at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field31L objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField31C
```
public java.util.List<Field31C> getField31C()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 31C, or Collections.emptyList() if none is found.
    Multiple occurrences of field 31C at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field31C objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField31S
```
public java.util.List<Field31S> getField31S()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 31S, or Collections.emptyList() if none is found.
    Multiple occurrences of field 31S at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field31S objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField80C
```
public java.util.List<Field80C> getField80C()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 80C, or Collections.emptyList() if none is found.
    Multiple occurrences of field 80C at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field80C objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField33T
```
public java.util.List<Field33T> getField33T()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 33T, or Collections.emptyList() if none is found.
    Multiple occurrences of field 33T at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field33T objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField35L
```
public java.util.List<Field35L> getField35L()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 35L, or Collections.emptyList() if none is found.
    Multiple occurrences of field 35L at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field35L objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField32M
```
public java.util.List<Field32M> getField32M()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 32M, or Collections.emptyList() if none is found.
    Multiple occurrences of field 32M at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field32M objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField32G
```
public java.util.List<Field32G> getField32G()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 32G, or Collections.emptyList() if none is found.
    Multiple occurrences of field 32G at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field32G objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField71C
```
public java.util.List<Field71C> getField71C()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 71C, or Collections.emptyList() if none is found.
    Multiple occurrences of field 71C at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field71C objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField71B
```
public java.util.List<Field71B> getField71B()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 71B, or Collections.emptyList() if none is found.
    Multiple occurrences of field 71B at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field71B objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField36
```
public java.util.List<Field36> getField36()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 36, or Collections.emptyList() if none is found.
    Multiple occurrences of field 36 at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field36 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField34A
```
public java.util.List<Field34A> getField34A()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 34A, or Collections.emptyList() if none is found.
    Multiple occurrences of field 34A at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field34A objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField75
```
public java.util.List<Field75> getField75()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 75, or Collections.emptyList() if none is found.
    Multiple occurrences of field 75 at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field75 objects or Collections.emptyList() if none is not found
    
    Throws:
    
    java.lang.IllegalStateException - if SwiftMessage object is not initialized
    
    See Also:
    
    SwiftTagListBlock.getTagsByName(String)
  - getField72
```
public java.util.List<Field72> getField72()
```
    Iterates through block4 fields and return all occurrences of fields whose names matches 72, or Collections.emptyList() if none is found.
    Multiple occurrences of field 72 at MT559 are expected at one sequence or across several sequences.
    
    Returns:
    
    a List of Field72 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 MT559

MT 559 - Paying Agent's Claim

SWIFT MT559 (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

A

BON

CER

CPN

F

FMT

M

MSC

OPC

OPS

PRC

PRS

Q

RTE

RTS

S

SHS

UNT

WTS

X

Constructor Detail

MT559

MT559

MT559

MT559

MT559

MT559

MT559

MT559

Method Detail

parse

parse

parse

parse

getMessageType

append

append

append

getField19

getField23

getField53A

getField53C

getField53D

getField57A

getField57B

getField57D

getField20

getField35A

getField35B

getField35C

getField35D

getField35E

getField35U

getField31E

getField31L

getField31C

getField31S

getField80C

getField33T

getField35L

getField32M

getField32G

getField71C

getField71B

getField36

getField34A

getField75