Message Definition Report - Part 2...2020/04/23 · Message Definition Report - Part 2 For evaluation by the ISO 20022 Cards SEG This document provides details of the Message Definitions

Acquirer to Issuer Card Messages - Version 2

Message Definition Report - Part 2For evaluation by the ISO 20022 Cards SEG

This document provides details of the Message Definitions for Acquirer to Issuer Card Messages - Version 2.

23 April 2020

ISO 20022

Table of Contents

1 Message Set Overview ...................................................................................................................................... 81.1 List of MessageDefinitions ........................................................................................................................... 8

2 DRAFT5caad.001.001.01 BatchManagementInitiationV01 .............................................................. 132.1 MessageDefinition Functionality ................................................................................................................ 132.2 Structure ........................................................................................................................................................ 142.3 Constraints .................................................................................................................................................... 152.4 Message Building Blocks ............................................................................................................................ 15

3 DRAFT5caad.002.001.01 BatchManagementResponseV01 ............................................................ 343.1 MessageDefinition Functionality ................................................................................................................ 343.2 Structure ........................................................................................................................................................ 353.3 Constraints .................................................................................................................................................... 363.4 Message Building Blocks ............................................................................................................................ 36

4 DRAFT5caad.003.001.01 BatchTransferInitiationV01 ........................................................................ 564.1 MessageDefinition Functionality ................................................................................................................ 564.2 Structure ........................................................................................................................................................ 574.3 Constraints .................................................................................................................................................... 604.4 Message Building Blocks ............................................................................................................................ 60

5 DRAFT5caad.004.001.01 BatchTransferResponseV01 ..................................................................... 925.1 MessageDefinition Functionality ................................................................................................................ 925.2 Structure ........................................................................................................................................................ 935.3 Constraints .................................................................................................................................................... 965.4 Message Building Blocks ............................................................................................................................ 96

6 DRAFT5caad.005.001.02 ReconciliationInitiationV02 ..................................................................... 1286.1 MessageDefinition Functionality .............................................................................................................. 1286.2 Structure ...................................................................................................................................................... 1296.3 Constraints .................................................................................................................................................. 1306.4 Message Building Blocks .......................................................................................................................... 130

7 DRAFT5caad.006.001.02 ReconciliationResponseV02 ................................................................... 1487.1 MessageDefinition Functionality .............................................................................................................. 1487.2 Structure ...................................................................................................................................................... 1497.3 Constraints .................................................................................................................................................. 1507.4 Message Building Blocks .......................................................................................................................... 150

8 DRAFT5caad.007.001.02 ErrorV02 ........................................................................................................... 1688.1 MessageDefinition Functionality .............................................................................................................. 1688.2 Structure ...................................................................................................................................................... 1698.3 Constraints .................................................................................................................................................. 1708.4 Message Building Blocks .......................................................................................................................... 170

For evaluation by the ISO 20022 Cards SEG Table of Contents

Acquirer to Issuer Card Messages - Version 2 2 23 April 2020

9 DRAFT5cafc.001.001.01 FeeCollectionInitiationV01 ........................................................................ 1839.1 MessageDefinition Functionality .............................................................................................................. 1839.2 Structure ...................................................................................................................................................... 1849.3 Constraints .................................................................................................................................................. 1859.4 Message Building Blocks .......................................................................................................................... 185

10 DRAFT5cafc.002.001.01 FeeCollectionResponseV01 ..................................................................... 20410.1 MessageDefinition Functionality .............................................................................................................. 20410.2 Structure ...................................................................................................................................................... 20510.3 Constraints .................................................................................................................................................. 20610.4 Message Building Blocks .......................................................................................................................... 206

11 DRAFT5cafm.001.001.01 FileActionInitiationV01 .............................................................................. 22211.1 MessageDefinition Functionality .............................................................................................................. 22211.2 Structure ...................................................................................................................................................... 22311.3 Constraints .................................................................................................................................................. 22411.4 Message Building Blocks .......................................................................................................................... 224

12 DRAFT5cafm.002.001.01 FileActionResponseV01 ........................................................................... 24312.1 MessageDefinition Functionality .............................................................................................................. 24312.2 Structure ...................................................................................................................................................... 24412.3 Constraints .................................................................................................................................................. 24512.4 Message Building Blocks .......................................................................................................................... 245

13 DRAFT5cafr.001.001.01 FraudReportingInitiationV01 .................................................................... 26013.1 MessageDefinition Functionality .............................................................................................................. 26013.2 Structure ...................................................................................................................................................... 26113.3 Constraints .................................................................................................................................................. 26313.4 Message Building Blocks .......................................................................................................................... 263

14 DRAFT5cafr.002.001.01 FraudReportingResponseV01 .................................................................. 28614.1 MessageDefinition Functionality .............................................................................................................. 28614.2 Structure ...................................................................................................................................................... 28714.3 Constraints .................................................................................................................................................. 28814.4 Message Building Blocks .......................................................................................................................... 288

15 DRAFT5cafr.003.001.01 FraudDispositionInitiationV01 ................................................................. 29915.1 MessageDefinition Functionality .............................................................................................................. 29915.2 Structure ...................................................................................................................................................... 30015.3 Constraints .................................................................................................................................................. 30115.4 Message Building Blocks .......................................................................................................................... 301

16 DRAFT5cafr.004.001.01 FraudDispositionResponseV01 ............................................................... 31616.1 MessageDefinition Functionality .............................................................................................................. 31616.2 Structure ...................................................................................................................................................... 31716.3 Constraints .................................................................................................................................................. 31816.4 Message Building Blocks .......................................................................................................................... 318



17 DRAFT5cain.001.001.02 AuthorisationInitiationV02 ........................................................................ 32917.1 MessageDefinition Functionality .............................................................................................................. 32917.2 Structure ...................................................................................................................................................... 33017.3 Constraints .................................................................................................................................................. 33217.4 Message Building Blocks .......................................................................................................................... 332

18 DRAFT5cain.002.001.02 AuthorisationResponseV02 ..................................................................... 36418.1 MessageDefinition Functionality .............................................................................................................. 36418.2 Structure ...................................................................................................................................................... 36518.3 Constraints .................................................................................................................................................. 36718.4 Message Building Blocks .......................................................................................................................... 367

