caaa.005.001.08
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
%% AcceptorCancellationRequestV08 recursion level 0 with max 0
AcceptorCancellationRequestV08 *-- "1..1" Header35 : Header
AcceptorCancellationRequestV08 *-- "1..1" AcceptorCancellationRequest8 : CancellationRequest
AcceptorCancellationRequestV08 *-- "0..1" ContentInformationType16 : 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
%% Header35 recursion level 0 with max 1
class Header35{
MessageFunction MessageFunction14Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
CreationDateTime IsoISODateTime
}
Header35 *-- "1..1" GenericIdentification53 : InitiatingParty
Header35 *-- "0..1" GenericIdentification94 : RecipientParty
Header35 *-- "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
Header35 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction14Code - 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
%% AcceptorCancellationRequest8 recursion level 0 with max 1
AcceptorCancellationRequest8 *-- "1..1" CardPaymentEnvironment68 : Environment
AcceptorCancellationRequest8 *-- "1..1" CardPaymentContext27 : Context
AcceptorCancellationRequest8 *-- "1..1" CardPaymentTransaction82 : Transaction
%% CardPaymentEnvironment68 recursion level 1 with max 1
CardPaymentEnvironment68 *-- "0..1" Acquirer4 : Acquirer
CardPaymentEnvironment68 *-- "0..1" Organisation32 : Merchant
CardPaymentEnvironment68 *-- "0..1" PointOfInteraction8 : POI
CardPaymentEnvironment68 *-- "0..1" PaymentCard28 : Card
CardPaymentEnvironment68 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment68 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment68 *-- "0..1" CardPaymentToken4 : PaymentToken
CardPaymentEnvironment68 *-- "0..1" Cardholder13 : Cardholder
CardPaymentEnvironment68 *-- "0..1" ContentInformationType17 : ProtectedCardholderData
%% CardPaymentContext27 recursion level 1 with max 1
CardPaymentContext27 *-- "0..1" PaymentContext26 : PaymentContext
CardPaymentContext27 *-- "0..1" SaleContext3 : SaleContext
CardPaymentContext27 *-- "0..1" CardDirectDebit2 : DirectDebitContext
%% CardPaymentTransaction82 recursion level 1 with max 1
class CardPaymentTransaction82{
TransactionCapture IsoTrueFalseIndicator
MerchantCategoryCode IsoMin3Max4Text
CustomerConsent IsoTrueFalseIndicator
CardProgrammeProposed IsoMax35Text
CardProgrammeApplied IsoMax35Text
SaleReferenceIdentification IsoMax35Text
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction82 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction82 *-- "1..1" CardPaymentTransaction79 : OriginalTransaction
CardPaymentTransaction82 *-- "1..1" CardPaymentTransactionDetails34 : TransactionDetails
AcceptorCancellationRequest8 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment68 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext27 - Required 1..1 |
| Transaction | Cancellation transaction between an acceptor and an acquirer. | CardPaymentTransaction82 - 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
%% ContentInformationType16 recursion level 0 with max 1
class ContentInformationType16{
ContentType ContentType2Code
}
ContentInformationType16 *-- "1..1" AuthenticatedData5 : AuthenticatedData
%% AuthenticatedData5 recursion level 1 with max 1
class AuthenticatedData5{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData5 *-- "1..0" IRecipient6Choice : Recipient
AuthenticatedData5 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData5 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType16 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). | AuthenticatedData5 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCancellationRequestV08 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationRequestV08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationRequestV08Document implements IOuterDocument. Because AcceptorCancellationRequestV08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationRequestV08.
classDiagram
class IOuterRecord
AcceptorCancellationRequestV08 --|> IOuterRecord : Implements
AcceptorCancellationRequestV08Document --|> IOuterDocument~AcceptorCancellationRequestV08~ : Implements
class IOuterDocument~AcceptorCancellationRequestV08~ {
AcceptorCancellationRequestV08 Message
}
Document wrapper for serialization
The only real purpose AcceptorCancellationRequestV08Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.005.001.08’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationRequestV08.ToDocument() method. The returned AcceptorCancellationRequestV08Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCancellationRequestV08Document *-- AcceptorCancellationRequestV08 : 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.08">
<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="_-yWIAdg0EeipBO1pkKK6zg"
nextVersions="_MAisoQucEeqYM5yH99IYQw"
previousVersion="_I39HQdpnEeearpaEPXv9UA"
name="AcceptorCancellationRequestV08"
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="_-yWIA9g0EeipBO1pkKK6zg"
type="purpose" />
<messageBuildingBlock
xmi:id="_-yWIBdg0EeipBO1pkKK6zg"
nextVersions="_MAispQucEeqYM5yH99IYQw"
previousVersion="_I39HRdpnEeearpaEPXv9UA"
name="Header"
definition="Cancellation request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_igU6wdnGEeeN3v2fup_Shw" />
<messageBuildingBlock
xmi:id="_-yWIB9g0EeipBO1pkKK6zg"
nextVersions="_MAispwucEeqYM5yH99IYQw"
previousVersion="_I39HR9pnEeearpaEPXv9UA"
name="CancellationRequest"
definition="Information related to the cancellation request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlReq"
complexType="_DcPEQdg1EeipBO1pkKK6zg" />
<messageBuildingBlock
xmi:id="_-yWICdg0EeipBO1pkKK6zg"
nextVersions="_MAisqQucEeqYM5yH99IYQw"
previousVersion="_I39uUdpnEeearpaEPXv9UA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_Wb7MEds3Eee9e6xduATmQg" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="005"
flavour="001"
version="08" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.