caaa.005.001.01
Scope The AcceptorCancellationRequest message is sent by a card acceptor to cancel a successfully completed card payment transaction. The message can be sent directly to the acquirer or through an agent. Usage The AcceptorCancellationRequest message is used when the card acceptor is unaware of the cancellation of the transaction by the acquirer.
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
%% AcceptorCancellationRequestV01 recursion level 0 with max 0
AcceptorCancellationRequestV01 *-- "1..1" Header1 : Header
AcceptorCancellationRequestV01 *-- "1..1" AcceptorCancellationRequest1 : CancellationRequest
AcceptorCancellationRequestV01 *-- "1..1" ContentInformationType3 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Cancellation request message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header1 recursion level 0 with max 1
class Header1{
MessageFunction MessageFunction1Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header1 *-- "1..1" GenericIdentification32 : InitiatingParty
Header1 *-- "0..1" GenericIdentification32 : RecipientParty
Header1 *-- "0..0" Traceability1 : Traceability
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
ShortName IsoMax35Text
}
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
ShortName IsoMax35Text
}
%% Traceability1 recursion level 1 with max 1
class Traceability1{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability1 *-- "1..1" GenericIdentification31 : RelayIdentification
Header1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction1Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax3NumericText - 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. | GenericIdentification32 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification32 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability1 - Unknown 0..0 |
CancellationRequest building block
Information related to the cancellation request. Cancellation request from an acceptor. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorCancellationRequest1 recursion level 0 with max 1
AcceptorCancellationRequest1 *-- "1..1" CardPaymentEnvironment4 : Environment
AcceptorCancellationRequest1 *-- "1..1" CardPaymentContext1 : Context
AcceptorCancellationRequest1 *-- "1..1" CardPaymentTransaction5 : Transaction
%% CardPaymentEnvironment4 recursion level 1 with max 1
CardPaymentEnvironment4 *-- "0..1" Acquirer1 : Acquirer
CardPaymentEnvironment4 *-- "0..1" Organisation5 : Merchant
CardPaymentEnvironment4 *-- "1..1" PointOfInteraction1 : POI
CardPaymentEnvironment4 *-- "1..1" PaymentCard3 : Card
%% CardPaymentContext1 recursion level 1 with max 1
CardPaymentContext1 *-- "1..1" PaymentContext1 : PaymentContext
CardPaymentContext1 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction5 recursion level 1 with max 1
class CardPaymentTransaction5{
TransactionCapture IsoTrueFalseIndicator
MerchantCategoryCode IsoMin3Max4Text
ReconciliationIdentification IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction5 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction5 *-- "1..1" CardPaymentTransaction8 : OriginalTransaction
CardPaymentTransaction5 *-- "1..1" CardPaymentTransactionDetails5 : TransactionDetails
AcceptorCancellationRequest1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment4 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext1 - Required 1..1 |
| Transaction | Cancellation transaction between an acceptor and an acquirer. | CardPaymentTransaction5 - Required 1..1 |
SecurityTrailer building block
Trailer of the message containing a MAC. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType3 recursion level 0 with max 1
class ContentInformationType3{
ContentType ContentType1Code
}
ContentInformationType3 *-- "0..0" AuthenticatedData1 : AuthenticatedData
%% AuthenticatedData1 recursion level 1 with max 1
class AuthenticatedData1{
Version IsoNumber
MAC IsoMax35Binary
}
AuthenticatedData1 *-- "1..0" IRecipient1Choice : Recipient
AuthenticatedData1 *-- "1..1" AlgorithmIdentification1 : MACAlgorithm
AuthenticatedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
ContentInformationType3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType1Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData1 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCancellationRequestV01 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationRequestV01Document implements IOuterDocument. Because AcceptorCancellationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationRequestV01.
classDiagram
class IOuterRecord
AcceptorCancellationRequestV01 --|> IOuterRecord : Implements
AcceptorCancellationRequestV01Document --|> IOuterDocument~AcceptorCancellationRequestV01~ : Implements
class IOuterDocument~AcceptorCancellationRequestV01~ {
AcceptorCancellationRequestV01 Message
}
Document wrapper for serialization
The only real purpose AcceptorCancellationRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.005.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationRequestV01.ToDocument() method. The returned AcceptorCancellationRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCancellationRequestV01Document *-- AcceptorCancellationRequestV01 : 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:caaa.005.001.01">
<AccptrCxlReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CxlReq>
<!-- CancellationRequest inner content -->
</CxlReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrCxlReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_cMhxZaMVEeCJ6YNENx4h-w_602094635"
nextVersions="_D8tVoQvgEeK9Xewg3qiFQA"
name="AcceptorCancellationRequestV01"
definition="Scope
The AcceptorCancellationRequest message is sent by a card acceptor to cancel a successfully completed card payment transaction. The message can be sent directly to the acquirer or through an agent.
Usage
The AcceptorCancellationRequest message is used when the card acceptor is unaware of the cancellation of the transaction by the acquirer."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCxlReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_cMhxZqMVEeCJ6YNENx4h-w_368944245"
name="Header"
definition="Cancellation request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
<messageBuildingBlock
xmi:id="_cMq7UKMVEeCJ6YNENx4h-w_-1782226179"
name="CancellationRequest"
definition="Information related to the cancellation request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlReq"
complexType="_Svyr5wEcEeCQm6a_G2yO_w_350804909" />
<messageBuildingBlock
xmi:id="_cMq7UaMVEeCJ6YNENx4h-w_2083735573"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_SvV__AEcEeCQm6a_G2yO_w_153583816" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="005"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.