casp.013.001.01
A Message Rejection is sent by one of the parties when it detects a technical or functional error in a previous received message.
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 %% SaleToPOIMessageRejectionV01 recursion level 0 with max 0 SaleToPOIMessageRejectionV01 *-- "1..1" Header37 : Header SaleToPOIMessageRejectionV01 *-- "1..1" AcceptorRejection2 : Reject
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Set of characteristics related to the transfer of the request. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Header37 recursion level 0 with max 1 class Header37{ MessageFunction RetailerMessage1Code ProtocolVersion IsoMax6Text ExchangeIdentification IsoMax35Text CreationDateTime IsoISODateTime } Header37 *-- "1..1" GenericIdentification171 : InitiatingParty Header37 *-- "0..1" GenericIdentification171 : RecipientParty Header37 *-- "0..0" Traceability6 : Traceability %% GenericIdentification171 recursion level 1 with max 1 class GenericIdentification171{ Identification IsoMax35Text Type PartyType3Code Issuer PartyType4Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } GenericIdentification171 *-- "0..1" NetworkParameters5 : RemoteAccess GenericIdentification171 *-- "0..1" Geolocation1 : Geolocation %% GenericIdentification171 recursion level 1 with max 1 class GenericIdentification171{ Identification IsoMax35Text Type PartyType3Code Issuer PartyType4Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } GenericIdentification171 *-- "0..1" NetworkParameters5 : RemoteAccess GenericIdentification171 *-- "0..1" Geolocation1 : Geolocation %% Traceability6 recursion level 1 with max 1 class Traceability6{ ProtocolName IsoMax35Text ProtocolVersion IsoMax6Text TraceDateTimeIn IsoISODateTime TraceDateTimeOut IsoISODateTime } Traceability6 *-- "1..1" GenericIdentification171 : RelayIdentification
Header37 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageFunction | Identifies the type of process related to the message. | RetailerMessage1Code - Required 1..1 |
ProtocolVersion | Version of the acquirer protocol specifications. | IsoMax6Text - Required 1..1 |
ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax35Text - Required 1..1 |
CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification171 - Required 1..1 |
RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification171 - Optional 0..1 |
Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability6 - Unknown 0..0 |
Reject building block
Information related to the reject. Reject of an exchange. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AcceptorRejection2 recursion level 0 with max 1 class AcceptorRejection2{ RejectReason RejectReason1Code AdditionalInformation IsoMax500Text MessageInError IsoMax100KBinary }
AcceptorRejection2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
RejectReason | Reject reason of the request or the advice. | RejectReason1Code - Required 1..1 |
AdditionalInformation | Additional information related to the reject of the exchange. | IsoMax500Text - Optional 0..1 |
MessageInError | Original request that caused the recipient party to reject it. | IsoMax100KBinary - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the SaleToPOIMessageRejectionV01 implementation follows a specific implementaiton pattern. First of all, SaleToPOIMessageRejectionV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIMessageRejectionV01Document implements IOuterDocument. Because SaleToPOIMessageRejectionV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIMessageRejectionV01.
classDiagram class IOuterRecord SaleToPOIMessageRejectionV01 --|> IOuterRecord : Implements SaleToPOIMessageRejectionV01Document --|> IOuterDocument~SaleToPOIMessageRejectionV01~ : Implements class IOuterDocument~SaleToPOIMessageRejectionV01~ { SaleToPOIMessageRejectionV01 Message }
Document wrapper for serialization
The only real purpose SaleToPOIMessageRejectionV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.013.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIMessageRejectionV01.ToDocument() method. The returned SaleToPOIMessageRejectionV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram SaleToPOIMessageRejectionV01Document *-- SaleToPOIMessageRejectionV01 : 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:casp.013.001.01">
<SaleToPOIMsgRjctn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Rjct>
<!-- Reject inner content -->
</Rjct>
</SaleToPOIMsgRjctn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_4R49hN6cEeiwsev40qZGEQ"
nextVersions="_IAhL0Q1UEeqjM-rxn3HuXQ"
name="SaleToPOIMessageRejectionV01"
definition="A Message Rejection is sent by one of the parties when it detects a technical or functional error in a previous received message."
registrationStatus="Registered"
messageSet="_IwdwsFSSEeqZkqCw0Z-zEQ"
xmlTag="SaleToPOIMsgRjctn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_4R49ht6cEeiwsev40qZGEQ"
nextVersions="_IAhy4Q1UEeqjM-rxn3HuXQ"
name="Header"
definition="Set of characteristics related to the transfer of the request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_vgI-odj3EeiojJsa6FYyew" />
<messageBuildingBlock
xmi:id="_vgCQ4d6dEeiwsev40qZGEQ"
nextVersions="_IAhy4w1UEeqjM-rxn3HuXQ"
name="Reject"
definition="Information related to the reject."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Rjct"
complexType="_8TjN8TTfEeO5e9wx3yvd8g" />
<messageDefinitionIdentifier
businessArea="casp"
messageFunctionality="013"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.