remt.001.001.02
The RemittanceAdvice message allows the originator to provide remittance details that can be associated with a 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
%% RemittanceAdviceV02 recursion level 0 with max 0
RemittanceAdviceV02 *-- "1..1" GroupHeader62 : GroupHeader
RemittanceAdviceV02 *-- "1..1" RemittanceInformation12 : RemittanceInformation
RemittanceAdviceV02 *-- "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 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 |
RemittanceInformation building block
Provides information to enable the matching of an entry with the items that the associated payment is intended to settle, such as commercial invoices in an accounts’ receivable system, tax obligations, or garnishment orders. Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts’ receivable system. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% RemittanceInformation12 recursion level 0 with max 1
class RemittanceInformation12{
RemittanceIdentification IsoMax35Text
Unstructured IsoMax140Text
}
RemittanceInformation12 *-- "0..0" StructuredRemittanceInformation13 : Structured
RemittanceInformation12 *-- "1..1" OriginalPaymentInformation6 : OriginalPaymentInformation
%% StructuredRemittanceInformation13 recursion level 1 with max 1
class StructuredRemittanceInformation13{
AdditionalRemittanceInformation IsoMax140Text
}
StructuredRemittanceInformation13 *-- "0..0" ReferredDocumentInformation7 : ReferredDocumentInformation
StructuredRemittanceInformation13 *-- "0..1" RemittanceAmount2 : ReferredDocumentAmount
StructuredRemittanceInformation13 *-- "0..1" CreditorReferenceInformation2 : CreditorReferenceInformation
StructuredRemittanceInformation13 *-- "0..1" PartyIdentification43 : Invoicer
StructuredRemittanceInformation13 *-- "0..1" PartyIdentification43 : Invoicee
StructuredRemittanceInformation13 *-- "0..1" TaxInformation4 : TaxRemittance
StructuredRemittanceInformation13 *-- "0..1" Garnishment1 : GarnishmentRemittance
%% OriginalPaymentInformation6 recursion level 1 with max 1
class OriginalPaymentInformation6{
RequestedExecutionDate IsoISODate
RequestedCollectionDate IsoISODate
}
OriginalPaymentInformation6 *-- "1..1" TransactionReferences4 : References
OriginalPaymentInformation6 *-- "0..1" PaymentTypeInformation19 : PaymentTypeInformation
OriginalPaymentInformation6 *-- "0..1" IAmountType3Choice : Amount
OriginalPaymentInformation6 *-- "0..1" ExchangeRate1 : ExchangeRateInformation
OriginalPaymentInformation6 *-- "0..1" PartyIdentification43 : Debtor
OriginalPaymentInformation6 *-- "0..1" CashAccount24 : DebtorAccount
OriginalPaymentInformation6 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
OriginalPaymentInformation6 *-- "0..1" PartyIdentification43 : Creditor
OriginalPaymentInformation6 *-- "0..1" CashAccount24 : CreditorAccount
OriginalPaymentInformation6 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
RemittanceInformation12 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| RemittanceIdentification | Unique identification, assigned by the originator, to unambiguously identify the remittance information within the message. | IsoMax35Text - Optional 0..1 |
| Unstructured | Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts’ receivable system, in an unstructured form. | IsoMax140Text - Unknown 0..0 |
| Structured | Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts’ receivable system, in a structured form. | StructuredRemittanceInformation13 - Unknown 0..0 |
| OriginalPaymentInformation | Set of elements used to provide information on the original transactions, to which the remittance message refers. | OriginalPaymentInformation6 - 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 RemittanceAdviceV02 implementation follows a specific implementaiton pattern. First of all, RemittanceAdviceV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RemittanceAdviceV02Document implements IOuterDocument. Because RemittanceAdviceV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RemittanceAdviceV02.
classDiagram
class IOuterRecord
RemittanceAdviceV02 --|> IOuterRecord : Implements
RemittanceAdviceV02Document --|> IOuterDocument~RemittanceAdviceV02~ : Implements
class IOuterDocument~RemittanceAdviceV02~ {
RemittanceAdviceV02 Message
}
Document wrapper for serialization
The only real purpose RemittanceAdviceV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:remt.001.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RemittanceAdviceV02.ToDocument() method. The returned RemittanceAdviceV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RemittanceAdviceV02Document *-- RemittanceAdviceV02 : 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.001.001.02">
<RmtAdvc>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<RmtInf>
<!-- RemittanceInformation inner content -->
</RmtInf>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</RmtAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_pmmdrTqxEeWZFYSPlduMhw"
nextVersions="_FS_0QZRpEeazAtAtDSg0Nw"
previousVersion="_6pWyMKMBEeKl_NvHIICqIw"
name="RemittanceAdviceV02"
definition="The RemittanceAdvice message allows the originator to provide remittance details that can be associated with a payment."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="RmtAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_pmmdrzqxEeWZFYSPlduMhw"
type="purpose" />
<messageBuildingBlock
xmi:id="_pmmdsTqxEeWZFYSPlduMhw"
nextVersions="_FS_0RZRpEeazAtAtDSg0Nw"
previousVersion="_cemzIYbEEeOQ1t7OpS76mQ"
name="GroupHeader"
definition="Set of characteristics shared by all remittance information included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_aYOyMaCmEeKBuYKLDCCgNQ" />
<messageBuildingBlock
xmi:id="_pmmdszqxEeWZFYSPlduMhw"
nextVersions="_FS_0R5RpEeazAtAtDSg0Nw"
previousVersion="_icmd0KMCEeKl_NvHIICqIw"
name="RemittanceInformation"
definition="Provides information to enable the matching of an entry with the items that the associated payment is intended to settle, such as commercial invoices in an accounts' receivable system, tax obligations, or garnishment orders."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="RmtInf"
complexType="_5EPL8Tq4EeWZFYSPlduMhw" />
<messageBuildingBlock
xmi:id="_pmmdtTqxEeWZFYSPlduMhw"
nextVersions="_FS_0SZRpEeazAtAtDSg0Nw"
previousVersion="_eQOm4Id2EeOtHe_dAuWsBQ"
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="001"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.