caaa.003.001.04
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
%% AcceptorCompletionAdviceV04 recursion level 0 with max 0
AcceptorCompletionAdviceV04 *-- "1..1" Header11 : Header
AcceptorCompletionAdviceV04 *-- "1..1" AcceptorCompletionAdvice4 : CompletionAdvice
AcceptorCompletionAdviceV04 *-- "1..1" ContentInformationType11 : 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
%% Header11 recursion level 0 with max 1
class Header11{
MessageFunction MessageFunction4Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header11 *-- "1..1" GenericIdentification53 : InitiatingParty
Header11 *-- "0..1" GenericIdentification53 : RecipientParty
Header11 *-- "0..0" Traceability2 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% Traceability2 recursion level 1 with max 1
class Traceability2{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability2 *-- "1..1" GenericIdentification76 : RelayIdentification
Header11 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction4Code - 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. | GenericIdentification53 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification53 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability2 - 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
%% AcceptorCompletionAdvice4 recursion level 0 with max 1
AcceptorCompletionAdvice4 *-- "1..1" CardPaymentEnvironment34 : Environment
AcceptorCompletionAdvice4 *-- "0..1" CardPaymentContext9 : Context
AcceptorCompletionAdvice4 *-- "1..1" CardPaymentTransaction40 : Transaction
AcceptorCompletionAdvice4 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment34 recursion level 1 with max 1
CardPaymentEnvironment34 *-- "0..1" Acquirer4 : Acquirer
CardPaymentEnvironment34 *-- "0..1" Organisation8 : Merchant
CardPaymentEnvironment34 *-- "1..1" PointOfInteraction4 : POI
CardPaymentEnvironment34 *-- "0..1" PaymentCard11 : Card
CardPaymentEnvironment34 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment34 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment34 *-- "0..1" CardPaymentToken3 : PaymentToken
CardPaymentEnvironment34 *-- "0..1" Cardholder8 : Cardholder
CardPaymentEnvironment34 *-- "0..1" ContentInformationType10 : ProtectedCardholderData
%% CardPaymentContext9 recursion level 1 with max 1
CardPaymentContext9 *-- "1..1" PaymentContext9 : PaymentContext
CardPaymentContext9 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction40 recursion level 1 with max 1
class CardPaymentTransaction40{
TransactionCapture IsoTrueFalseIndicator
TransactionType CardPaymentServiceType5Code
AdditionalService CardPaymentServiceType6Code
ServiceAttribute CardPaymentServiceType3Code
MerchantCategoryCode IsoMin3Max4Text
SaleReferenceIdentification IsoMax35Text
TransactionSuccess IsoTrueFalseIndicator
Reversal IsoTrueFalseIndicator
MerchantOverride IsoTrueFalseIndicator
FailureReason FailureReason3Code
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax140Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction40 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction40 *-- "0..1" CardPaymentTransaction37 : OriginalTransaction
CardPaymentTransaction40 *-- "1..1" CardPaymentTransactionDetails21 : TransactionDetails
CardPaymentTransaction40 *-- "0..1" AuthorisationResult5 : AuthorisationResult
CardPaymentTransaction40 *-- "0..0" TransactionVerificationResult3 : TransactionVerificationResult
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
AcceptorCompletionAdvice4 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment34 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext9 - Optional 0..1 |
| Transaction | Card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction40 - 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
%% ContentInformationType11 recursion level 0 with max 1
class ContentInformationType11{
ContentType ContentType2Code
}
ContentInformationType11 *-- "0..0" 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
ContentInformationType11 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 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCompletionAdviceV04 implementation follows a specific implementaiton pattern. First of all, AcceptorCompletionAdviceV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCompletionAdviceV04Document implements IOuterDocument. Because AcceptorCompletionAdviceV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCompletionAdviceV04.
classDiagram
class IOuterRecord
AcceptorCompletionAdviceV04 --|> IOuterRecord : Implements
AcceptorCompletionAdviceV04Document --|> IOuterDocument~AcceptorCompletionAdviceV04~ : Implements
class IOuterDocument~AcceptorCompletionAdviceV04~ {
AcceptorCompletionAdviceV04 Message
}
Document wrapper for serialization
The only real purpose AcceptorCompletionAdviceV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.003.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCompletionAdviceV04.ToDocument() method. The returned AcceptorCompletionAdviceV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCompletionAdviceV04Document *-- AcceptorCompletionAdviceV04 : 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.04">
<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="_Z7h4MWlqEeSGkpGpjm7tzg"
nextVersions="_zX3uMY06EeWPUZwhUA4U-w"
previousVersion="_AZsHQTJLEeOkpIB9tKITlw"
name="AcceptorCompletionAdviceV04"
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="_Z7h4M2lqEeSGkpGpjm7tzg"
type="purpose" />
<messageBuildingBlock
xmi:id="_Z7h4NWlqEeSGkpGpjm7tzg"
nextVersions="_zX3uNY06EeWPUZwhUA4U-w"
previousVersion="_AZsHQzJLEeOkpIB9tKITlw"
name="Header"
definition="Completion advice message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_df0eUWlqEeSGkpGpjm7tzg" />
<messageBuildingBlock
xmi:id="_Z7h4N2lqEeSGkpGpjm7tzg"
nextVersions="_zX3uN406EeWPUZwhUA4U-w"
previousVersion="_AZsHRTJLEeOkpIB9tKITlw"
name="CompletionAdvice"
definition="Information related to the completion advice."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CmpltnAdvc"
complexType="_ze8BAWlqEeSGkpGpjm7tzg" />
<messageBuildingBlock
xmi:id="_Z7h4OWlqEeSGkpGpjm7tzg"
nextVersions="_zX3uOY06EeWPUZwhUA4U-w"
previousVersion="_AZsHRzJLEeOkpIB9tKITlw"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_cg4dYWkIEeS7zPBpvm732w" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="003"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.