19 DRAFT5cain.003.001.02 FinancialInitiationV02 .................................................................................. 39119.1 MessageDefinition Functionality .............................................................................................................. 39119.2 Structure ...................................................................................................................................................... 39219.3 Constraints .................................................................................................................................................. 39419.4 Message Building Blocks .......................................................................................................................... 394

20 DRAFT5cain.004.001.02 FinancialResponseV02 ............................................................................... 42620.1 MessageDefinition Functionality .............................................................................................................. 42620.2 Structure ...................................................................................................................................................... 42720.3 Constraints .................................................................................................................................................. 42920.4 Message Building Blocks .......................................................................................................................... 429

21 DRAFT5cain.005.001.02 ReversalInitiationV02 .................................................................................. 45321.1 MessageDefinition Functionality .............................................................................................................. 45321.2 Structure ...................................................................................................................................................... 45421.3 Constraints .................................................................................................................................................. 45621.4 Message Building Blocks .......................................................................................................................... 456

22 DRAFT5cain.006.001.02 ReversalResponseV02 ................................................................................ 48222.1 MessageDefinition Functionality .............................................................................................................. 48222.2 Structure ...................................................................................................................................................... 48322.3 Constraints .................................................................................................................................................. 48422.4 Message Building Blocks .......................................................................................................................... 484

23 DRAFT5cain.014.001.01 RetrievalFulfilmentInitiationV01 ............................................................. 50423.1 MessageDefinition Functionality .............................................................................................................. 50423.2 Structure ...................................................................................................................................................... 50523.3 Constraints .................................................................................................................................................. 50623.4 Message Building Blocks .......................................................................................................................... 506

24 DRAFT5cain.015.001.01 RetrievalFulfilmentResponseV01 .......................................................... 53024.1 MessageDefinition Functionality .............................................................................................................. 53024.2 Structure ...................................................................................................................................................... 53124.3 Constraints .................................................................................................................................................. 53224.4 Message Building Blocks .......................................................................................................................... 532



25 DRAFT5cain.016.001.01 InquiryInitiationV01 ...................................................................................... 55425.1 MessageDefinition Functionality .............................................................................................................. 55425.2 Structure ...................................................................................................................................................... 55525.3 Constraints .................................................................................................................................................. 55625.4 Message Building Blocks .......................................................................................................................... 557

26 DRAFT5cain.017.001.01 InquiryResponseV01 ................................................................................... 58226.1 MessageDefinition Functionality .............................................................................................................. 58226.2 Structure ...................................................................................................................................................... 58326.3 Constraints .................................................................................................................................................. 58426.4 Message Building Blocks .......................................................................................................................... 584

27 DRAFT5cain.018.001.01 VerificationInitiationV01 ............................................................................. 60827.1 MessageDefinition Functionality .............................................................................................................. 60827.2 Structure ...................................................................................................................................................... 60927.3 Constraints .................................................................................................................................................. 61127.4 Message Building Blocks .......................................................................................................................... 611

28 DRAFT5cain.019.001.01 VerificationResponseV01 .......................................................................... 63828.1 MessageDefinition Functionality .............................................................................................................. 63828.2 Structure ...................................................................................................................................................... 63928.3 Constraints .................................................................................................................................................. 64028.4 Message Building Blocks .......................................................................................................................... 640

29 DRAFT5cain.020.001.01 AmendmentV01 .............................................................................................. 66229.1 MessageDefinition Functionality .............................................................................................................. 66229.2 Structure ...................................................................................................................................................... 66329.3 Constraints .................................................................................................................................................. 66429.4 Message Building Blocks .......................................................................................................................... 664

30 DRAFT5cain.021.001.01 RetrievalInitiationV01 .................................................................................. 67930.1 MessageDefinition Functionality .............................................................................................................. 67930.2 Structure ...................................................................................................................................................... 68030.3 Constraints .................................................................................................................................................. 68130.4 Message Building Blocks .......................................................................................................................... 682

31 DRAFT5cain.022.001.01 RetrievalResponseV01 ............................................................................... 70531.1 MessageDefinition Functionality .............................................................................................................. 70531.2 Structure ...................................................................................................................................................... 70631.3 Constraints .................................................................................................................................................. 70731.4 Message Building Blocks .......................................................................................................................... 707

32 DRAFT5cain.023.001.01 CardManagementInitiationV01 ................................................................ 72932.1 MessageDefinition Functionality .............................................................................................................. 72932.2 Structure ...................................................................................................................................................... 73032.3 Constraints .................................................................................................................................................. 73132.4 Message Building Blocks .......................................................................................................................... 732



33 DRAFT5cain.024.001.01 CardManagementResponseV01 ............................................................. 75733.1 MessageDefinition Functionality .............................................................................................................. 75733.2 Structure ...................................................................................................................................................... 75833.3 Constraints .................................................................................................................................................. 75933.4 Message Building Blocks .......................................................................................................................... 759

34 DRAFT5cain.025.001.01 AddendumInitiationV01 .............................................................................. 78034.1 MessageDefinition Functionality .............................................................................................................. 78034.2 Structure ...................................................................................................................................................... 78134.3 Constraints .................................................................................................................................................. 78234.4 Message Building Blocks .......................................................................................................................... 782

35 DRAFT5cain.026.001.01 AddendumResponseV01 ........................................................................... 79935.1 MessageDefinition Functionality .............................................................................................................. 79935.2 Structure ...................................................................................................................................................... 80035.3 Constraints .................................................................................................................................................. 80135.4 Message Building Blocks .......................................................................................................................... 801

36 DRAFT5cain.027.001.01 ChargeBackInitiationV01 ........................................................................... 81636.1 MessageDefinition Functionality .............................................................................................................. 81636.2 Structure ...................................................................................................................................................... 81736.3 Constraints .................................................................................................................................................. 81836.4 Message Building Blocks .......................................................................................................................... 819

37 DRAFT5cain.028.001.01 ChargeBackResponseV01 ........................................................................ 84337.1 MessageDefinition Functionality .............................................................................................................. 84337.2 Structure ...................................................................................................................................................... 84437.3 Constraints .................................................................................................................................................. 84537.4 Message Building Blocks .......................................................................................................................... 845

