PayInEventAcknowledgementV02

camt.063.001.02

The PayInEventAcknowledgement message is sent by a participant of a central system to the central system to confirm a PayInSchedule or a PayInCall has been received.

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
%% PayInEventAcknowledgementV02 recursion level 0 with max 0
class PayInEventAcknowledgementV02{
    MessageIdentification IsoMax35Text
    SettlementSessionIdentifier IsoExact4AlphaNumericText
}
PayInEventAcknowledgementV02 *-- "1..1" IAcknowledgementDetails1Choice : AcknowledgementDetails
PayInEventAcknowledgementV02 *-- "0..1" SupplementaryData1 : SupplementaryData
  

Now, we will zero-in one-by-one on each of these building blocks.

MessageIdentification building block

Unique and unambiguous identifier for the message, as assigned by the sender. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

SettlementSessionIdentifier building block

To indicate the requested CLS Settlement Session that the related trade is part of. Specifies an alphanumeric string with a length of 4 characters. For comparison, see the ISO20022 official specification This message is declared as Exact4AlphaNumericText in the ISO specification. In our implementation, it is represented in source code as IsoExact4AlphaNumericText. Due to global using directives, it is treated as a System.String by the compiler and runtime.

AcknowledgementDetails building block

Details of the pay in schedule or pay in call being acknowledged. Reference of the PayInSchedule or the PayInCall being acknowledged. This is the Message Identification element from the Report Data sequence of the Pay In Schedule message or the Pay In Call message.

For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IAcknowledgementDetails1Choice recursion level 0 with max 1
  

AcknowledgementDetails1Choice members

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

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the PayInEventAcknowledgementV02 implementation follows a specific implementaiton pattern. First of all, PayInEventAcknowledgementV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PayInEventAcknowledgementV02Document implements IOuterDocument. Because PayInEventAcknowledgementV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PayInEventAcknowledgementV02.

classDiagram
    class IOuterRecord
    PayInEventAcknowledgementV02 --|> IOuterRecord : Implements
    PayInEventAcknowledgementV02Document --|> IOuterDocument~PayInEventAcknowledgementV02~ : Implements
    class IOuterDocument~PayInEventAcknowledgementV02~ {
        PayInEventAcknowledgementV02 Message
     }
  

Document wrapper for serialization

The only real purpose PayInEventAcknowledgementV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.063.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using PayInEventAcknowledgementV02.ToDocument() method. The returned PayInEventAcknowledgementV02Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    PayInEventAcknowledgementV02Document *-- PayInEventAcknowledgementV02 : 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:camt.063.001.02">
    <PayInEvtAck>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <SttlmSsnIdr>
            <!-- SettlementSessionIdentifier inner content -->
        </SttlmSsnIdr>
        <AckDtls>
            <!-- AcknowledgementDetails inner content -->
        </AckDtls>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </PayInEvtAck>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_eii_URnXEeKKXqHkeUjBbw"
  name="PayInEventAcknowledgementV02"
  definition="The PayInEventAcknowledgement message is sent by a participant of a central system to the central system to confirm a PayInSchedule or a PayInCall has been received.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_nB3wITJaEeOX98kTVpuqCw _wiatARJsEeSstbhSoCHcWw"
  xmlTag="PayInEvtAck"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_1VTQczp7EeKXK8qRvydwAw"
    name="MessageIdentification"
    definition="Unique and unambiguous identifier for the message, as assigned by the sender."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_SY6S7R3bEeKXIbeXfdPzuw"
    name="SettlementSessionIdentifier"
    definition="To indicate the requested CLS Settlement Session that the related trade is part of."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SttlmSsnIdr"
    simpleType="_YYLJ6Np-Ed-ak6NoX_4Aeg_-1265890753" />
  <messageBuildingBlock
    xmi:id="_eii_VxnXEeKKXqHkeUjBbw"
    name="AcknowledgementDetails"
    definition="Details of the pay in schedule or pay in call being acknowledged."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AckDtls"
    complexType="_oIaocSzSEeKZfox_pyYpTA" />
  <messageBuildingBlock
    xmi:id="_Cu8KTy53EeKwTrPDLMbLxA"
    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="camt"
    messageFunctionality="063"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.