cain.013.001.01
The AcquirerRejection message is sent by any party, to reject an Acquirer to Issuer 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 %% AcquirerRejection recursion level 0 with max 0 AcquirerRejection *-- "1..1" Header19 : Header AcquirerRejection *-- "1..1" AcceptorRejection4 : Reject
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Information related to the protocol management. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Header19 recursion level 0 with max 1 class Header19{ MessageFunction MessageFunction6Code OriginalMessageFunction MessageFunction6Code ProtocolVersion IsoMax6Text ExchangeIdentification IsoMax3NumericText ReTransmissionCounter IsoMax3NumericText CreationDateTime IsoISODateTime } Header19 *-- "0..1" GenericIdentification73 : InitiatingParty Header19 *-- "0..1" GenericIdentification73 : RecipientParty Header19 *-- "0..0" Traceability3 : Traceability %% GenericIdentification73 recursion level 1 with max 1 class GenericIdentification73{ Identification IsoMax35Text Type PartyType9Code Issuer PartyType9Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } %% GenericIdentification73 recursion level 1 with max 1 class GenericIdentification73{ Identification IsoMax35Text Type PartyType9Code Issuer PartyType9Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } %% Traceability3 recursion level 1 with max 1 class Traceability3{ TraceDateTimeIn IsoISODateTime TraceDateTimeOut IsoISODateTime } Traceability3 *-- "1..1" GenericIdentification74 : RelayIdentification
Header19 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageFunction | Identifies the type of process related to the message. | MessageFunction6Code - Required 1..1 |
OriginalMessageFunction | Identifies the type of process related to the message which has to be reversed. | MessageFunction6Code - Optional 0..1 |
ProtocolVersion | Version of the acquirer to issuer protocol specifications. | IsoMax6Text - Required 1..1 |
ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax3NumericText - Required 1..1 |
ReTransmissionCounter | Number of retransmission of the message. Incremented by 1 for each retransmission. | IsoMax3NumericText - Optional 0..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. | GenericIdentification73 - Optional 0..1 |
RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification73 - Optional 0..1 |
Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability3 - 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 %% AcceptorRejection4 recursion level 0 with max 1 class AcceptorRejection4{ RejectReason RejectReason1Code MessageInError IsoMax100KBinary } AcceptorRejection4 *-- "0..0" ErrorReporting1 : ErrorReporting %% ErrorReporting1 recursion level 1 with max 1 class ErrorReporting1{ Type IsoMax35Text Description IsoMax500Text }
AcceptorRejection4 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
RejectReason | Reject reason of the message. | RejectReason1Code - Required 1..1 |
ErrorReporting | Detailed description of an error that caused the rejection for further analysis. | ErrorReporting1 - Unknown 0..0 |
MessageInError | Original request that caused the party to reject it. | IsoMax100KBinary - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcquirerRejection implementation follows a specific implementaiton pattern. First of all, AcquirerRejection impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcquirerRejectionDocument implements IOuterDocument. Because AcquirerRejection implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcquirerRejection.
classDiagram class IOuterRecord AcquirerRejection --|> IOuterRecord : Implements AcquirerRejectionDocument --|> IOuterDocument~AcquirerRejection~ : Implements class IOuterDocument~AcquirerRejection~ { AcquirerRejection Message }
Document wrapper for serialization
The only real purpose AcquirerRejectionDocument serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.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 AcquirerRejection.ToDocument() method. The returned AcquirerRejectionDocument value will serialize correctly according to ISO 20022 standards.
classDiagram AcquirerRejectionDocument *-- AcquirerRejection : 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:cain.013.001.01">
<AcqrrRjctn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Rjct>
<!-- Reject inner content -->
</Rjct>
</AcqrrRjctn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_ohEDEHvSEeS2PZh7wUMQog"
nextVersions="_ow6JocsZEeizUq4cFQ71-Q"
name="AcquirerRejection"
definition="The AcquirerRejection message is sent by any party, to reject an Acquirer to Issuer message."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AcqrrRjctn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_DiKccHvUEeS7Wv4oKCO8_A"
name="Header"
definition="Information related to the protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_Hrm-EXvUEeS7Wv4oKCO8_A" />
<messageBuildingBlock
xmi:id="_e8V5oHvUEeS7Wv4oKCO8_A"
name="Reject"
definition="Information related to the reject."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Rjct"
complexType="_MZve4YPcEeSgq87JnUGd8A" />
<messageDefinitionIdentifier
businessArea="cain"
messageFunctionality="013"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.