38 DRAFT5canm.001.001.02 NetworkManagementInitiationV02 ...................................................... 86338.1 MessageDefinition Functionality .............................................................................................................. 86338.2 Structure ...................................................................................................................................................... 86438.3 Constraints .................................................................................................................................................. 86538.4 Message Building Blocks .......................................................................................................................... 865

39 DRAFT5canm.002.001.02 NetworkManagementResponseV02 ................................................... 87639.1 MessageDefinition Functionality .............................................................................................................. 87639.2 Structure ...................................................................................................................................................... 87739.3 Constraints .................................................................................................................................................. 87839.4 Message Building Blocks .......................................................................................................................... 878

40 DRAFT5canm.003.001.02 KeyExchangeInitiationV02 ..................................................................... 88940.1 MessageDefinition Functionality .............................................................................................................. 88940.2 Structure ...................................................................................................................................................... 89040.3 Constraints .................................................................................................................................................. 89140.4 Message Building Blocks .......................................................................................................................... 891



41 DRAFT5canm.004.001.02 KeyExchangeResponseV02 .................................................................. 90841.1 MessageDefinition Functionality .............................................................................................................. 90841.2 Structure ...................................................................................................................................................... 90941.3 Constraints .................................................................................................................................................. 91041.4 Message Building Blocks .......................................................................................................................... 910

42 DRAFT5casr.001.001.01 SettlementReportingInitiationV01 ......................................................... 92742.1 MessageDefinition Functionality .............................................................................................................. 92742.2 Structure ...................................................................................................................................................... 92842.3 Constraints .................................................................................................................................................. 93042.4 Message Building Blocks .......................................................................................................................... 930

43 DRAFT5casr.002.001.01 SettlementReportingResponseV01 ...................................................... 95443.1 MessageDefinition Functionality .............................................................................................................. 95443.2 Structure ...................................................................................................................................................... 95543.3 Constraints .................................................................................................................................................. 95643.4 Message Building Blocks .......................................................................................................................... 956

44 Message Items Types .................................................................................................................................... 97244.1 MessageComponents ............................................................................................................................... 97244.2 Message Datatypes ................................................................................................................................. 1552



1 Message Set OverviewIntroduction

Messages defined in an Acquirer to Issuer relationship.

1.1 List of MessageDefinitionsThe following table lists all MessageDefinitions described in this book.

MessageDefinition Definition

DRAFT5caad.001.001.01BatchManagementInitiationV01

The BatchManagementInitiation message can beinitiated by any party and received by any party(acquirer, agent or issuer) connected to a network.

This message provides flow control informationenabling a series of messages in batches and batchesin collections to start, end or require checkpoints duringthe flow.

DRAFT5caad.002.001.01BatchManagementResponseV01

The BatchManagementResponse message is sent byany party to any party (acquirer, agent or issuer) inresponse to a BatchManagementInitiation message.

DRAFT5caad.003.001.01BatchTransferInitiationV01

The BatchTransferInitiation message can be initiatedby any party and received by any party (acquirer, agentor issuer). This message is used to transfer a series oftransactions or administrative information in a singleexchange.

DRAFT5caad.004.001.01BatchTransferResponseV01

The BatchTransferResponse message is sent by anyparty to any party (acquirer, agent or issuer) inresponse to a BatchTransferInitiation message.

DRAFT5caad.005.001.02ReconciliationInitiationV02

The ReconciliationInitiation message can be initiatedby any party and received by any party (acquirer, agentor issuer).

Reconciliation is the exchange between twointerchanging parties (Acquirer, Issuer or Agent) oftotals and/or counts of messages within a specificsession.

DRAFT5caad.006.001.02ReconciliationResponseV02

The ReconciliationResponse message is sent by anyparty to any party (acquirer, agent or issuer) inresponse to a ReconciliationInitiation message.

DRAFT5caad.007.001.02ErrorV02

The Error message is sent by any party to any party(acquirer, agent or issuer) to indicate a message error.

DRAFT5cafc.001.001.01FeeCollectionInitiationV01

The FeeCollectionInitiation message can be initiatedby any party and received by any party (acquirer, agentor issuer) to claim or pay a miscellaneous servicebetween financial institutions. Fee collection messageshave financial impacts and affect reconciliation totalswithout affecting a cardholder account.

DRAFT5cafc.002.001.01FeeCollectionResponseV01

The FeeCollectionResponse message is sent by anyparty to any party (acquirer, agent or issuer) inresponse to a FeeCollectionInitiation message.

For evaluation by the ISO 20022 Cards SEG Message Set Overview



DRAFT5cafm.001.001.01FileActionInitiationV01

The FileActionInitiation message can be initiated byany party and received by any party (acquirer, agent orissuer).

This message is used to inquire, add, change, deleteor replace a file or a record.

DRAFT5cafm.002.001.01FileActionResponseV01

A FileActionResponse message is sent by any party toany party (acquirer, agent or issuer) in response to aFileActionInitiation message.

DRAFT5cafr.001.001.01FraudReportingInitiationV01

A FraudReportingInitiation message is usually sent bya financial institution acting as an acquirer or as anissuer to an agent (processor, agent) to inform about aconfirmed fraudulent transaction.

DRAFT5cafr.002.001.01FraudReportingResponseV01

A FraudReportingResponse message is sent by anagent (processor, agent) to an issuer or acquirer inresponse to a FraudReportingInitiation message.

DRAFT5cafr.003.001.01FraudDispositionInitiationV01

A FraudDispositionInitiation message is usually sent byan agent to a financial institution acting as an acquireror as an issuer to report about the disposition of aconfirmed fraudulent transaction.

DRAFT5cafr.004.001.01FraudDispositionResponseV01

A FraudDispositionResponse message is sent by anissuer or acquirer to an agent (processor, agent) inresponse to a FraudDispositionInitiation message.

DRAFT5cain.001.001.02AuthorisationInitiationV02

