remt.002.001.01
The RemittanceLocationAdvice message allows the originator of the message to identify where the remittance advice is located for a related payment.
Message Construction
Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification
classDiagram
direction LR
%% RemittanceLocationAdviceV01 recursion level 0 with max 0
RemittanceLocationAdviceV01 *-- "1..1" GroupHeader62 : GroupHeader
RemittanceLocationAdviceV01 *-- "1..1" RemittanceLocation3 : RemittanceLocation
RemittanceLocationAdviceV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Set of characteristics shared by all remittance location information included in the message. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% GroupHeader62 recursion level 0 with max 1
class GroupHeader62{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
CopyIndicator CopyDuplicate1Code
}
GroupHeader62 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader62 *-- "1..1" PartyIdentification43 : InitiatingParty
GroupHeader62 *-- "0..1" PartyIdentification43 : MessageRecipient
GroupHeader62 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : ForwardingAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
Name IsoMax140Text
CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
Name IsoMax140Text
CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
GroupHeader62 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period. | IsoMax35Text - Required 1..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| Authorisation | User identification or any user key to be used to check whether the initiating party is allowed to initiate transactions from the account specified in the message. | |
| CopyIndicator | Specifies if this document is a copy, a duplicate, or a duplicate of a copy. | CopyDuplicate1Code - Optional 0..1 |
| InitiatingParty | Party that initiates the payment. | |
| MessageRecipient | Party authorised by the account owner to receive information about movements on the account. | PartyIdentification43 - Optional 0..1 |
| ForwardingAgent | Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
RemittanceLocation building block
Provides information related to location and/or delivery of the remittance information. This information is used to enable the matching of an entry with the items that the associated payment is intended to settle. Provides information on the remittance advice. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% RemittanceLocation3 recursion level 0 with max 1
class RemittanceLocation3{
RemittanceIdentification IsoMax35Text
}
RemittanceLocation3 *-- "1..0" RemittanceLocationDetails1 : RemittanceLocationDetails
RemittanceLocation3 *-- "1..1" TransactionReferences4 : References
%% RemittanceLocationDetails1 recursion level 1 with max 1
class RemittanceLocationDetails1{
Method RemittanceLocationMethod2Code
ElectronicAddress IsoMax2048Text
}
RemittanceLocationDetails1 *-- "0..1" NameAndAddress10 : PostalAddress
%% TransactionReferences4 recursion level 1 with max 1
class TransactionReferences4{
PaymentInformationIdentification IsoMax35Text
InstructionIdentification IsoMax35Text
EndToEndIdentification IsoMax35Text
TransactionIdentification IsoMax35Text
MandateIdentification IsoMax35Text
}
TransactionReferences4 *-- "0..1" PartyIdentification43 : CreditorSchemeIdentification
RemittanceLocation3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| RemittanceIdentification | Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice. | IsoMax35Text - Optional 0..1 |
| RemittanceLocationDetails | Set of elements used to provide information on the location and/or delivery of the remittance information. | RemittanceLocationDetails1 - Unknown 1..0 |
| References | Identifies the underlying transaction. | TransactionReferences4 - Required 1..1 |
SupplementaryData building block
Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
| Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the RemittanceLocationAdviceV01 implementation follows a specific implementaiton pattern. First of all, RemittanceLocationAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RemittanceLocationAdviceV01Document implements IOuterDocument. Because RemittanceLocationAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RemittanceLocationAdviceV01.
classDiagram
class IOuterRecord
RemittanceLocationAdviceV01 --|> IOuterRecord : Implements
RemittanceLocationAdviceV01Document --|> IOuterDocument~RemittanceLocationAdviceV01~ : Implements
class IOuterDocument~RemittanceLocationAdviceV01~ {
RemittanceLocationAdviceV01 Message
}
Document wrapper for serialization
The only real purpose RemittanceLocationAdviceV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:remt.002.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RemittanceLocationAdviceV01.ToDocument() method. The returned RemittanceLocationAdviceV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RemittanceLocationAdviceV01Document *-- RemittanceLocationAdviceV01 : Document
Sample of message format
This is an abbreviated version of what the message should look like.
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:remt.002.001.01">
<RmtLctnAdvc>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<RmtLctn>
<!-- RemittanceLocation inner content -->
</RmtLctn>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</RmtLctnAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_10RAoKMDEeKl_NvHIICqIw"
nextVersions="_bf9SWW2PEei3KuUgpx7Xcw"
name="RemittanceLocationAdviceV01"
definition="The RemittanceLocationAdvice message allows the originator of the message to identify where the remittance advice is located for a related payment."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ _oPiPBKV8EeW0_oPI5GRpwg"
xmlTag="RmtLctnAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_2ZOH0KMDEeKl_NvHIICqIw"
type="purpose" />
<messageBuildingBlock
xmi:id="_CPP6oKMEEeKl_NvHIICqIw"
nextVersions="_bf9SXW2PEei3KuUgpx7Xcw"
name="GroupHeader"
definition="Set of characteristics shared by all remittance location information included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_aYOyMaCmEeKBuYKLDCCgNQ" />
<messageBuildingBlock
xmi:id="_EkZ0IKMEEeKl_NvHIICqIw"
nextVersions="_bf9SX22PEei3KuUgpx7Xcw"
name="RemittanceLocation"
definition="Provides information related to location and/or delivery of the remittance information. This information is used to enable the matching of an entry with the items that the associated payment is intended to settle."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="RmtLctn"
complexType="_duvyIaMDEeKl_NvHIICqIw" />
<messageBuildingBlock
xmi:id="_jk6zoId2EeOtHe_dAuWsBQ"
nextVersions="_bf9SYW2PEei3KuUgpx7Xcw"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="remt"
messageFunctionality="002"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.