caaa.005.001.06
The AcceptorCancellationRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to request the cancellation of a successfully completed transaction. Cancellation should only occur before the transaction has been cleared.
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
%% AcceptorCancellationRequestV06 recursion level 0 with max 0
AcceptorCancellationRequestV06 *-- "1..1" Header30 : Header
AcceptorCancellationRequestV06 *-- "1..1" AcceptorCancellationRequest6 : CancellationRequest
AcceptorCancellationRequestV06 *-- "0..1" ContentInformationType15 : 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
%% Header30 recursion level 0 with max 1
class Header30{
MessageFunction MessageFunction10Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
CreationDateTime IsoISODateTime
}
Header30 *-- "1..1" GenericIdentification53 : InitiatingParty
Header30 *-- "0..1" GenericIdentification94 : RecipientParty
Header30 *-- "0..0" Traceability5 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification94 recursion level 1 with max 1
class GenericIdentification94{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
GenericIdentification94 *-- "0..1" NetworkParameters5 : RemoteAccess
%% Traceability5 recursion level 1 with max 1
class Traceability5{
ProtocolName IsoMax35Text
ProtocolVersion IsoMax6Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability5 *-- "1..1" GenericIdentification76 : RelayIdentification
Header30 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction10Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoNumber - 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. | GenericIdentification53 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification94 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability5 - 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
%% AcceptorCancellationRequest6 recursion level 0 with max 1
AcceptorCancellationRequest6 *-- "1..1" CardPaymentEnvironment59 : Environment
AcceptorCancellationRequest6 *-- "1..1" CardPaymentContext22 : Context
AcceptorCancellationRequest6 *-- "1..1" CardPaymentTransaction74 : Transaction
%% CardPaymentEnvironment59 recursion level 1 with max 1
CardPaymentEnvironment59 *-- "0..1" Acquirer4 : Acquirer
CardPaymentEnvironment59 *-- "0..1" Organisation25 : Merchant
CardPaymentEnvironment59 *-- "1..1" PointOfInteraction7 : POI
CardPaymentEnvironment59 *-- "1..1" PaymentCard26 : Card
CardPaymentEnvironment59 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment59 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment59 *-- "0..1" CardPaymentToken3 : PaymentToken
%% CardPaymentContext22 recursion level 1 with max 1
CardPaymentContext22 *-- "1..1" PaymentContext22 : PaymentContext
CardPaymentContext22 *-- "0..1" SaleContext2 : SaleContext
%% CardPaymentTransaction74 recursion level 1 with max 1
class CardPaymentTransaction74{
TransactionCapture IsoTrueFalseIndicator
MerchantCategoryCode IsoMin3Max4Text
CustomerConsent IsoTrueFalseIndicator
CardProgrammeProposed IsoMax35Text
CardProgrammeApplied IsoMax35Text
SaleReferenceIdentification IsoMax35Text
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction74 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction74 *-- "1..1" CardPaymentTransaction52 : OriginalTransaction
CardPaymentTransaction74 *-- "1..1" CardPaymentTransactionDetails34 : TransactionDetails
AcceptorCancellationRequest6 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment59 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext22 - Required 1..1 |
| Transaction | Cancellation transaction between an acceptor and an acquirer. | CardPaymentTransaction74 - 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
%% ContentInformationType15 recursion level 0 with max 1
class ContentInformationType15{
ContentType ContentType2Code
}
ContentInformationType15 *-- "1..1" AuthenticatedData4 : AuthenticatedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType15 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData4 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCancellationRequestV06 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationRequestV06 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationRequestV06Document implements IOuterDocument. Because AcceptorCancellationRequestV06 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationRequestV06.
classDiagram
class IOuterRecord
AcceptorCancellationRequestV06 --|> IOuterRecord : Implements
AcceptorCancellationRequestV06Document --|> IOuterDocument~AcceptorCancellationRequestV06~ : Implements
class IOuterDocument~AcceptorCancellationRequestV06~ {
AcceptorCancellationRequestV06 Message
}
Document wrapper for serialization
The only real purpose AcceptorCancellationRequestV06Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.005.001.06’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationRequestV06.ToDocument() method. The returned AcceptorCancellationRequestV06Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCancellationRequestV06Document *-- AcceptorCancellationRequestV06 : 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.06">
<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="_A39QsaqAEeanIZ10Ka8PnA"
nextVersions="_I39HQdpnEeearpaEPXv9UA"
previousVersion="_bq6h8Y1AEeWsypzzYao74A"
name="AcceptorCancellationRequestV06"
definition="The AcceptorCancellationRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to request the cancellation of a successfully completed transaction. Cancellation should only occur before the transaction has been cleared.

"
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCxlReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_A39Qs6qAEeanIZ10Ka8PnA"
type="purpose" />
<messageBuildingBlock
xmi:id="_A39QtaqAEeanIZ10Ka8PnA"
nextVersions="_I39HRdpnEeearpaEPXv9UA"
previousVersion="_bq6h9Y1AEeWsypzzYao74A"
name="Header"
definition="Cancellation request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_IWFRgY0PEeWRYffwL7E13A" />
<messageBuildingBlock
xmi:id="_A39Qt6qAEeanIZ10Ka8PnA"
nextVersions="_I39HR9pnEeearpaEPXv9UA"
previousVersion="_bq6h941AEeWsypzzYao74A"
name="CancellationRequest"
definition="Information related to the cancellation request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlReq"
complexType="_wO-FMap_EeanIZ10Ka8PnA" />
<messageBuildingBlock
xmi:id="_A39QuaqAEeanIZ10Ka8PnA"
nextVersions="_I39uUdpnEeearpaEPXv9UA"
previousVersion="_bq6h-Y1AEeWsypzzYao74A"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="005"
flavour="001"
version="06" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.