AuthorisationInitiation message is sent by an acquireror an agent to an issuer to request approval of a cardtransaction by the issuer or to inform the issuer aboutthe completion of the authorisation. It can also be sentby an issuer to an acquirer or agent to advise about theresult of an authorisation already performed.

DRAFT5cain.002.001.02AuthorisationResponseV02

The AuthorisationResponse message is sent by anissuer or an agent to an acquirer in response to anAuthorisationInitiation message.

DRAFT5cain.003.001.02FinancialInitiationV02

The FinancialInitiation message is sent by an acquireror an agent to an issuer to request approval of a cardtransaction or to inform about the completion of anauthorisation. It allows the approved transactionamount to be billed or posted on the cardholder'saccount. It can also be sent by an issuer to an acquireror agent to advise that an authorisation has beensuccessfully completed for the final amount andrequests the clearing of the transaction.

DRAFT5cain.004.001.02FinancialResponseV02

The FinancialResponse message is sent by an issueror an agent to an acquirer in response to aFinancialInitiation message.

DRAFT5cain.005.001.02ReversalInitiationV02

The ReversalInitiation message is sent by an acquirer,an originator or an agent to an issuer to request oradvise of the reversal of an authorisation by the issuer.A reversal is a partial or complete nullification of theeffects of a previous authorisation, financialpresentment or financial accumulation presentmentthat cannot be processed as instructed (for example, isundeliverable and cancelled or the acquirer timed outwaiting for a response).




DRAFT5cain.006.001.02ReversalResponseV02

The ReversalResponse message is sent by an issueror an agent to an acquirer in response to aReversalInitiation message.

DRAFT5cain.014.001.01RetrievalFulfilmentInitiationV01

The RetrievaFulfilmentInitiation message is sent by anacquirer or agent to an issuer to support an issuer'sretrieval request.

The RetrievaFulfilmentInitiation message is the activityinitiated by the acceptor, the acquirer or the relevantagent to support the issuer who has determined that atransaction information document needs to beexamined before a potential chargeback is sent or tosatisfy another need of the issuer or the cardholder.Only an issuer or its agent can initiate a retrievalrequest.

DRAFT5cain.015.001.01RetrievalFulfilmentResponseV01

The RetrievalFulfilmentResponse message is sent byan issuer or acquirer to an agent (processor, agent) inresponse to a RetrievalFulfilmentInitiation message.

DRAFT5cain.016.001.01InquiryInitiationV01

The InquiryInitiation message is sent by an acquirer oragent to an issuer to request information related to thecard (e.g. about a cardholder, the availability of funds,etc.).

DRAFT5cain.017.001.01InquiryResponseV01

The InquiryResponse message is sent by an issuer oran agent to an acquirer in response to anInquiryInitiation message.

DRAFT5cain.018.001.01VerificationInitiationV01

The VerificationInitiation message can be initiated byany party and received by any party (acquirer, agent orissuer). It conveys information to a receiver requiringverification or authentication.

Examples of usages are: authentication of certificates,assurance levels of tokens, certificate management,address verification, account verification and chequeverification. It is also used to inform the receiver of averification that has been completed on its behalf.

DRAFT5cain.019.001.01VerificationResponseV01

The VerificationResponse message is sent by anyparty to any party (acquirer, agent or issuer) inresponse to a VerificationInitiation message.

DRAFT5cain.020.001.01AmendmentV01

The Amendment message can be initiated by any partyand received by any party (acquirer, agent or issuer).

This message is used to inform the originator that theoriginal message has been corrected/amended andthen forwarded to the destination on behalf of theoriginator. It contains a copy of the original messageand any errors found. It may also contain anycorrections and/or amendments that were made to theoriginal message.

DRAFT5cain.021.001.01RetrievalInitiationV01

The RetrievalInitiation message is sent by an issuer oragent to an acquirer to retrieve the original transactiondetails.




DRAFT5cain.022.001.01RetrievalResponseV01

The RetrievalResponse message is sent by anacquirer to an issuer or agent in response to anRetrievalnitiation message.

DRAFT5cain.023.001.01CardManagementInitiationV01

The CardManagementInitiation message is sent by theacquirer to an issuer or agent to fulfil a request initiatedby the cardholder at the point of service for anoperation on the card account.

DRAFT5cain.024.001.01CardManagementResponseV01

The CardManagementResponse message is sent byan issuer or an agent to an acquirer in response to aCardManagementInitiation message.

DRAFT5cain.025.001.01AddendumInitiationV01

The AddendumInitiation message is sent by anacquirer or an agent to an issuer to providesupplemental data in addition to that which is requiredto complete an authorization initiation or financialinitiation.

The supplemental data is associated with anauthorization or financial message.

DRAFT5cain.026.001.01AddendumResponseV01

The AddendumResponse message is sent by anissuer or an agent to an acquirer in response to anAddendumInitiation message.

DRAFT5cain.027.001.01ChargeBackInitiationV01

The ChargeBackInitiation message is sent by an issueror agent to an acquirer to fully or partially nullify aprevious financial transaction; namely when the issuerdetermines that a customer dispute exists or that anerror or violation of rules has been committed. It is alsoused to nullify a previous chargeback. Chargebackshave a financial impact and should be computed withinreconciliation totals.

DRAFT5cain.028.001.01ChargeBackResponseV01

The ChargeBackResponse message is sent by anacquirer or an agent to an issuer in response to anChargeBackInitiation message.

DRAFT5canm.001.001.02NetworkManagementInitiationV02

The NetworkManagementlInitiation message can beinitiated by any party and received by any party(acquirer, agent or issuer) connected to a network. Itcovers the range of activities that control the operatingconditions of the network.

DRAFT5canm.002.001.02NetworkManagementResponseV02

The NetworkManagementResponse message is sentby any party to any party (acquirer, agent or issuer) inresponse to a NetworkManagementlInitiation message.

DRAFT5canm.003.001.02KeyExchangeInitiationV02

The KeyExchangeInitiation message can be initiatedby any party and received by any party (acquirer, agentor issuer). This message is used to initiate acryptographic key activity (request of a key change,request of the verification of a key, etc.).

DRAFT5canm.004.001.02KeyExchangeResponseV02

The KeyExchangeResponse message is sent by anyparty to any party (acquirer, agent or issuer) inresponse to a KeyExchangeInitiation message.

