caaa.003.001.06
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
%% AcceptorCompletionAdviceV06 recursion level 0 with max 0
AcceptorCompletionAdviceV06 *-- "1..1" Header24 : Header
AcceptorCompletionAdviceV06 *-- "1..1" AcceptorCompletionAdvice6 : CompletionAdvice
AcceptorCompletionAdviceV06 *-- "0..1" ContentInformationType15 : 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
%% Header24 recursion level 0 with max 1
class Header24{
MessageFunction MessageFunction10Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header24 *-- "1..1" GenericIdentification53 : InitiatingParty
Header24 *-- "0..1" GenericIdentification94 : RecipientParty
Header24 *-- "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
Header24 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 |
| 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. | 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 |
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
%% AcceptorCompletionAdvice6 recursion level 0 with max 1
AcceptorCompletionAdvice6 *-- "1..1" CardPaymentEnvironment60 : Environment
AcceptorCompletionAdvice6 *-- "0..1" CardPaymentContext21 : Context
AcceptorCompletionAdvice6 *-- "1..1" CardPaymentTransaction69 : Transaction
AcceptorCompletionAdvice6 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment60 recursion level 1 with max 1
CardPaymentEnvironment60 *-- "0..1" Acquirer4 : Acquirer
CardPaymentEnvironment60 *-- "0..1" Organisation25 : Merchant
CardPaymentEnvironment60 *-- "1..1" PointOfInteraction7 : POI
CardPaymentEnvironment60 *-- "0..1" PaymentCard26 : Card
CardPaymentEnvironment60 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment60 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment60 *-- "0..1" CardPaymentToken3 : PaymentToken
CardPaymentEnvironment60 *-- "0..1" Cardholder11 : Cardholder
CardPaymentEnvironment60 *-- "0..1" ContentInformationType10 : ProtectedCardholderData
%% CardPaymentContext21 recursion level 1 with max 1
CardPaymentContext21 *-- "1..1" PaymentContext21 : PaymentContext
CardPaymentContext21 *-- "0..1" SaleContext2 : SaleContext
%% CardPaymentTransaction69 recursion level 1 with max 1
class CardPaymentTransaction69{
TransactionCapture IsoTrueFalseIndicator
TransactionType CardPaymentServiceType5Code
AdditionalService CardPaymentServiceType9Code
ServiceAttribute CardPaymentServiceType3Code
MerchantCategoryCode IsoMin3Max4Text
CustomerConsent IsoTrueFalseIndicator
CardProgrammeProposed IsoMax35Text
CardProgrammeApplied IsoMax35Text
SaleReferenceIdentification IsoMax35Text
TransactionSuccess IsoTrueFalseIndicator
Reversal IsoTrueFalseIndicator
MerchantOverride IsoTrueFalseIndicator
FailureReason FailureReason3Code
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax140Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction69 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction69 *-- "0..1" CardPaymentTransaction52 : OriginalTransaction
CardPaymentTransaction69 *-- "1..1" CardPaymentTransactionDetails37 : TransactionDetails
CardPaymentTransaction69 *-- "0..1" AuthorisationResult11 : AuthorisationResult
CardPaymentTransaction69 *-- "0..0" TransactionVerificationResult4 : TransactionVerificationResult
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
AcceptorCompletionAdvice6 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment60 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext21 - Optional 0..1 |
| Transaction | Card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction69 - Required 1..1 |
| SupplementaryData | Additional information incorporated as an extension to the message. | SupplementaryData1 - Unknown 0..0 |
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 AcceptorCompletionAdviceV06 implementation follows a specific implementaiton pattern. First of all, AcceptorCompletionAdviceV06 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCompletionAdviceV06Document implements IOuterDocument. Because AcceptorCompletionAdviceV06 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCompletionAdviceV06.
classDiagram
class IOuterRecord
AcceptorCompletionAdviceV06 --|> IOuterRecord : Implements
AcceptorCompletionAdviceV06Document --|> IOuterDocument~AcceptorCompletionAdviceV06~ : Implements
class IOuterDocument~AcceptorCompletionAdviceV06~ {
AcceptorCompletionAdviceV06 Message
}
Document wrapper for serialization
The only real purpose AcceptorCompletionAdviceV06Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.003.001.06’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCompletionAdviceV06.ToDocument() method. The returned AcceptorCompletionAdviceV06Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCompletionAdviceV06Document *-- AcceptorCompletionAdviceV06 : 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.06">
<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="__uaZQaqAEeanIZ10Ka8PnA"
nextVersions="_Pps9kdnHEeeN3v2fup_Shw"
previousVersion="_zX3uMY06EeWPUZwhUA4U-w"
name="AcceptorCompletionAdviceV06"
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">
<doclet
xmi:id="__uaZQ6qAEeanIZ10Ka8PnA"
type="purpose" />
<messageBuildingBlock
xmi:id="__uaZRaqAEeanIZ10Ka8PnA"
nextVersions="_Pptko9nHEeeN3v2fup_Shw"
previousVersion="_zX3uNY06EeWPUZwhUA4U-w"
name="Header"
definition="Completion advice message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_UwmNcY07EeWPUZwhUA4U-w" />
<messageBuildingBlock
xmi:id="__ubAUaqAEeanIZ10Ka8PnA"
nextVersions="_PptkpdnHEeeN3v2fup_Shw"
previousVersion="_zX3uN406EeWPUZwhUA4U-w"
name="CompletionAdvice"
definition="Information related to the completion advice."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CmpltnAdvc"
complexType="_fa-uIaqAEeanIZ10Ka8PnA" />
<messageBuildingBlock
xmi:id="__ubAU6qAEeanIZ10Ka8PnA"
nextVersions="_Pptkp9nHEeeN3v2fup_Shw"
previousVersion="_zX3uOY06EeWPUZwhUA4U-w"
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="003"
flavour="001"
version="06" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.