admi.007.001.01
The ReceiptAcknowledgement message is sent by the transaction administrator to a member of the system and vice versa. It is sent to acknowledge the receipt of one or multiple messages sent previously. The Acknowledgement message is 1) an application receipt acknowledgement and 2) conveys information about the processing of the original message(s). In case of 2) the ReceiptAcknowledgement can be used as a Generic error message, which provides information about the status (e.g. rejection, acceptance) of an instruction.
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
%% ReceiptAcknowledgementV01 recursion level 0 with max 0
ReceiptAcknowledgementV01 *-- "1..1" MessageHeader10 : MessageIdentification
ReceiptAcknowledgementV01 *-- "1..1" ReceiptAcknowledgementReport2 : Report
ReceiptAcknowledgementV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
MessageIdentification building block
Specifies the identification the message. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageHeader10 recursion level 0 with max 1
class MessageHeader10{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
QueryName IsoMax35Text
}
MessageHeader10 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the sender, to unambiguously identify the message. | Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period. |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Optional 0..1 |
| QueryName | Recalls the criteria (search and return criteria) defined in a preceding query. | IsoMax35Text - Optional 0..1 |
Report building block
Provides report details on the request. Provides details on the original request. Identifies the message being acknowledged and its status For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ReceiptAcknowledgementReport2 recursion level 0 with max 1
ReceiptAcknowledgementReport2 *-- "1..1" MessageReference1 : RelatedReference
ReceiptAcknowledgementReport2 *-- "1..1" RequestHandling2 : RequestHandling
%% MessageReference1 recursion level 1 with max 1
class MessageReference1{
Reference IsoMax35Text
MessageName IsoMax35Text
}
MessageReference1 *-- "0..1" PartyIdentification136 : ReferenceIssuer
%% RequestHandling2 recursion level 1 with max 1
class RequestHandling2{
StatusCode IsoMax4AlphaNumericText
StatusDateTime IsoISODateTime
Description IsoMax140Text
}
ReceiptAcknowledgementReport2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| RelatedReference | Reference of the request. | MessageReference1 - Required 1..1 |
| RequestHandling | Gives the status of the request. | RequestHandling2 - 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 ReceiptAcknowledgementV01 implementation follows a specific implementaiton pattern. First of all, ReceiptAcknowledgementV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReceiptAcknowledgementV01Document implements IOuterDocument. Because ReceiptAcknowledgementV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReceiptAcknowledgementV01.
classDiagram
class IOuterRecord
ReceiptAcknowledgementV01 --|> IOuterRecord : Implements
ReceiptAcknowledgementV01Document --|> IOuterDocument~ReceiptAcknowledgementV01~ : Implements
class IOuterDocument~ReceiptAcknowledgementV01~ {
ReceiptAcknowledgementV01 Message
}
Document wrapper for serialization
The only real purpose ReceiptAcknowledgementV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:admi.007.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ReceiptAcknowledgementV01.ToDocument() method. The returned ReceiptAcknowledgementV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ReceiptAcknowledgementV01Document *-- ReceiptAcknowledgementV01 : 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:admi.007.001.01">
<RctAck>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<Rpt>
<!-- Report inner content -->
</Rpt>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</RctAck>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_4MJ7oZb3Eee4htziCyV8eA"
name="ReceiptAcknowledgementV01"
definition="The ReceiptAcknowledgement message is sent by the transaction administrator to a member of the system and vice versa. It is sent to acknowledge the receipt of one or multiple messages sent previously. The Acknowledgement message is 1) an application receipt acknowledgement and 2) conveys information about the processing of the original message(s). In case of 2) the ReceiptAcknowledgement can be used as a Generic error message, which provides information about the status (e.g. rejection, acceptance) of an instruction."
registrationStatus="Registered"
messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
xmlTag="RctAck"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_4MJ7o5b3Eee4htziCyV8eA"
name="MessageIdentification"
definition="Specifies the identification the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgId"
complexType="_5-JF8Vg_Eeiv7OYKCzUSAg" />
<messageBuildingBlock
xmi:id="_4MJ7pZb3Eee4htziCyV8eA"
name="Report"
definition="Provides report details on the request."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Rpt"
complexType="_WhpTYZb4Eee4htziCyV8eA" />
<messageBuildingBlock
xmi:id="_4MJ7p5b3Eee4htziCyV8eA"
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="admi"
messageFunctionality="007"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.