DRAFT5casr.001.001.01SettlementReportingInitiationV01

The SettlementReportingInitiation message is usuallysent by an agent (processor, clearing or settlementagent) to an acquirer, agent or issuer to inform aboutfinancial totals already settled or to be settled issuedas an outcome of the clearing process.




DRAFT5casr.002.001.01SettlementReportingResponseV01

The SettlementReportingResponse message is sent byany party (acquirer, agent or issuer) to an agent inresponse to a SettlementReportingInitiation message.



2 DRAFT5caad.001.001.01BatchManagementInitiationV01

2.1 MessageDefinition FunctionalityThe BatchManagementInitiation message can be initiated by any party and received by any party(acquirer, agent or issuer) connected to a network.

This message provides flow control information enabling a series of messages in batches and batchesin collections to start, end or require checkpoints during the flow.

Outline

The BatchManagementInitiationV01 MessageDefinition is composed of 3 MessageBuildingBlocks:

A. Header

Information related to the management of the protocol.

B. Body

Information related to the batch management.

C. SecurityTrailer

Trailer of the message containing a MAC

For evaluation by the ISO 20022 Cards SEG DRAFT5caad.001.001.01BatchManagementInitiationV01


2.2 StructureOr MessageElement/BuildingBlock Mult. Type Constr.

No.Page

Message root [1..1]

Header [1..1] 15

MessageFunction [1..1] CodeSet 16

ProtocolVersion [1..1] Text 16

ExchangeIdentification [0..1] Text 16

ReTransmissionCounter [0..1] Text 17

CreationDateTime [1..1] DateTime 17

InitiatingParty [1..1] ± 17

RecipientParty [0..1] ± 17

TraceData [0..*] 18

Type [0..1] Text 18

Value [0..1] Text 18

Traceability [0..*] ± 18

Body [1..1] 18

Environment [1..1] 20

Originator [0..1] ± 20

Sender [0..1] ± 20

Receiver [0..1] ± 21

Destination [0..1] ± 21

Context [0..1] 21

TransactionContext [0..1] 22

CardProgrammeApplied [0..1] ± 22

Transaction [1..1] 22

BatchManagementType [1..1] CodeSet 23

OtherBatchManagementType [0..1] Text 24

TransactionIdentification [0..1] ± 24

AdditionalFees [0..*] ± 25

CollectionIdentification [0..1] Text 25

BatchIdentification [0..1] Text 26

CollectionSize [0..1] Quantity 26



Or MessageElement/BuildingBlock Mult. Type Constr.No.

Page

OriginalCollectionIdentification [0..1] Text 26

OriginalBatchIdentification [0..1] Text 26

NumberOfBatchesInCollection [0..1] Quantity 26

NumberOfMessages [0..1] Quantity 27

RemainingMessagesInCollection [0..1] Quantity 27

MessageSequenceNumber [0..1] Text 27

BatchIdentificationList [0..*] Text 28

CheckpointIdentification [0..1] Text 28

BatchChecksum [0..1] Binary 28

RequestAcknowledgement [0..1] Indicator 28

MessagesBeforeAcknowledgement [0..1] Quantity 28

PositiveAcknowledgement [0..1] Indicator 29

AdditionalData [0..*] 29

Type [0..1] Text 29


ProtectedData [0..*] ± 29

SupplementaryData [0..*] ± C1 32

SecurityTrailer [0..1] ± 32

2.3 ConstraintsC1 SupplementaryDataRule

This component may not be used without the explicit approval of a SEG and submission to theRA of ISO 20022 compliant structure(s) to be used in the Envelope element.

C2 ValidationByTable

Must be a valid currency code which is registered with the ISO 4217 Maintenance Agency, andconsist of three contiguous numbers

2.4 Message Building BlocksThis chapter describes the MessageBuildingBlocks of this MessageDefinition.

2.4.1 Header Presence: [1..1]

Definition: Information related to the management of the protocol.



Header contains the following Header38 elements

Or MessageElement Mult. Type Constr.No.

Page








TraceData [0..*] 18

Type [0..1] Text 18



2.4.1.1 MessageFunction Presence: [1..1]

Definition: Identifies the type of process related to the message.

Datatype: "MessageFunction18Code" on page 1600

CodeName Name Definition

BTRQ BatchRequest Request to initiate the transfer of a batch(response expected).

BTNF BatchNotification Notification to initiate the transfer of abatch (no response expected).

CLNF CollectionNotification Notification to initiate the transfer of acollection (no response expected).

CLRQ CollectionRequest Request to initiate the transfer of acollection (response expected).

2.4.1.2 ProtocolVersion Presence: [1..1]

Definition: Version of the acquirer to issuer protocol specifications.

Datatype: "Max2048Text" on page 1638

2.4.1.3 ExchangeIdentification Presence: [0..1]

Definition: Unique identification of an exchange of messages between two parties.




2.4.1.4 ReTransmissionCounter Presence: [0..1]

Definition: Number of retransmission of the message. Incremented by one for each retransmission.

Datatype: "Max3NumericText" on page 1640

2.4.1.5 CreationDateTime Presence: [1..1]

Definition: Date and time at which the message was sent.

Datatype: "ISODateTime" on page 1631

2.4.1.6 InitiatingParty Presence: [1..1]

Definition: Unique identification of the partner that has initiated the exchange.

InitiatingParty contains the following elements (see "GenericIdentification172" onpage 1329 for details)


Page

Identification [1..1] Text 1329

Type [0..1] CodeSet 1329

OtherType [0..1] Text 1330

Assigner [0..1] CodeSet 1330

Country [0..1] Text 1330

ShortName [0..1] Text 1330

2.4.1.7 RecipientParty Presence: [0..1]

Definition: Unique identification of the partner that is the recipient of the message exchange.

RecipientParty contains the following elements (see "GenericIdentification172" onpage 1329 for details)


Page









2.4.1.8 TraceData Presence: [0..*]

Definition: Information sent in the request message to be returned in the response one, for instance tohelp in the retrieval of the context of the exchange.

ISO 8583:93/2003 bit 59

TraceData contains the following AdditionalData1 elements


