caaa.003.001.02
The AcceptorCompletionAdvice message is sent by an acceptor (or its agent) to notify the acquirer (or its agent) of the outcome of the payment at the acceptor, and to transfer the financial data of the transaction to the acquirer (capture). A AcceptorCompletionAdvice message is also sent to reverse an approved authorisation and any associated financial transfer (capture), if the card payment transaction could not be completed successfully.
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
%% AcceptorCompletionAdviceV02 recursion level 0 with max 0
AcceptorCompletionAdviceV02 *-- "1..1" Header2 : Header
AcceptorCompletionAdviceV02 *-- "1..1" AcceptorCompletionAdvice2 : CompletionAdvice
AcceptorCompletionAdviceV02 *-- "1..1" ContentInformationType6 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Completion advice message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header2 recursion level 0 with max 1
class Header2{
MessageFunction MessageFunction1Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header2 *-- "1..1" GenericIdentification32 : InitiatingParty
Header2 *-- "0..1" GenericIdentification32 : RecipientParty
Header2 *-- "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
Header2 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 |
| ReTransmissionCounter | Number of retransmissions of the message. | 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. | 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 |
CompletionAdvice building block
Information related to the completion advice. Notification to the acquirer of the completion of the card payment at the acceptor. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorCompletionAdvice2 recursion level 0 with max 1
AcceptorCompletionAdvice2 *-- "1..1" CardPaymentEnvironment10 : Environment
AcceptorCompletionAdvice2 *-- "0..1" CardPaymentContext2 : Context
AcceptorCompletionAdvice2 *-- "1..1" CardPaymentTransaction13 : Transaction
%% CardPaymentEnvironment10 recursion level 1 with max 1
CardPaymentEnvironment10 *-- "0..1" Acquirer2 : Acquirer
CardPaymentEnvironment10 *-- "0..1" Organisation8 : Merchant
CardPaymentEnvironment10 *-- "1..1" PointOfInteraction2 : POI
CardPaymentEnvironment10 *-- "1..1" PaymentCard6 : Card
CardPaymentEnvironment10 *-- "0..1" Cardholder4 : Cardholder
%% CardPaymentContext2 recursion level 1 with max 1
CardPaymentContext2 *-- "1..1" PaymentContext2 : PaymentContext
CardPaymentContext2 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction13 recursion level 1 with max 1
class CardPaymentTransaction13{
TransactionCapture IsoTrueFalseIndicator
TransactionType CardPaymentServiceType4Code
AdditionalService CardPaymentServiceType2Code
ServiceAttribute CardPaymentServiceType3Code
MerchantCategoryCode IsoMin3Max4Text
TransactionSuccess IsoTrueFalseIndicator
Reversal IsoTrueFalseIndicator
MerchantOverride IsoTrueFalseIndicator
FailureReason FailureReason2Code
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction13 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction13 *-- "0..1" CardPaymentTransaction17 : OriginalTransaction
CardPaymentTransaction13 *-- "1..1" CardPaymentTransactionDetails3 : TransactionDetails
CardPaymentTransaction13 *-- "0..1" AuthorisationResult2 : AuthorisationResult
CardPaymentTransaction13 *-- "0..1" TransactionVerificationResult2 : TransactionVerificationResult
AcceptorCompletionAdvice2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment10 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext2 - Optional 0..1 |
| Transaction | Card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction13 - 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
%% ContentInformationType6 recursion level 0 with max 1
class ContentInformationType6{
ContentType ContentType1Code
}
ContentInformationType6 *-- "0..0" AuthenticatedData2 : AuthenticatedData
%% AuthenticatedData2 recursion level 1 with max 1
class AuthenticatedData2{
Version IsoNumber
MAC IsoMax35Binary
}
AuthenticatedData2 *-- "1..0" IRecipient2Choice : Recipient
AuthenticatedData2 *-- "1..1" AlgorithmIdentification3 : MACAlgorithm
AuthenticatedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
ContentInformationType6 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). | AuthenticatedData2 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCompletionAdviceV02 implementation follows a specific implementaiton pattern. First of all, AcceptorCompletionAdviceV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCompletionAdviceV02Document implements IOuterDocument. Because AcceptorCompletionAdviceV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCompletionAdviceV02.
classDiagram
class IOuterRecord
AcceptorCompletionAdviceV02 --|> IOuterRecord : Implements
AcceptorCompletionAdviceV02Document --|> IOuterDocument~AcceptorCompletionAdviceV02~ : Implements
class IOuterDocument~AcceptorCompletionAdviceV02~ {
AcceptorCompletionAdviceV02 Message
}
Document wrapper for serialization
The only real purpose AcceptorCompletionAdviceV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.003.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCompletionAdviceV02.ToDocument() method. The returned AcceptorCompletionAdviceV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCompletionAdviceV02Document *-- AcceptorCompletionAdviceV02 : 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.003.001.02">
<AccptrCmpltnAdvc>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CmpltnAdvc>
<!-- CompletionAdvice inner content -->
</CmpltnAdvc>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrCmpltnAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_zp8RwQvfEeK9Xewg3qiFQA"
nextVersions="_AZsHQTJLEeOkpIB9tKITlw"
previousVersion="_W92GBaMVEeCJ6YNENx4h-w_871403476"
name="AcceptorCompletionAdviceV02"
definition="The AcceptorCompletionAdvice message is sent by an acceptor (or its agent) to notify the acquirer (or its agent) of the outcome of the payment at the acceptor, and to transfer the financial data of the transaction to the acquirer (capture).
A AcceptorCompletionAdvice message is also sent to reverse an approved authorisation and any associated financial transfer (capture), if the card payment transaction could not be completed successfully."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCmpltnAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_zp8RwwvfEeK9Xewg3qiFQA"
nextVersions="_AZsHQzJLEeOkpIB9tKITlw"
name="Header"
definition="Completion advice message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_SwPX2gEcEeCQm6a_G2yO_w_-2124028495" />
<messageBuildingBlock
xmi:id="_zp8RxwvfEeK9Xewg3qiFQA"
nextVersions="_AZsHRTJLEeOkpIB9tKITlw"
name="CompletionAdvice"
definition="Information related to the completion advice."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CmpltnAdvc"
complexType="_17N8YQvVEeKzJ69IWwzB9Q" />
<messageBuildingBlock
xmi:id="_zp8RywvfEeK9Xewg3qiFQA"
nextVersions="_AZsHRzJLEeOkpIB9tKITlw"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_6DM4sQvFEeKzJ69IWwzB9Q" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="003"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.