Page

Type [0..1] Text 18


2.4.1.8.1 Type Presence: [0..1]

Definition: Type of information.


2.4.1.8.2 Value Presence: [0..1]

Definition: Value of a specific type of data.


2.4.1.9 Traceability Presence: [0..*]

Definition: Identification of partners involved in exchange from the merchant to the issuer, with therelative timestamp of their exchanges.

Traceability contains the following elements (see "Traceability7" on page 1286 for details)


Page

RelayIdentification [1..1] ± 1286

TraceDateTimeIn [0..1] DateTime 1287

TraceDateTimeOut [0..1] DateTime 1287

2.4.2 Body Presence: [1..1]

Definition: Information related to the batch management.



Body contains the following BatchManagementInitiation1 elements


Page



Sender [0..1] ± 20



Context [0..1] 21















RemainingMessagesInCollection

[0..1] Quantity 27









Type [0..1] Text 29




Page




2.4.2.1 Environment Presence: [1..1]

Definition: Environment of the transaction.

Environment contains the following Environment3 elements


Page


Sender [0..1] ± 20



2.4.2.1.1 Originator Presence: [0..1]

Definition: Initiator of the process.

Originator contains the following elements (see "PartyIdentification197" on page 1328 fordetails)


Page


Assigner [0..1] Text 1328

Country [0..1] CodeSet 1329


AdditionalIdentification [0..1] Text 1329

2.4.2.1.2 Sender Presence: [0..1]

Definition: Party sending the message to another intermediary agent or to the destination.



Sender contains the following elements (see "PartyIdentification197" on page 1328 for details)


Page






2.4.2.1.3 Receiver Presence: [0..1]

Definition: Party receiving the message from the originator or another intermediary agent.

Receiver contains the following elements (see "PartyIdentification197" on page 1328 for details)


Page






2.4.2.1.4 Destination Presence: [0..1]

Definition: Destination of the message.

Destination contains the following elements (see "PartyIdentification197" on page 1328 fordetails)


Page






2.4.2.2 Context Presence: [0..1]

Definition: Contains or describes conditions and characteristics of the transaction.



Context contains the following Context8 elements


Page



2.4.2.2.1 TransactionContext Presence: [0..1]

Definition: Context of the card payment transaction.

TransactionContext contains the following TransactionContext5 elements


Page


2.4.2.2.1.1 CardProgrammeApplied

Presence: [0..1]

Definition: Card programme or brand related to the transaction.

ISO 8583:87 bit 24

CardProgrammeApplied contains the following elements (see"CardProgrammeMode1" on page 1014 for details)


Page

Type [0..1] Text 1014


2.4.2.3 Transaction Presence: [1..1]

Definition: Batch management transaction.



Transaction contains the following Transaction95 elements


Page





















Type [0..1] Text 29


2.4.2.3.1 BatchManagementType Presence: [1..1]

Definition: Type of batch management activity.

ISO 8583:87/93 bit 24

ISO 8583:2003 bit 68-1

Datatype: "BatchManagementType1Code" on page 1575




AKRQ AcknowledgementRequest Acknowledgement requested by theoriginator to the destination (used with anotification message exclusively).

AKRP AcknowledgementResponse Acknowledgement response by thedestination to the originator (used with anotification message exclusively).

ENDB End End of a collection or batch by theoriginator (used with a request messageexclusively).

OTHN OtherNational Any other type of batch managementtransaction defined at national level.

OTHP OtherPrivate Any other type of batch managementtransaction defined at private level.

STRT Start Initiation of a collection or batch by theoriginator (used with a request messageexclusively).

2.4.2.3.2 OtherBatchManagementType Presence: [0..1]

Definition: Other type of batch management activity.


2.4.2.3.3 TransactionIdentification Presence: [0..1]

Definition: Identification of the batch management transaction.



TransactionIdentification contains the following elements (see "TransactionIdentification10"on page 1408 for details)


Page

LocalDateTime [1..1] DateTime 1409

TimeZone [0..1] Text 1409

TransactionReference [0..1] Text 1409

TransmissionDateTime [0..1] DateTime 1409

SystemTraceAuditNumber [1..1] Text 1410

RetrievalReferenceNumber [1..1] Text 1410

LifeCycleSupportIndicator [0..1] Text 1410

LifeCycleTraceIdentificationData [0..1] ± 1410

LifeCycleTraceIdentificationMissing

[0..1] Text 1410

AcquirerReferenceData [0..1] Text 1411

AcquirerReferenceNumber [0..1] Text 1411

CardIssuerReferenceData [0..1] Text 1411

2.4.2.3.4 AdditionalFees Presence: [0..*]

Definition: Fees not included in the transaction amount but included in the settlement.

AdditionalFees contains the following elements (see "AdditionalFee1" on page 995 fordetails)


Page



FeeProgram [0..1] Text 996

FeeDescriptor [0..1] Text 996

Amount [1..1] ± 996

Label [0..1] Text 997

2.4.2.3.5 CollectionIdentification Presence: [0..1]

Definition: Identification of a collection.

Mandatory for start or end of a collection and their acknowledgements if the batch is included in acollection.



All the messages included within the collection will have the same collection identification value.


2.4.2.3.6 BatchIdentification Presence: [0..1]

Definition: Identification of a batch.

All the messages included within the batch will have the same batch identification value.


2.4.2.3.7 CollectionSize Presence: [0..1]

Definition: Total length in bytes of the collection to be transferred.

ISO 8583:2003 bit 70-2

Datatype: "Number" on page 1633

2.4.2.3.8 OriginalCollectionIdentification Presence: [0..1]

Definition: Identification of the original collection.

Mandatory when the collection containing the batch response has not the same identification as thecollection containing the original batch.


2.4.2.3.9 OriginalBatchIdentification Presence: [0..1]

Definition: Identification of the original batch to answer.

Mandatory when the batch response has not the same identification as the batch initiation.


2.4.2.3.10 NumberOfBatchesInCollection Presence: [0..1]

Definition: Number of batches in the collection.

For a start of collection, this is the number of expected batches if known.

For a start of collection acknowledgement, this is the maximum number of batches that can be receivedin the collection.

For an end of collection, this is the number of batches sent in the closing collection.

For an end of collection acknowledgement, this is the number of batches received in the collection.




2.4.2.3.11 NumberOfMessages Presence: [0..1]

Definition: Number of messages.

ISO 8583:87 bit 72

ISO 8583:2003 bit 70-1 or bit 69-1

For a start of collection, this is the number of expected messages in the collection if known.

For a start of batch, this is the number of expected messages in the batch if known.

For an AcknowledgementRequest , this is the number of sent messages since last check point.

For an AcknowledgementResponse, this is the number of received messages since last check point.

For an end of batch this is the number of received messages in the batch.

For an end of collection, this is the number of received messages in the collection.

Note: Batch management messages are excluded from the count.


2.4.2.3.12 RemainingMessagesInCollection Presence: [0..1]

Definition: Number of remaining messages in the collection.

ISO 8583:2003 bit 70-3


2.4.2.3.13 MessageSequenceNumber Presence: [0..1]

Definition: For a start of collection, sequence number of first expected message of the collection.

For a start of batch, sequence number of first expected message of the batch.

For an AcknowledgementRequest , sequence number of the last message sent for this checkpoint.



For an AcknowledgementResponse, sequence number of the last message received for thischeckpoint.

For an end of batch, sequence number of last message of the batch.

For an end of collection, sequence number of last message of the collection.


2.4.2.3.14 BatchIdentificationList Presence: [0..*]

Definition: List of batch identifications of the collection.

For a start of collection, the identification of expected batches, if known.

For an end of collection, this is the identification of batches sent in the closing collection.

For an end of collection acknowledgement, this is the identification of batches received in the collection.


2.4.2.3.15 CheckpointIdentification Presence: [0..1]

Definition: Identification of a specific checkpoint.


2.4.2.3.16 BatchChecksum Presence: [0..1]

Definition: Checksum of the series of messages in the batch or until a checkpoint.

Datatype: "Max35Binary" on page 1553

2.4.2.3.17 RequestAcknowledgement Presence: [0..1]

Definition: Indicator to request acknowledgement.

True: Acknowledgement requested

False: Acknowledgement not requested.

Datatype: One of the following values must be used (see "TrueFalseIndicator" on page 1631):

• Meaning When True: True

• Meaning When False: False

2.4.2.3.18 MessagesBeforeAcknowledgement Presence: [0..1]

Definition: Maximum number of messages to be sent before acknowledgement. The receiver will sendan acknowledgement response every time the indicated number of messages is reached.




2.4.2.3.19 PositiveAcknowledgement Presence: [0..1]

Definition: Indicate whether the acknowledgement is positive or not.

True: Positive acknowledgement.

False: Negative acknowledgement.

Datatype: One of the following values must be used (see "TrueFalseIndicator" on page 1631):

• Meaning When True: True

• Meaning When False: False

2.4.2.3.20 AdditionalData Presence: [0..*]

Definition: Contains additional data.

AdditionalData contains the following AdditionalData1 elements


Page

Type [0..1] Text 29


2.4.2.3.20.1 Type

Presence: [0..1]



2.4.2.3.20.2 Value

Presence: [0..1]



2.4.2.4 ProtectedData Presence: [0..*]

Definition: Contains protected data and the attributes used to protect the data.



ProtectedData contains the following elements (see "ProtectedData1" on page 1468 fordetails)


Page

ContentType [1..1] CodeSet 1471

EnvelopedData [0..1] 1471

Version [0..1] Quantity 1473

Recipient [1..*] 1473

{Or KeyTransport [1..1] 1475


RecipientIdentification [1..1] 1476

{Or IssuerAndSerialNumber [1..1] 1476

Issuer [1..1] 1476

RelativeDistinguishedName [1..*] 1477

AttributeType [1..1] CodeSet 1477

AttributeValue [1..1] Text 1477

SerialNumber [1..1] Binary 1477

Or} KeyIdentifier [1..1] ± 1477

KeyEncryptionAlgorithm [1..1] 1478

Algorithm [1..1] CodeSet 1478

Parameter [0..1] 1478

DigestAlgorithm [0..1] CodeSet 1479

MaskGeneratorAlgorithm [0..1] 1479


Parameter [0..1] CodeSet 1480

EncryptedKey [1..1] Binary 1480

Or KEK [1..1] 1480


KEKIdentification [1..1] 1481

KeyIdentification [1..1] Text 1481

KeyVersion [0..1] Text 1481

SequenceNumber [0..1] Quantity 1481

DerivationIdentification [0..1] Binary 1481

KeyEncryptionAlgorithm [1..1] 1481




Page



EncryptionFormat [0..1] CodeSet 1483

InitialisationVector [0..1] Binary 1483

BytePadding [0..1] CodeSet 1483

EncryptedKey [0..1] Binary 1484

Or} KeyIdentifier [1..1] 1484

KeyIdentification [1..1] Text 1484

KeyVersion [0..1] Text 1484

SequenceNumber [0..1] Quantity 1485

DerivationIdentification [0..1] Binary 1485

EncryptedContent [0..1] 1485

ContentType [1..1] CodeSet 1485

ContentEncryptionAlgorithm [1..1] 1486



InitialisationVector [0..1] Binary 1488

BytePadding [0..1] CodeSet 1488

EncryptedDataElement [1..*] 1488

Identification [0..1] CodeSet 1489

OtherIdentification [0..1] Text 1489

EncryptedData [1..1] 1489

{Or BinaryData [1..1] Binary 1489

Or} HexadecimalBinaryValue [1..1] Text 1489

ClearTextDataFormat [0..1] CodeSet 1490

OtherClearTextDataFormat [0..1] Text 1490


Control [0..1] Text 1491

KeySetIdentifier [0..1] Text 1491

DerivedInformation [0..1] Text 1491

Algorithm [0..1] Text 1492




Page

KeyLength [0..1] Text 1492

KeyProtection [0..1] Text 1492

KeyIndex [0..1] Text 1492

PaddingMethod [0..1] Text 1492

EncryptedDataFormat [0..1] Text 1492

EncryptedDataElement [1..*] 1493

Identification [0..1] CodeSet 1493

OtherIdentification [0..1] Text 1493


{Or BinaryData [1..1] Binary 1493

Or} HexadecimalBinaryValue [1..1] Text 1494

ClearTextDataFormat [0..1] CodeSet 1494

OtherClearTextDataFormat [0..1] Text 1494

2.4.2.5 SupplementaryData Presence: [0..*]

Definition: Additional information that can not be captured in the structured fields and/or other specificblock.

Impacted by: C1 "SupplementaryDataRule"

SupplementaryData contains the following elements (see "SupplementaryData1" onpage 1285 for details)


Page

PlaceAndName [0..1] Text 1286

Envelope [1..1] (External Schema) 1286

Constraints

• SupplementaryDataRule

This component may not be used without the explicit approval of a SEG and submission to the RA ofISO 20022 compliant structure(s) to be used in the Envelope element.

2.4.3 SecurityTrailer Presence: [0..1]

Definition: Trailer of the message containing a MAC



SecurityTrailer contains the following elements (see "ContentInformationType20" onpage 1465 for details)


Page

MACData [1..1] 1465

Control [1..1] Text 1466

KeySetIdentifier [1..1] Text 1466

DerivedInformation [0..1] Text 1466

Algorithm [1..1] Text 1467

KeyLength [0..1] Text 1467

KeyProtection [0..1] Text 1467

KeyIndex [0..1] Text 1467

PaddingMethod [0..1] Text 1467

InitialisationVector [0..1] Text 1467

MAC [1..1] Text 1468



3 DRAFT5caad.002.001.01BatchManagementResponseV01

3.1 MessageDefinition FunctionalityThe BatchManagementResponse message is sent by any party to any party (acquirer, agent or issuer)in response to a BatchManagementInitiation message.

Outline

The BatchManagementResponseV01 MessageDefinition is composed of 3 MessageBuildingBlocks:

A. Header

Information related to the management of the protocol.

B. Body

Information related to the batch management.

C. SecurityTrailer

Trailer of the message containing a MAC

For evaluation by the ISO 20022 Cards SEG DRAFT5caad.002.001.01BatchManagementResponseV01


3.2 StructureOr MessageElement/BuildingBlock Mult. Type Constr.

No.Page

Message root [1..1]

Header [1..1] 36








TraceData [0..*] 39

Type [0..1] Text 39



Body [1..1] 39



Sender [0..1] ± 41



Context [0..1] 42













Or MessageElement/BuildingBlock Mult. Type Constr.No.

Page














Type [0..1] Text 50


ProcessingResult [1..1] ± 50



SecurityTrailer [0..1] ± 54

3.3 ConstraintsC1 SupplementaryDataRule

This component may not be used without the explicit approval of a SEG and submission to theRA of ISO 20022 compliant structure(s) to be used in the Envelope element.

C2 ValidationByTable

Must be a valid currency code which is registered with the ISO 4217 Maintenance Agency, andconsist of three contiguous numbers

3.4 Message Building BlocksThis chapter describes the MessageBuildingBlocks of this MessageDefinition.

3.4.1 Header Presence: [1..1]



Definition: Information related to the management of the protocol.

Header contains the following Header38 elements


Page








TraceData [0..*] 39

Type [0..1] Text 39



3.4.1.1 MessageFunction Presence: [1..1]

Definition: Identifies the type of process related to the message.

Datatype: "MessageFunction18Code" on page 1600


BTRQ BatchRequest Request to initiate the transfer of a batch(response expected).

BTNF BatchNotification Notification to initiate the transfer of abatch (no response expected).

CLNF CollectionNotification Notification to initiate the transfer of acollection (no response expected).

CLRQ CollectionRequest Request to initiate the transfer of acollection (response expected).

3.4.1.2 ProtocolVersion Presence: [1..1]

Definition: Version of the acquirer to issuer protocol specifications.


3.4.1.3 ExchangeIdentification Presence: [0..1]

Definition: Unique identification of an exchange of messages between two parties.




3.4.1.4 ReTransmissionCounter Presence: [0..1]

Definition: Number of retransmission of the message. Incremented by one for each retransmission.


3.4.1.5 CreationDateTime Presence: [1..1]

Definition: Date and time at which the message was sent.

Datatype: "ISODateTime" on page 1631

3.4.1.6 InitiatingParty Presence: [1..1]

Definition: Unique identification of the partner that has initiated the exchange.

InitiatingParty contains the following elements (see "GenericIdentification172" onpage 1329 for details)


Page







3.4.1.7 RecipientParty Presence: [0..1]

Definition: Unique identification of the partner that is the recipient of the message exchange.

RecipientParty contains the following elements (see "GenericIdentification172" onpage 1329 for details)


Page









3.4.1.8 TraceData Presence: [0..*]

Definition: Information sent in the request message to be returned in the response one, for instance tohelp in the retrieval of the context of the exchange.

ISO 8583:93/2003 bit 59

TraceData contains the following AdditionalData1 elements


Page

Type [0..1] Text 39


3.4.1.8.1 Type Presence: [0..1]



3.4.1.8.2 Value Presence: [0..1]



3.4.1.9 Traceability Presence: [0..*]

Definition: Identification of partners involved in exchange from the merchant to the issuer, with therelative timestamp of their exchanges.

Traceability contains the following elements (see "Traceability7" on page 1286 for details)


Page

RelayIdentification [1..1] ± 1286

TraceDateTimeIn [0..1] DateTime 1287

TraceDateTimeOut [0..1] DateTime 1287

3.4.2 Body Presence: [1..1]

Definition: Information related to the batch management.



Body contains the following BatchManagementResponse1 elements


Page



Sender [0..1] ± 41



Context [0..1] 42















RemainingMessagesInCollection

[0..1] Quantity 48









Type [0..1] Text 50




Page


ProcessingResult [1..1] ± 50



3.4.2.1 Environment Presence: [1..1]

Definition: Environment of the batch management transaction.

Environment contains the following Environment3 elements


Page

Documents

Message Definition Report - Part 2...2020/04/23 · Message Definition Report - Part 2 For evaluation by the ISO 20022 Cards SEG This document provides details of the Message Definitions