Professional Documents
Culture Documents
4 Version 8.0
5 Novembre 2019
6 TABLE OF CONTENTS
7 1 Introduction.............................................................................................................12
8 1.1 Purpose and Use of this Guide...................................................................................12
9 1.2 Intended Audience.....................................................................................................12
10 1.3 Scope of the Document..............................................................................................12
11 1.4 Messages Covered in this Guide................................................................................12
12 1.5 How this Guide was created.......................................................................................14
13 1.6 nexo and ISO 20022..................................................................................................14
14 1.7 ISO 20022 Intellectual Property Rights Policy............................................................15
15 1.8 Message Transport....................................................................................................15
16 1.9 Security...................................................................................................................... 15
17 1.10 Coding...................................................................................................................... 15
18 1.11 Related Documents and Guides...............................................................................15
19 1.12 Conventions.............................................................................................................16
20 1.13 What’s new in the edition 8.......................................................................................16
21 2 Message Exchange and Processes......................................................................17
22 2.1 Card Payment............................................................................................................ 17
23 2.1.1 Authorisation...................................................................................................................... 17
24 2.1.2 Completion........................................................................................................................ 17
25 2.1.3 Financial capture............................................................................................................... 18
26 2.1.4 Batch................................................................................................................................. 18
27 2.1.5 Dynamic Currency Conversion..........................................................................................18
28 2.2 Scope of Card Payments............................................................................................20
29 2.3 Types of environments...............................................................................................21
30 2.3.1 Online only......................................................................................................................... 21
31 2.3.1.1 Financial capture made during the authorisation exchange.......................................................21
32 2.3.1.2 Financial capture made during the completion exchange..........................................................23
33 2.3.2 Semi-online authorisations................................................................................................25
34 2.3.2.1 Capture of offline and online transactions during completion.....................................................25
35 2.3.2.2 Capture during authorisation for online transactions and during completion for offline
36 authorisations......................................................................................................................................... 26
37 2.3.3 Offline only......................................................................................................................... 27
38 2.3.4 Capture by Batch............................................................................................................... 28
39 2.3.4.1 Authorisation through an authorisation exchange without completion with capture in batch......28
40 2.3.4.2 Authorisation through authorisation and completion exchanges with capture in batch..............29
41 2.3.4.3 Offline authorisation with capture in batch..................................................................................30
42 2.3.4.4 Capture of unsuccessful transactions in batch...........................................................................31
43 2.3.5 Batch of Authorisations...................................................................................................... 32
44 2.4 Cancellation...............................................................................................................33
45 2.4.1 Cancellation through cancellation advice or batch.............................................................34
46 2.4.2 Cancellation through cancellation request and advice exchanges....................................38
47 2.4.3 Cancellation declined by the Acquirer................................................................................40
48 2.4.4 Error in Cancellation Message Exchanges........................................................................41
49 2.4.4.1 Cancellation declined after timeout of a cancellation request.....................................................41
50 2.4.4.2 Cancellation successful after timeout of a completion advice...................................................42
51 2.4.4.3 Cancellation declined after timeout of a completion advice........................................................44
-2-
Card Payment Message Usage Guide Version 8.0
-3-
Card Payment Message Usage Guide Version 8.0
-4-
Card Payment Message Usage Guide Version 8.0
-5-
Card Payment Message Usage Guide Version 8.0
-6-
Card Payment Message Usage Guide Version 8.0
-7-
Card Payment Message Usage Guide Version 8.0
281 Figures
-8-
Card Payment Message Usage Guide Version 8.0
-9-
Card Payment Message Usage Guide Version 8.0
- 10 -
Card Payment Message Usage Guide Version 8.0
282 Tables
283 Table 1: Message type and version...................................................................................................... 14
284 Table 2: MessageFunction Values..................................................................................................... 231
285 Table 3: List of Payment Cases.......................................................................................................... 240
286 Table 4: Cancellation MessageFunction Values.................................................................................242
287 Table 5: List of Cancellation Cases.................................................................................................... 248
- 11 -
Card Payment Message Usage Guide Version 8.0
288 1 Introduction
289 1.1 Purpose and Use of this Guide
290 This guide outlines how to use the CAPE Card Payments messages in the context of the acceptor-to-
291 acquirer transactions (caaa) ISO 20022 Business Area1. It provides a comprehensive view on how
292 these messages fit within a card payment business process and the activities of the involved parties.
293 Also included are detailed explanations and examples of the use of the message components to
294 convey specific information related to these processes and activities. This guide acts as a
295 complement to the ISO 20022 CAPE Message Definition Report and the XML Schema for those
296 exchanges. It complies with ISO 20022 rules and specifications.
297 The guide provides information regarding the application of the included messages in a general
298 context. Additional documents, published by individual user communities, may be available that
299 discuss the application of this standard in a more specific context.
315 Authorisation messages2, cover the messages exchanged between an Acceptor and an
316 Acquirer to initiate and, in some implementations, to finalise the card-based payment
317 transactions initiated at a Point-of-Interaction.
318
319 Completion messages3, cover the messages exchanged between an Acceptor and an
320 Acquirer to finalise the card-based payment transactions initiated at a Point-of-Interaction.
2 1 http://www.iso20022.org/documents/general/ISO20022_BusinessAreas.pdf
3 2 AcceptorAuthorisationRequest (caaa.001.001.08) and AcceptorAuthorisationResponse (caaa.002.001.08)
4 3 AcceptorCompletionAdvice (caaa.003.001.08) and AcceptorCompletionAdviceResponse (caaa.004.001.07)
321 Cancellation messages4, cover the messages exchanged between an Acceptor and an
322 Acquirer to cancel successfully completed payment transactions or other types of transactions
323 (e.g. reservations) which have not yet been cleared. A cancellation is sometimes called a
324 manual reversal.
325 Reconciliation messages5, cover the messages exchanged between an Acceptor and an
326 Acquirer to perform checks and balances between the card acceptor and the acquirer for a
327 reconciliation period.
328 Batch transfer messages6 cover the messages exchanged in batch between an Acceptor and
329 and Acquirer process a set of card-based payment transactions initiated at a Point-of-
330 Interaction.
331 Diagnostic messages7 cover the messages exchanged between an InitiatingParty and a
332 RecipientParty to prove that messages can be exchanged correctly between the parties.
335 Dynamic Currency conversion message9 cover the messages exchanged between and
336 Acceptor or an acquirer and a DCC service provider (Agent or Acquirer).
337 All messages exchanged according to the rules defines in this Message User Guide must specify
338 ProtocolVersion 8.0 in the message header.
AcceptorCancellationResponse caaa.006.001.07
AcceptorCancellationAdvice caaa.007.001.08
AcceptorCancellationAdviceResponse caaa.008.001.07
AcceptorReconciliationRequest caaa.009.001.07
AcceptorReconciliationResponse caaa.010.001.06
356 The Cards and Related Retail Financial Services SEG mandated by the RMG to address the card
357 payments business domain officially endorsed the nexo CAPE (Card Payment Exchanges) series of
358 messages in June 2010.
359 Complete information on the membership of the ISO 20022 SEGs, the ISO 20022 Financial
360 Repository, and the message maintenance and registration process can be found on www.iso20022.org.
361 For more information on ISO itself, please see www.iso.org.
362 For more information on nexo, the body in charge of the nexo and CAPE messages, please visit
363 www.nexo-standards.org.
15 10 http://www.nexo-standards.org
373 The EPAS End-User License Agreement11 can be downloaded from the ISO 20022 Web site.
386 Useful information about XML is available from the following sources:
387 XML recommendations of W3C can be found at:
388 http://www.w3c.org/TR/2000/REC-xml-20081126
389 http://www.w3.org/TR/2006/REC-xml11-20060816/
390 XML Schema recommendations of W3C can be found at:
391 http://www.w3c.org/TR/xmlschema-0/
392 http://www.w3c.org/TR/xmlschema-1/
393 http://www.w3c.org/TR/xmlschema-2/
394 The security elements of these messages are described in the nexo document named Card Payment
395 Protocols Security.
16 11 http://www.iso20022.org/documents/general/EPASOrg_EPAS_End-user_License_Final.pdf
423 A completion exchange may also be required by an Acquirer to finalise the transaction:
424 when the Acceptor is configured to support completion,
425 in the authorisation response (if required by the Acquirer),
426 when an online approved authorisation did not complete successfully.
430 A completion exchange can be performed in realtime at the end of the transaction or in a store-and-
431 forward mode of operation.
437 The Acquirer must accept an AcceptorCompletionAdvice message. In case of an error, the message is
438 resent to the Acquirer (see section 3.3 Message Retransmission).
444 A financial capture can take place in realtime, after a short delay or at a later time as part of a batch
445 transfer.
455 In case of batch of authorisation requests, the Acquirer will sent the authorisation result to the
456 POISystem through an AcceptorBatchTransfer. The POISystem will acknowledge or reject some or all
457 of the response through an AcceptorBatchTransferResponse.
462 Dynamic Currency Conversion (DCC) is a service offered by a merchant to allow the cardholder to
463 make the payment in the currency of his card instead of the currency of the merchant when different.
464 The cardholder can choose whether to accept the DCC service or not. When DCC is allowed by the
465 merchant, the currency conversion is managed through a DCC service provider proposing to the
466 cardholder the converted amount to be ultimately debited on his card.
467 If the DCC service is refused by the cardholder, the transaction then proceeds as a normal card
468 payment transaction in the currency of the merchant.
469 The DCC service may rely on an agent acting between the merchant and the DCC service provider.
470 The following use cases involve agents in the process, but direct exchanges between a merchant and
471 a DCC service provider or between a merchant and an acquirer follow the same logic.
472 The role of the DCC service provider can be played by any party (Agent, Acquirer, etc.).
481 Use cases outlining some typical DCC scenarios are described in Chapter 6.7 Dynamic Currency
482 Conversion (DCC) .
486 An Acceptor can directly exchange with an Acquirer a series of card payment messages. The
487 proposed messages may also go through the intermediation of one or more Intermediary Agents to
488 request similar services. The Intermediary Agent is then acting as an agent of the Acquirer, the
489 Acceptor or both.
490 In a normal card payment process, the Acquirer further forwards to the Issuer (e.g. a payment
491 institution or a similar entity issuing the payment card to the cardholder) the related authorisation
492 request to get an ultimate response from the entity entitled to issue the authorisation of payment for a
493 purchase which was initiated with the card issued by them. The protocol needs to transport all relevant
494 information to enable the Issuer to take the appropriate decision i.e. either to authorise or to decline
495 the card payment transaction submitted by the Acquirer.
496 In an alternative process and based on the information submitted by an Acceptor, the Acquirer may
497 take the responsibility to authorise or decline the transaction (below a certain amount, for instance) on
498 behalf of the Issuer. He may also decide to forward to the Issuer the information required by the Issuer
499 to take the ultimate authorisation decision. In this case, the information is exchanged through an
500 Acquirer-to-Issuer protocol. This exchange is out of scope of the present specification.
501 In some specific environments (e.g. petrol), some purchasing information, such as a list of products,
502 may accompany the authorisation since the final payment can occur if and only if the list of products
503 was approved by the issuer of the payment card.
504 In that case, either the Acceptor submits with an authorisation request the list of products for approval
505 to the Acquirer which further forwards this list to the Issuer for approval or, based on the information
506 contained in the authorisation request, the Issuer submits in the authorisation response the restricted
507 list of products (e.g. fuel dispensing products) authorised for the Cardholder. It is then the
508 responsibility of the Acceptor to deliver a product or a service which complies with the product(s)
509 contained in this list.
511 Depending on business constraints and the types of equipment used, typical implementations may be
512 classified in:
513 Online-only
514 Offline with online capability
515 Offline-only with batch capture
528 An AcceptorAuthorisationResponse message is returned by the Acquirer to inform the Acceptor of the
529 outcome of the request. The responsibility of the financial data (financial capture) is transferred from
530 the Acceptor to the Acquirer with the AcceptorAuthorisationRequest message. The Acquirer then
531 stores this information for the further clearing and settlement of the transaction.
Acceptor Acquirer
AcceptorAuth
orisationReque
st
authorisation approval
and capture
orisa tionResponse
AcceptorAuth
transaction
completed
successfully
Acceptor Acquirer
AcceptorAuth
orisationReque
st
authorisation approval
and capture
nse
orisationRespo
AcceptorAuth
transaction fails
negative completion to
reverse the transaction AcceptorComple
tionAdvice
Authorisation and
capture reversed
tionAdvice Response
AcceptorComple
544 An AcceptorCompletionAdvice message is sent by the Acceptor to the Acquirer to capture the
545 transaction. An AcceptorCompletionAdviceResponse message is sent back by the Acquirer to the
546 Acceptor to notify the Acceptor about the successful receipt of the advice.
Acceptor Acquirer
AcceptorAuthor
isa tionRequest
Transaction
authorised
e
isationRespons
AcceptorAuthor
Transaction
authorised
AcceptorComp
letionAdvice
Transaction
authorised
and captured
esponse
Transaction completed letionAdviceR
AcceptorComp
successfully
Acceptor Acquirer
AcceptorAuth
orisationReque
st
Transaction
authorised
nse
orisationRespo
AcceptorAuth
transaction fails
555 Authorisations are processed either online or offline depending on the context of the transaction. In
556 normal cases, the financial capture of the transaction is made during the completion exchange.
558 In this scenario, financial capture of previously online and offline authorised transactions is carried out
559 during completion.
Acceptor Acquirer
AcceptorAuthor
authorisation isationRequest
online
authorisation approved
online Transaction
authorised
isationResponse
AcceptorAuthor
Transaction
authorised
AcceptorCompl
etionAdvice
Transaction
authorised
(online) and
captured
tionAdv iceResponse
AcceptorComple
offline
authorisation authorisation
approval
offline
AcceptorCompl
etionAdvice
Transaction
authorised
(offline) and
onse captured
tionAdviceResp
AcceptorComple
561 2.3.2.2 Capture during authorisation for online transactions and during completion
562 for offline authorisations
563 In order to reduce the number of exchanges, the financial capture may be carried out during
564 authorisation exchanges for on-line authorisations and during completion exchanges for off-line
565 authorisations.
Acceptor Acquirer
AcceptorAuthor
isationRequest
online
authorisation authorisation Transaction
approved authorised (online)
online and captured
isationResponse
transaction AcceptorAuthor
completed
successfully
offline authorisation
authorisation approved
offline
transaction
completes
successfully AcceptorCompl
etionAdvice
Transaction
authorised
(offline) and
onse captured
tionAdviceResp
AcceptorComple
569 In this scenario, an AcceptorCompletionAdvice is used to inform the Acquirer about the outcome of a
570 previously offline-authorised transaction and to advise the Acquirer to capture the financial data for
571 clearing and settlement.
Acceptor Acquirer
authorisation approved
offline
AcceptorComp
letionAd vice
Transaction
authorised
(offline) and
captured
letionAd viceResponse
transaction completed AcceptorComp
successfully
authorisation approved
offline
AcceptorComp
letionAd vice
Transaction
authorised
transaction completed (offline) and
successfully
letionAd viceResponse captured
AcceptorComp
Acceptor Acquirer
AcceptorAuthor
isationRequest
online Authorisation
authorisation Transaction
initiated
authorised
online e
isationRespons
AcceptorAuthor
offline Authorisation
authorisation initiated
offline
AcceptorBatch
Capture through batch Tr ansfer
Transaction
authorised
Transaction and captured
nse
completed Tr ansferRespo
AcceptorBatch
successfully
585 Figure 8: Authorisation through an authorisation exchange without completion with capture in
586 batch
587 2.3.4.2 Authorisation through authorisation and completion exchanges with capture in
588 batch
589 In this scenario, an AcceptorBatchTransfer message is used by the Acceptor to advise the Acquirer to
590 capture in batch mode transactions authorised through previous authorisation and completion
591 exchanges. The Acquirer captures the financial data of the transactions for clearing and settlement.
Acceptor Acquirer
AcceptorAuthor
isationR equest
Authorisation initiated Transaction
online authorised
se
isationRespon
AcceptorAuthor
AcceptorBatch
Transfer
Capture through batch
Transaction
authorised
se and captured
TransferRespon
AcceptorBatch
592 Figure 9: Authorisation through authorisation and completion exchanges with capture in batch
594 In this scenario, an AcceptorBatchTransfer message is used by the Acceptor to advise the Acquirer to
595 capture in batch mode transactions that were previously authorised offline and stored. The Acquirer
596 captures the financial data of the transactions for clearing and settlement.
Acceptor Acquirer
offline Transaction
authorisation authorised
offline
offline Transaction
authorisation authorised
offline
Capture
through batch AcceptorBatch
Tr ansfer
Transactions
authorised
nse and captured
Tr ansferRespo
AcceptorBatch
599 In this scenario, an AcceptorBatchTransfer message is used by the Acceptor to send to the Acquirer
600 for capture in batch modeunsuccessfully completed and reversed transactions.
Acceptor Acquirer
Transaction
authorised
authorisation response
timeout
Authorisation reversed
through a negative
completion Authorisation reversed
Capture through
batch of
authorised or
Unsucessufully Transactions
completed and captured
reversed
authorised
transactions
Acceptor Acquirer
DataSet 1 Offline
transactions
Transactions
DataSet 2 start offline
and pending
AcceptorBatch
Transfer
Acknowledgement
of DataSet 1
se
TransferRespon
AcceptorBatch
Result of
authorisation
Transfer of DataSet 2
AcceptorBatch
Transactions
of DataSet 2
are processed
and captured AcceptorBatch
Transfer
se
TransferRespon
AcceptorBatch
613 Cancellation is initiated by Acceptor to cancel a payment which was successfully completed. . A
614 cancellation is a user requested reversal. A cancellation cannot be revoked.
622 An Acquirer can never decline an AcceptorCancellationAdvice . If the Acceptor does not receive an
623 AcceptorCancellationAdviceResponse , the Acceptor has to resend a AcceptorCancellationAdvice
624 until the Acceptor receives the corresponding response from the Acquirer (see 3.3 Message
625 Retransmission section).
626 Should an Acquirer decline an AcceptorCancellationRequest, an Acceptor always has the possibility to
627 refund the cardholder in cash or with a refund transaction.
628 The cancellation process may be affected by POI configuration parameters defined outside of the
629 present protocol.
640 Note: The Acceptor is able to know that the Acquirer did not clear the transaction because:
641 the clearing of the transactions is only allowed after closing the corresponding reconciliation
642 period by a reconciliation exchange, and
643 a reconciliation message to close the reconciliation period has not been sent for the
644 reconciliation period that includes the transaction.
Acceptor Acquirer
Transaction
authorised offline
or
AcceptorAutho
Authorised online risati onRequest
Transaction
authorised
e
risationRespons
AcceptorAutho
Transaction
authorised
AcceptorComp
letion Advice Transaction
Transaction completed authorised and
without capture completed without
e
letion AdviceRespons capture
AcceptorComp
Cancellation performed
locally
Option 1: Cancellation
advice used to reverse AcceptorCancell
ationAdvice
authorisation Authorisation
reversed
onse
ationAdviceResp
AcceptorCancell
654 The message flow is the same as if the Acceptor had sent previously an AcceptorCompletionAdvice
655 without financial capture for the authorised transaction before the cancellation was processed.
661 When the Acceptor uses batch transfer for financial capture, the Acceptor sends a batch transfer
662 depending on the configuration, with either:
663 Include both the original debit (or credit) and cancellation transaction
664 Remove the original debit (or credit) from the batch
666 An Acceptor initiated several authorisations with financial capture (by individual messages or
667 batch).
668 The transactions are authorised and captured by the Acquirer.
669 The Acceptor is aware that the Acquirer has not yet cleared the transactions and he
670 completes the cancellation offline.
671 The Acceptor sends an AcceptorCancellationAdvice to notify the Acquirer of the cancellation
672 of the authorisation and financial capture on his side.
673 The Acquirer sends back an AcceptorCancellationAdviceResponse to inform the Acceptor
674 that the advice was received by the Acquirer. The Acquirer reverses the authorised and
675 captured transactions.
676 Should batch transfer be used by the Acceptor for financial capture, the Acceptor sends a
677 batch transfer depending on the configuration, with either:
678 Include both the original debit (or credit) and cancellation transaction
679 Remove the original debit (or credit) from the batch
Acceptor Acquirer
Transaction
authorised offline
or
Autorisation requested
online AcceptorAuthor
isationRequest Transaction
authorised
e
isationRespons
AcceptorAuthor
Transaction
authorised
AcceptorComp
letionAdvice
Option 1: Completion Transaction
Advice used for authorised
financial capture and captured
letionAdvic eResponse
AcceptorComp
AcceptorBatch
Tr ansfer
Option 2: Batch Transaction
transfer used for authorised
financial capture nse and captured
Tr ansferRespo
AcceptorBatch
Option 1 : Cancellation
AcceptorCancell
carried out through a ationAdvice
Cancellation Advice
Financial capture and
authorisation reversed
onse
ationAdviceResp
AcceptorCancell
Option 2 : Cancellation
carried out through
batch with cancellation AcceptorBatch
Tr ansfer
flag set on
Financial capture and
nse authorisation reversed
Tr ansferRespo
AcceptorBatch
680 Figure 14: Cancellation through cancellation advice and batch exchanges
684 This type of cancellation is used when all the following conditions are satisfied:
685 financial capture of the transaction has already occured (by message or by batch), and
686 the Acceptor is unaware whether the Acquirer cleared the transaction or not , and
687 the Acceptor has all the data of the original transaction required for building up the
688 AcceptorCancellationRequest and AcceptorCancellationAdvice messages.
Acceptor Acquirer
Transaction
authorised offline
or
Autorisation
initiated
AcceptorAuth
online orisationRequ
est
Transaction
authorised
nse
orisationRespo
AcceptorAuth
Transaction
authorised
AcceptorCom
pletionAdvice Transaction
Option 1:
Completion used for authorised and
financial capture Respo
captured
pletionAdvice
AcceptorCom
nse
AcceptorBatc
hTransfer
Option 2 :Batch Transaction
transfer used for authorised and
capture nse captured
hTransferRespo
AcceptorBatc
Cancellation initiated
through a AcceptorCancel
lationRequest
cancellation request
Capture reversed
lationResponse
Capture reversed AcceptorCancel
Option 1:
AcceptorCancel
Cancellation advice lationAdvice
used to complete Capture and
cancellation Authorisation
po
lationAdviceRes reversed
AcceptorCancel
nse
Option 2: Batch
used to complete
cancellation (flag to
cancel transactions) AcceptorBatc
hTransfer
Capture and
Authorisation
nse reversed
hTransferRespo
AcceptorBatc
707 Figure 15: Cancellation through cancellation request and advice exchanges
Transaction
authorised offline
or
Authorisation initiated
online AcceptorAutho
risationReques
t
Transaction
authorised
se
risationRespon
AcceptorAutho
Transaction
authorised
AcceptorComple
tionAdvice
Option 1 : Completion Transaction
Advice used for authorised and
capture onse captured
tionAdviceResp
AcceptorComple
AcceptorBatch
Transfer
Option 2 : Batch used Transaction
for capture authorised and
se
TransferRespon captured
AcceptorBatch
Option 1 :
AcceptorCanc
Cancellation initiated ellationRequest
Cancellation declined
(transaction still
se captured)
ellationRespon
Cancellation declined AcceptorCanc
Declined Cancellation
can be sent in next
Batch transfer, if
Batch transfer is used
Option 2: Flag
transactions as AcceptorBatch
Transfer
cancelled or remove Cancellation declined
from batch (transactions still
se captured)
TransferRespon
Cancellation declined AcceptorBatch
722 In this case the Acceptor must decline the cancellation to the cardholder. An
723 AcceptorCancellationAdvice is sent to the Acquirer:
724 to inform the Acquirer that the cancellation was declined to the cardholder
Acceptor Acquirer
Transaction
authorised offline
or
authorisation Initiated
online
Transaction
authorised
Cancellation initiated
If request received,
Cancellation
Cancellation is processed
declined as no reply
Cardholder informed
that the cancellation
was declined
733 Furthermore, the Acceptor is unaware whether the transaction was cleared or not (if the transaction
734 was actually captured).
735 The Acceptor sends an AcceptorCancellationRequest to ask the Acquirer whether a cancellation is
736 possible or not.
737
738 Should the cancellation be possible:
739 the Acquirer sends a AcceptorCancellationResponse to inform the Acceptor that the
740 transaction can be cancelled.
741 the Acceptor informs the cardholder about the success of the cancellation and sends an
742 AcceptorCancellationAdvice to inform the Acquirer about the successful completion of the
743 cancellation.
744 the Acquirer responds with an AcceptorCancellationAdviceResponse to inform the Acceptor
745 that the advice was received by the Acquirer.
746 Should clearing occur between the receipt of the AcceptorCancellationRequest and the
747 AcceptorCancellationAdvice, the Acquirer will refund the cardholder through an Acquirer to Issuer
748 exchange.
Acceptor Acquirer
Transaction
authorised offline
or
Authorisation initiated
online AcceptorAuthor
isationRequest
Transaction
authorised
e
isationRespons
AcceptorAuthor
Cancellation approved
ationResponse
AcceptorCancell
757 Furthermore, the Acceptor is unaware whether the transaction was cleared or not (if the transaction
758 was actually captured).
759 The Acceptor sends an AcceptorCancellationRequest to ask the Acquirer whether a cancellation is
760 possible or not.
761 Option 1
762 The cancellation is declined by the Acquirer because the transaction has already been captured and
763 cleared:
764 the Acquirer sends an AcceptorCancellationResponse to inform the Acceptor that the
765 cancellation was declined.
766 the Acceptor informs the cardholder that the cancellation was declined by the Acquirer
767 the Acceptor needs to send an AcceptorCompletionAdvice with the financial data for capture
768 by the Acquirer because he does not know that the transaction is already captured. The
769 Acquirer discards the message since the transaction has already been captured.
770 Option 2
771 The cancellation is declined by the Acquirer because he did not receive the
772 AcceptorCompletionAdvice message:
773 the Acquirer sends an AcceptorCancellationResponse to inform the Acceptor that the
774 cancellation was declined.
775 the Acceptor informs the cardholder that the cancellation was declined by the Acquirer
776 the Acceptor needs to send an AcceptorCompletionAdvice with the financial data for capture
777 by the Acquirer. The Acquirer captures the financial data for a further clearing.
Acceptor Acquirer
Transaction
authorised offline
or
Autorisation initiated
online AcceptorAuthor
isationRequest
Transaction
authorised
e
isationRespons
Transaction AcceptorAuthor
successfully
completed
AcceptorCompletio
Option 1 nAdvice
Transaction captured
letion and cleared
AcceptorComp e
AdviceRespons
Option 2 AcceptorCom
pletionAdvice
ationResponse
AcceptorCancell
Completion advice
for capture AcceptorComp
letionAdvice
Transaction captured
(option 2)
onse
tionAdviceResp
AcceptorComple
784 The Acceptor wants to cancel the transaction but is unaware whether the Acquirer has already cleared
785 the transaction or not.
786 The Acceptor sends an AcceptorCancellationRequest to ask the Acquirer whether a cancellation is
787 possible or not.
788 The Acceptor does not receive a response for the AcceptorCancellationRequest (timeout):
789 the Acceptor informs the cardholder that the cancellation was declined
790 the Acceptor sends back an AcceptorCompletionAdvice with the financial data for capture by
791 the Acquirer
792 After receiving an AcceptorCompletionAdviceResponse from the Acquirer, the Acceptor sends
793 an AcceptorCancellationAdvice to inform the Acquirer that the cancellation was declined.
794 The Acquirer acknowledges this advice with an AcceptorCancellationAdviceResponse.
Acceptor Acquirer
Transaction
authorised offline
or
authorisation initiated
online
Transaction
authorised
Transaction
successfully
completed
Request cancellation
If request received:
Approve or decline
cancellation;
If approved reverse
capture (if relevant)
Cancellation declined to
cardholder
Repeat Completion
advice for capture
Transaction
authorised and
captured
800 The Acceptor wants to cancel the transaction and knows that the Acquirer did not clear the transaction
801 yet.
802 The Acceptor sends an AcceptorCancellationAdvice (without sending a prior
803 AcceptorCancellationRequest) to advise the Acquirer about the cancellation of the transaction.
Acceptor Acquirer
Transaction
authorised offline
or
authorisation initiated
online
Transaction
authorised
Transaction
successfully
completed
Completion Advice
with capture
Transaction possibly
captured
Cancellation completed
offline
814 The Acceptor sends an AcceptorBatchTransfer to capture the transaction, but did not receive an
815 AcceptorBatchTransferResponse.
816 The Acceptor wants to cancel the transaction but is unaware whether the Acquirer has already cleared
817 the transaction or not.
818 The Acceptor sends an AcceptorCancellationRequest to ask the Acquirer whether a cancellation is
819 possible or not.
830 The Acceptor sends a batch transfer depending on the configuration, with either:
831 Include both the original debit (or credit) and cancellation transaction
832 Remove the original debit (or credit) from the batch
Acceptor Acquirer
Transaction
authorised offline
or
authorisation initiated
online AcceptorAutho
risationReques
t
Transaction
authorised
se
risationRespon
Transaction AcceptorAutho
successfully
completed
838 The Acceptor sends an AcceptorBatchTransfer to capture the transaction, but does not receive an
839 AcceptorBatchTransferResponse.
840 The Acceptor wants to cancel the transaction but is unaware whether the Acquirer has already cleared
841 the transaction or not.
842 The Acceptor sends an AcceptorCancellationRequest to ask the Acquirer whether a cancellation is
843 possible or not.
848 The Acceptor has to resend the AcceptorBatchTransfer that failed. No AcceptorCancellationAdvice is
849 sent by the Acceptor.
Acceptor Acquirer
Transaction
authorised offline
or
authorisation initiated
online AcceptorAutho
risationRequest
Transaction
authorised
se
risationRespon
Transaction AcceptorAutho
successfully
completed
Cancellation declined
ationResponse
AcceptorCancell
851 2.4.4.8 Declined cancellation after timeout in batch mode and cancellation request
855 The Acceptor sends an AcceptorBatchTransfer to capture the transaction, but does not receive an
856 AcceptorBatchTransferResponse.
857 The Acceptor wants to cancel the transaction but is unaware whether the Acquirer already has cleared
858 the transaction or not.
859 The Acceptor sends an AcceptorCancellationRequest to ask the Acquirer whether a cancellation is
860 possible or not.
861 The Acceptor does not received the response to the AcceptorCancellationRequest message
862 the Acceptor has to decline the cancellation to the cardholder
863 the Acceptor sends an AcceptorCancellationAdvice to inform the Acquirer about the declined
864 cancellation of the transaction.
865 the Acquirer sends an AcceptorCancellationAdviceResponse to inform the Acceptor that the
866 cancellation was declined.
867 Once the Acceptor has sent the AcceptorCancellationAdvice, it has to resend the
868 AcceptorBatchTransfer for the financial capture by the Acquirer since the transaction was not
869 cancelled.
Acceptor Acquirer
Transaction
authorised offline
or
authorisation initiated
online AcceptorAutho
risationReques
t
Transaction
se authorised
risationRespon
AcceptorAutho
Transaction
successfully
completed
AcceptorCom
pletionAdvice
Completion advice
Transaction
(no capture)
se authorised
ionAdviceRespon
AcceptorComplet
Cancellation advice to
advise about declined AcceptorCanc
ellationAdvice
cancellation Transaction
authorised and
capture reversed
esponse
Confirmation about ellationAdviceR
declined cancellation AcceptorCanc
870 Figure 24: Declined cancellation after timeout in batch mode and cancellation request
871 2.4.4.9 Declined cancellation in batch mode after timeout in cancellation request
875 The Acceptor sends an AcceptorBatchTransfer to capture the transaction and he receives an
876 AcceptorBatchTransferResponse to confirm the financial capture.
877 The Acceptor wants to cancel the transaction but is unaware whether the Acquirer has already cleared
878 the transaction or not.
879 The Acceptor sends an AcceptorCancellationRequest to ask the Acquirer whether a cancellation is
880 possible or not.
887 Once the Acquirer has declined the cancellation, no AcceptorBatchTransfer needs to be exchanged
888 since the Acquirer has already made the financial capture and the transaction was not cancelled.
Acceptor Acquirer
Transaction
authorised offline
or
authorisation initiated
online AcceptorAutho
risationReques
t
Transaction
authorised
se
risationRespon
AcceptorAutho
Transaction
successfully
completed
AcceptorCom
pletionAdvice
Completion advice
Transaction
without capture
sponse authorised
AcceptorCom pletionAdviceRe
889 Figure 25: Declined cancellation in batch mode after timeout cancellation request
890 2.4.4.10 Cancellation in batch mode of a transaction captured but not yet cleared
894 The Acceptor sends an AcceptorBatchTransfer to capture the transaction, but does not receive an
895 AcceptorBatchTransferResponse.
896 The Acceptor wants to cancel the transaction and is aware that the Acquirer has not cleared the
897 transaction yet.
904 The Acceptor sends a batch transfer depending on the configuration, with either:
905 Include both the original debit (or credit) and cancellation transaction
906 Remove the original debit (or credit) from the batch
907 .
Acceptor Acquirer
Transaction
authorised offline
or
autorisation initiated
online AcceptorAutho
risationReques
t
Transaction
authorised
se
risationRespon
AcceptorAutho
Transaction
successfully
completed
AcceptorCom
pletionAdvice
Completion advice
Transaction
without capture might
authorised and
be used
tionAdvice Response completed
AcceptorComple
Cancellation completed
offline
AcceptorCanc
ellationAdvice
Authorisation and
capture reversed
esponse
ellationAdviceR
AcceptorCanc
Batch transfer with
transaction flagged as AcceptorBatch
Transfer
cancelled
tchTransfer
AcceptorBa
Response
908 Figure 26: Cancellation in batch mode of a transaction captured but not yet cleared
911 Batch allows an Acceptor to send groups of transactions in a single message or a file to the Acquirer
912 for financial capture.
917 The AcceptorBatchTransfer to be uploaded contains locally stored offline and online transactions.
918 In addition to financial transactions (payments, refunds, etc.) non-financial transactions (incomplete,
919 declined, etc.) may be added to an AcceptorBatchTransfer.
920 TransactionTotals are part of the file to enable reconciliation.
921 Message or File integrity may be ensured through a security trailer.
923 The Acquirer informs the acceptor about the validation of AcceptorBatchTransfer content by sending
924 an AcceptorBatchTransferResponse message.
925 The Acceptor retains the stored transactions which were previously sent to the Acquirer until receiving
926 an AcceptorBatchTransferResponse message from the Acquirer.
927 The AcceptorBatchTransferResponse provides status information about the data received.
928 The Acquirer informs the Acceptor about the transfer of data.
929
930 Once the Acceptor has received this notification, from a protocol perspective, the Acceptor is freed of
931 any technical responsibility to keep the data .
934 The upload of the data to be captured is initiated by an Acceptor using either a file transfer exchange
935 or exchanges of messages.
936 Data to be sent is organised into sets. An AcceptorBatchTransfer contains one or more sets.
937 A DataSet contains one or more financial and/or non-financial transactions. However it is possible that
938 a data set contains no transactions.
939 Data common to all transactions of a set may be factorised and sent prior to the transactions (e.g.
940 Acquirer data, POI data…)
941 The content of the set and its organisation depend on the POI configuration.
0 .. n
952 contained within the appropriate DataSet response. An Acquirer can only send a DataSet in a
953 AcceptorBatchTransferResponse when all transactions in that DataSet have been processed.
954 If a set is partially approved, the element “DataSet” is present. It contains the details of rejected
955 transactions.
956 The content of the DataSet and its organisation depend on POI configuration.
957 File structure may be represented as follows:
0 .. n 0 .. n
0 .. n 0 .. n
960 To prevent file size problems, some data of an AcceptorBatchTransfer may be factorised to reduce the
961 occurrences of repetitive data.
962 The Acquirer must support factorisation. The Acceptor may choose whether to perform factorisation or
963 not.
975 All transaction components within a DataSet will inherit data from the values held in CommonData
976 unless different data is held in the transaction component itself.
977 The Acquirer sends an AcceptorBatchTransferResponse with the same DataSet factorisation as in the
978 related AcceptorBatchTransfer.
985 A batch is generally used as a collection of transactions to be sent to an Acquirer for processing.
999 Cancelled transactions are sent with “TransactionSuccess” having the value “True”
1000 Depending on a TMS configuration, the following types of transactions can be present or not :
1001 Debit and Credit transaction
1002 Failed transactions
1003 Declined transactions
1004 Cancelled transactions
1005 The AcceptorBatchTransferResponse file contains the response from the Acquirer for each DataSet
1006 that has been processed. Any individual transactions that have been rejected by the Acquirer must be
1007 contained within the appropriate DataSet response.
1008 An Acquirer can only send a DataSet in a BatchTransferResponse when all transactions in that
1009 DataSet have been processed.
1010 If a DataSet is not sent in the current AcceptorBatchTransferResponse, it will be added in a following
1011 AcceptorBatchTransferResponse and not necessary the next one. In consequence of which :
1012 Responses to one AcceptorBatchTransfer can be sent in several
1013 AcceptorBatchTransferResponse.
1014 Responses for several AcceptorBatchTransfer can be sent in one
1015 AcceptorBatchTransferResponse. (See section 4.6 Batch.)
1016 The acquirer has to give a response in one DataSet for all the transactions contained in a DataSet
1017 received and only for these transactions.
1035 The rejected AuthorisationRequests are sent in a related AuthorisationResponse with Response
1036 set to "Declined". The BatchTransferResponse is not used for acknowledging AuthorisationRequests.
1037 In this case, a completion can be sent to nullify the effect of the authorisation request.
1043 The acquirer can require to receive completions in the batch for previously authorised online
1044 transactions and / or authorised offline transactions.
1045 transactions authorised online are configured to be captured in batch (e.g. the TMS parameter
1046 AcquirerProtocolParameters.OnlineTransaction.FinancialCapture is equal to Batch)
1047 transactions authorised offline are configured to be captured in batch (e.g. the TMS parameter
1048 AcquirerProtocolParameters.OfflineTransaction.FinancialCapture is equal to Batch)
Acceptor Acquirer
Transaction initiated
offline
AcceptorBatch
Tr an
Authorisations initiated (AuthorisationRe sfer
by batch with capture quest)
Transactions
authorised and
captured
tchTransfer
AcceptorBa
ionResponse)
(Authorisat
Transaction
successfully
completed (approved/
declined) or rejected
AcceptorBatch
Transfer
(completion)
Batch transfer with
capture to void rejected
transactions
Rejected transaction
voided
hTransfe rResponse
AcceptorBatc
Acceptor Acquirer
Transaction initiated
offline
AcceptorBatch
Transfer
Authorisations initiated (AuthorisationR
equest)
by batch
Transactions
authorised
chTransfer
AcceptorBat esponse)
nR
(Authorisatio
Transaction
successfully
completed (approved/
declined) or rejected
AcceptorBatch
Capture initiated by Transfer
(completion)
batch
Transactions
captured
spon se
hTransferRe
AcceptorBatc
1052 To configure batch exchange policy, the following rules must be applied:
1053 Month mean calendar month.
1054 Use the last day of the month for a monthly cyclic call when the day is bigger than the last day
1055 of the current month
1056 Combination of month and day don't need to be supported and a configuration with a
1057 combination may be rejected by a POI
1058 It's recommanded to put start time in the past and no end time.
1059 If the start time is in the future, the period is open until the start time
1060 If the end time is over, a manual reconciliation has to be done to close the period.
1061 Although theses rules are provided in the present document, the reference for configuration is the
1062 TMS MUG and not the Acquirer MUG
1065 Reconciliation is the process of performing checks and balances of transactions previously captured.
1066 This process is carried out between an Acceptor and an Acquirer for a given reconciliation period.
1067 An Acceptor initiates a reconciliation exchange to ensure that the debits and credits match the
1068 computed balances by the Acquirer and performed during the same reconciliation period.
1069 An AcceptorReconciliationRequest message is sent by the Acceptor to inform the Acquirer about the
1070 totals accumulated during the reconciliation period.
Acceptor Acquirer
AcceptorReconciliationRequ
est
nse
AcceptorReconciliationRespo
1074 Should the Acceptor or the Acquirer detect a difference in totals, the discrepancy must then be
1075 resolved by other means and is outside the scope of this protocol.
1076 Reconciliation is not mandatory and reconciliation messages are never exchanged when the
1077 configuration parameter AcquirerProtocolParameters.ReconciliationExchange.ExchangePolicy defined
1078 in the AcceptorConfigurationUpdate TMS message has the value None or is absent.
1080 If reconciliation between an Acceptor and an Acquirer is required, each transaction belongs to one and
1081 only one reconciliation period identified by the message element
1082 Transaction.ReconciliationIdentification.
1083 Assignment of transactions to a reconciliation period can be made by either the Acceptor or the
1084 Acquirer depending on the TMS configuration parameter flag ReconciliationByAcquirer.
1085 If the reconciliation period assignment is under the control of the Acceptor (ReconciliationByAcquirer
1086 parameter is False), the reconciliation period is identified by the message element
1087 Transaction.ReconciliationIdentification in the AcceptorAuthorisationRequest,
1088 AcceptorCompletionAdvice, AcceptorCancellationRequest and AcceptorCancellationAdvice
1089 messages.
Acceptor Acquirer
ReconciliationIdentification:112 AcceptorAuthorisationReq
uest
onse
AcceptorAuthorisationResp
ReconciliationIdentification:112 AcceptorReconciliationReques
t
ReconciliationIdentification:112
se
AcceptorReconciliationRespon
1091 During the reconciliation exchange, the reconciliation period is identified in the message element
1092 Transaction.ReconciliationIdentification of AcceptorReconciliationRequest and
1093 AcceptorReconciliationResponse.
Acceptor Acquirer
AcceptorAuthorisationReq
uest
ReconciliationIdentification:113
onse
AcceptorAuthorisationResp
ReconciliationIdentification:113 AcceptorReconciliationReques
t
ReconciliationIdentification:113
se
AcceptorReconciliationRespon
1095 The reconciliation period of the transaction is identified by the ReconciliationIdentification at the time of
1096 the transaction capture. If the capture is performed during the completion, the
1097 AcceptorCompletionAdvice may have a ReconciliationIdentification value different from the
1098 Authorisation.
Acceptor Acquirer
ReconciliationIdentification:112 AcceptorAuthorisationRequest
transaction 1
authorisation approval
AcceptorAuthorisationResponse without capture
transaction 1
ReconciliationIdentification:112 AcceptorReconciliationRequest
AcceptorReconciliationResponse
ReconciliationIdentification:113 AcceptorCompletionAdvice
transaction 1
capture of transaction 1
ponse
AcceptorCompletionAdviceRes
transaction 1
ReconciliationIdentification:113 AcceptorReconciliationRequest
AcceptorReconciliationResponse
1099 Figure 34: Reconciliation between the Authorisation and the Completion
1100 When the flow of transaction cannot be stopped for closing the reconciliation at the acceptor, before
1101 sending the AcceptorReconciliationRequest message, the Acceptor must:
1102 Assigne the new transactions to the next reconciliation period, and
1103 Wait for the completion of the transactions of the reconciliation period to close
1104 before sending the AcceptorReconciliationRequest message.
1105 Successive reconciliation periods are then interleaved.
Acceptor Acquirer
AcceptorCompletionAdvice
ReconciliationIdentification:112
transaction 1
open reconciliation period 113
reconciliation
AcceptorCompletionAdvice period 112
ReconciliationIdentification:113
transaction 2
ponse
AcceptorCompletionAdviceRes
transaction 1
close reconciliation period 112
AcceptorReconc
ReconciliationIdentification:112 iliationReques
t
ponse
AcceptorCompletionAdviceRes
transaction 2
AcceptorCompletionAdvice reconciliation
ReconciliationIdentification:113 period 113
transaction 3
AcceptorReconciliationResponse
ponse
AcceptorCompletionAdviceRes
transaction 2
1108 Transaction totals are calculated from transactions completed and captured during the reconciliation
1109 period.
1142 The Totals of declined and failed transactions are included in the ReconciliationRequest. A
1143 Reconciliation is never rejected because of differences with declined and failed transaction totals.
1144 If a cancellation is allowed after the reconciliation of the original transaction, the original transaction is
1145 considered as a Debit or Credit for the first reconciliation period, and the cancelled transaction
1146 considered as a DebitReverse or a CreditReverse respectively for the second reconciliation period.
1147 If a transaction can be cancelled on a different POI terminal from the POI terminal where the original
1148 transaction has been performed, and the totals are accumulated per POIGroupIdentification, the
1149 cancellation (DebitReverse or CreditReverse) is counted in the totals of the POIGroupIdentification
1150 related to the original transaction, even if the Cancellation transaction belongs to another reconciliation
1151 period.
1152 A difference in totals between the Acceptor and the Acquirer may occur after reaching the maximum
1153 number of retransmissions of an AcceptorCompletionAdvice (or AcceptorCancellationAdvice) without
1154 a positive AcceptorCompletionAdviceResponse (or AcceptorCancellationAdviceResponse). In this
1155 case, it is not possible for the Acceptor to determine the knowledge of the Acquirer about the outcome
1156 of the transaction because:
1157 The Acquirer may have not received or understood the repeated AcceptorCompletionAdvice
1158 (or AcceptorCancellationAdvice) messages,
1159 The Acquirer may have received and understood an AcceptorCompletionAdvice (or
1160 AcceptorCancellationAdvice) message, but the Acceptor has not received or has not
1161 understood the AcceptorCompletionAdviceResponse (or
1162 AcceptorCancellationAdviceResponse).
1167 The Policy component of this configuration parameter can contain the following values:
1168 Cyclic: an AcceptorReconciliationRequest message is sent periodically according to the timing
1169 conditions defined in the AcquirerProtocolParameters.ReconciliationExchange.TimeCondition
1170 component.
1171 NumberLimit: an AcceptorReconciliationRequest message is sent as soon as the sum of all
1172 TransactionTotals.TotalNumber of the current reconciliation period reaches the value
1173 configured in the AcquirerProtocolParameters.ReconciliationExchange.MaximumNumber
1174 component.
1175 TotalLimit: an AcceptorReconciliationRequest message is sent as soon as the sum of all
1176 TransactionTotals.CumulativeAmount of the current reconciliation period reaches or exceeds
1177 the value configured in the
1178 AcquirerProtocolParameters.ReconciliationExchange.MaximumAmount component.
1179 OnDemand: an AcceptorReconciliationRequest message is sent when requested by the
1180 Acceptor.
1181 None: the Acceptor never sends AcceptorReconciliationRequest messages.
1182 The component Transaction.ClosePeriod may request the closure of a reconciliation period. This
1183 request is useful when the Acquirer assigns a reconciliation period identification to transactions.
1188 It is possible that the verification of the totals cannot be performed in real-time before sending the
1189 response to the reconciliation. In this case, the AcceptorReconciliationResponse message must
1190 contain:
1191 Response = "Approved".
1192 ResponseReason = "Totals Unavailable".
1193 TransactionTotals must be absent.
1194 If the totals are performed in real-time by the Acquirer, and some totals are different from the totals
1195 send by the Acceptor, the AcceptorReconciliationResponse message must contain:
1196 Response = "Declined".
1197 ResponseReason = "Difference in Totals".
1198 TransactionTotals must be present, as computed by the Acquirer.
1199 Whatever the result of the reconciliation (Response = "Approved" or "Declined"), a new reconciliation
1200 period has to be started to perform new transactions. Any difference or discrepancy has to be resolved
1201 outside the protocol.
1202 If the Acceptor did not receive an acceptable response to an AcceptorReconciliationRequest, it may
1203 send a new AcceptorReconciliationRequest message, with a copy of the body ReconciliationRequest,
1204 and a new value of ExchangeIdentification and CreationDateTime in the header.
AcceptorDiagnosticRequ
est
onse
AcceptorDiagnosticResp
AcceptorDiagnosticReque
st
invalid message
AcceptorRejection
1262 An AcceptorDiagnosticRequest message does not contain any information that may allow an Agent to
1263 further route the message to another Agent or RecipientParty.
AcceptorDiagnosticReque
st
nse
AcceptorDiagnosticRespo
1266 An Acceptor must only use an AcceptorDiagnosticRequest message under exceptional situations to
1267 avoid any potential risk of message congestion (e.g. after the installation of a payment application or
1268 during an update of electronic keys).
1269 An Intermediary Agent uses a diagnostic exchange to check the availability of the communication with
1270 an Acquirer or another Intermediary Agent.
AcceptorDiagnosticReque
st
nse
AcceptorDiagnosticRespo
1275 For instance, if an InitiatingParty sends an AcceptorAuthorisationRequest message and that message
1276 is not recognised by the RecipientParty, the RecipientParty sends back an AcceptorRejection in
1277 response to that message.
InitiatingParty RecipientParty
AcceptorAuthorisationReq
uest
message couldn’t
be processed
AcceptorRejection
1279 The AcceptorRejection message contains the reason of the rejection (RejectReason), some additional
1280 information on the rejection (AdditionalInformation) for further analysis as well as the rejected
1281 message itself (MessageInError) (to make it possible to compare with the message sent).
1283 1. The envelope of the received message is incorrect (see section 3.4.1.2 a ).
1284 RejectReason contains the value InvalidMessage. It is recommended to include the optional fields
1285 AdditionalInformation to provide the details of the error. MessageInError contains the received
1286 message with the error.
1287 2. The rejected message cannot be decoded properly (see section 3.4.1.2 b ).
1288 RejectReason contains the value ParsingError. It is recommended to include the optional fields
1289 AdditionalInformation to provide the details of the coding error. MessageInError contains the
1290 received message with the coding error.
1291 3. The identification of the rejected message is invalid (see section 3.4.1.2 e ).
1292 RejectReason contains the value InitiatingParty or RecipientParty. No other field is required.
1293 AdditionalInformation may contain the invalid identifier.
1294 4. The verification of the security of the rejected message fails (see section 3.4.1.2 d ).
1295 RejectReason contains the value Security. It is recommended to include the optional fields
1296 AdditionalInformation to provide the details of the security error. MessageInError contains the
1297 received message with the security error.
1298 5. The version of the protocol used for the message (Header.ProtocolVersion) is not supported by
1299 the RecipientParty which is not able to send a message response of this version to the
1300 InitiatingParty (see section 3.4.1.2 c ).
1301 RejectReason contains the value ProtocolVersion and AdditionalInformation the invalid protocol
1302 version.
1303 6. The rejected message has already been sent by the InitiatingParty to the RecipientParty. The
1304 message could not be processed a second time, and then a response could not be sent (see
1305 section 3.4.1.2 f ).
1306 RejectReason contains the value DuplicateMessage. No other field is required.
1307 AdditionalInformation may contain the invalid ExchangeIdentifier value.
1308 7. The RecipientParty is not able to process the message for lack of resources. For that reason, a
1309 message response could not be built and the message is not processed (see section 3.4.1.3 b ).
1310 RejectReason has the value UnableToProcess. AdditionalInformation contains the reason why
1311 the message could not be processed.
1312 The reaction of the InitiatingParty to an AcceptorRejection message depends on the RejectReason
1313 and the type of rejected message.
1314 As an AcceptorRejection message is related to a specific request or an advice message between two
1315 entities, an Agent never forwards an AcceptorRejection message.
1316 In the example illustrated below, an Agent forwards an AcceptorAuthorisationRequest message issued
1317 by an Acceptor to the relevant Acquirer. The Acquirer cannot process the message and issues an
1318 AcceptorRejection message instead of an AcceptorAuthorisationResponse. The Agent receives the
1319 rejection message and sends to the card acceptor the appropriate AcceptorAuthorisationResponse
1320 message with TransactionResponse.ResponseToAuthorisation.Response containing the value
1321 Declined
authorisation
message couldn¶t
be processed
Declined
1323 However, when the acquirer returns an AcceptorRejection message with RejectReason set to
1324 UnableToProcess, in case of congestion of the acquirer host, the agent must return an
1325 AcceptorRejection message with the same RejectReason.
AcceptorCompletionAdvice
completion
process
AcceptorCompletionAdvice
se
AcceptorCompletionAdviceRespon message couldn’t
be processed
AcceptorRejection
1346 The Header contains primary information required to either route the message to a specific destination
1347 (e.g. an intermediary agent) or to process the message in a specific way (e.g. retransmission, financial
1348 capture, etc.).
1357 The parties mentioned in the Header are provided with the purpose of facilitating the routing of the
1358 message. The Header is not included when applying security to the message.
1360 The Traceability information allows a RecipientParty to monitor the upstream transport and process of
1361 a message throughout its lifetime.
1362 In order to ensure an efficient traceability process end-to-end, each intermediary entity is invited to add
1363 its own Traceability information to the incoming message before sending the resulting message to the
1364 next party in the chain.
1365 The value and interest of this process depends on the actual use of this option by all intermediaries in
1366 the message exchange chain.
1367 Traceability provides useful information as regards the processing and transport time for the exchange
1368 of messages. This information can be used to carry out a global analysis of the performance of the
1369 exchanges of messages end-to-end. In case of delays in processing card payment transactions, it can
1370 also be used to identify the possible bottlenecks or problems encountered in the routing or processing
1371 of the message.
1372 This information is conditional and is not part of the secure section of the message.
1374 The Body of the message contains information related to the processing of the message by an
1375 application.
1384 Actors need to be understood in the present context as either organisations and individuals (Acquirer,
1385 Merchant, Cardholder) or objects (POI, Card).
1386 The InitiatingParty (part of the Header) and Merchant (part of the Body) may be distinct entities.
1387 The InitiatingParty may be an entity (e.g. a Processor) acting on behalf of the Merchant (or the
1388 Acquirer) to ensure the routing and processing of the message, whilst the Merchant and the Acquirer
1389 are entities involved in a commercial relationship associated with the actual provisioning of a card
1390 payment transaction to a Cardholder.
1392 Context describes the two main types of contexts associated to a card payment transaction: a sale
1393 context (SaleContext) that identifies elements related to the commercial aspects of the transaction
1394 exclusively and a payment context (PaymentContext) which provides the elements of information for
1395 the payment associated with the sale transaction.
1397 This functional block contains all the information related to a card payment for which an authorisation
1398 or another type of operation is required.
1400 The SecurityTrailer building block is conditional. It contains a message authentication code computed
1401 on the body of the message with a cryptographic key. It allows the authentication of the Initiator and
1402 protects the content of the body against any unauthorised alteration of the message.
1403
Message Item Mult. Usage
ContentType [1..1] Definition: This component identifies the type of security
used for the message (authentication).
AuthenticatedData [0..*] Definition: This component contains the Message
Authentication Code (MAC) for the message body with the
required information to check it.
1418 An intermediary agent and the acquirer must populate Traceability if a previous entity has populated it;
1419 The recipient must update Traceability when a message is received containing trace information by
1420 adding a new trace entry with TraceTimeIn set to the time the recipient received the new message and
1421 TraceDateTimeOut set to the time the recipient sent the message to the next party.
AcceptorAuthorisationRequest
AcceptorAuthorisationRequest
InitiatingParty RecipientParty
Identification: poi1 Identification: ia1 InitiatingParty RecipientParty
RelayIdentification Identification: ia2 Identification: acq1
Identification: poi1 RelayIdentification
TraceDateTimeIn: 2011:07:05T11:21:17.45+0200 Identification: poi1
TraceDateTimeOut: 2011:07:05T11:21:17.45+0200 TraceDateTimeIn: 2011:07:05T11:21:17.45+0200
TraceDateTimeOut: 2011:07:05T11:21:17.45+0200
RelayIdentification
Identification: ia2
TraceDateTimeIn: 2011:07:05T11:21:16.89+0200
TraceDateTimeOut: 2011:07:05T11:21:16.91+0200
AcceptorAuthorisationResponse
InitiatingParty RecipientParty
Identification: ia2 Identification: acq1
RelayIdentification
Identification: poi1
TraceDateTimeIn: 2011:07:05T11:21:17.45+0200
TraceDateTimeOut: 2011:07:05T11:21:17.45+0200
RelayIdentification
Identification: ia2
TraceDateTimeIn: 2011:07:05T11:21:16.89+0200
TraceDateTimeOut: 2011:07:05T11:21:16.91+0200
RelayIdentification
Identification: acq1
TraceDateTimeIn: 2011:07:05T11:21:18.25+0200
TraceDateTimeOut: 2011:07:05T11:21:19.53+0200
AcceptorAuthorisationResponse
InitiatingParty RecipientParty
Identification: poi1 Identification: ia1
RelayIdentification
Identification: poi1
TraceDateTimeIn: 2011:07:05T11:21:17.45+0200
TraceDateTimeOut: 2011:07:05T11:21:17.45+0200
RelayIdentification
Identification: ia2
TraceDateTimeIn: 2011:07:05T11:21:16.89+0200
TraceDateTimeOut: 2011:07:05T11:21:16.91+0200
RelayIdentification
Identification: acq1
TraceDateTimeIn: 2011:07:05T11:21:18.25+0200
TraceDateTimeOut: 2011:07:05T11:21:19.53+0200
RelayIdentification
Identification: ia1
TraceDateTimeIn: 2011:07:05T11:21:18.57+0200
TraceDateTimeOut: 2011:07:05T11:21:18.64+0200
1424 An Acceptor retransmits a message when no response was received to an advice message sent to an
1425 Acquirer.
1429 The purpose of retransmission is to ensure that an Acquirer has received and processed such
1430 messages. The Acceptor initiates a retransmission process if the response to an advice is not
1431 received.
1432 A repeated advice message holds an unchanged copy of the message body which was originally sent.
1433 RetransmissionCounter and CreationDateTime are the only data element which are modified in the
1434 Header for each retransmission. In particular, the ExchangeIdentification has the same value for all
1435 retransmissions of the same message. For DUKPT key management, because of the key evolution,
1436 the Acceptor may have to recompute the MAC to be able to verify the MAC of the response.
1441 The number of message retransmissions must be limited, according to the configuration of the POI.
1442 The protocol does not address potential errors that may arise when the limit of retransmissions is
1443 reached.
Acceptor Acquirer
RetransmissionCounter:0 Advice
RetransmissionCounter:0
AdviceResponse
RetransmissionCounter:1
AdviceResponse
AdviceResponse received
End of retransmissions
1445 The Acceptor stops the retransmission process upon receipt of a correct AdviceResponse message.
1446 The value of RetransmissionCounter has no impact on the acceptance of the Advice Response
1447 message.
1450 The Acceptor retransmits the advice message to the Acquirer (RetransmissionCounter set to 1).
1451 The Acceptor initiates a second retransmission of the advice message (RetransmissionCounter value
1452 of 2) before a response to the first retransmitted advice message was received from the Acquirer.
1453 The receipt of the first advice response (RetransmissionCounter value of 1) by the Acceptor stops any
1454 further retransmission of the message.
1455 The receipt of the second advice response (RetransmissionCounter value of 2) by the Acceptor is
1456 simply ignored by the same party.
Acceptor Acquirer
Advice
AdviceResponse
RetransmissionCounter:1
AdviceResponse not received,
new repetition
RetransmissionCounter:2 Advice
2nd repetition of
AdviceResponse is ignored
1462 The response to the second retransmission (RetransmissionCounter value of 2) terminates the
1463 retransmission process and the Acceptor ignores the response to the first repetition
1464 (RetransmissionCounter value of 1).
Acceptor Acquirer
Advice
AdviceResponse
RetransmissionCounter:1
AdviceResponse not received,
new repetition
RetransmissionCounter:2 Advice
RetransmissionCounter:2
2nd repetition of AdviceResponse
received, end of retransmissions AdviceResponse
1st repetition of
AdviceResponse is ignored
1467 An advice message with RetransmissionCounter set to 0 or absent means that the received message
1468 was an original one (e.g. not retransmitted).
1469 For each advice message received, the Acquirer sends back a response message to the Acceptor
1470 containing a copy of the RetransmissionCounter value.
1471 It is required for the Acquirer to send an advice response to every retransmissions of an advice.
Acceptor Acquirer
RetransmissionCounter:0 Advice
Process Advice,
send the AdviceResponse
RetransmissionCounter:0
AdviceResponse
RetransmissionCounter:1 Advice
Send the same AdviceResponse with
a copy of RetransmissionCounter
RetransmissionCounter:1
AdviceResponse
1473 Since the original advice might never reach the Acquirer (due to a problem of communication, for
1474 instance), the retransmitted message received by the Acquirer (RetransmissionCounter set to 1) has
1475 to be considered as the original one and processed as such.
Acceptor Acquirer
Advice
RetransmissionCounter:1 Advice
Process Advice,
send the AdviceResponse
RetransmissionCounter:1
AdviceResponse
RetransmissionCounter:2 Advice
Send the same AdviceResponse with
a copy of RetransmissionCounter
RetransmissionCounter:2
AdviceResponse
1477 Similarly, advice retransmissions are not necessarily received by the Acquirer in the order adopted by
1478 the Acceptor.
1541 If an optional data element that is not expected but present in the message it must be ignored, and the
1542 message is not rejected.
1543 If a data element or a data structure is not known by the receiver of the message (i.e. not present in
1544 the enclosing data structure definition), this data element is ignored (the schema validation of the XML
1545 message is not required).
1546 c) The version of the protocol used for the message (Header.ProtocolVersion) is not supported by the
1547 RecipientParty.
1556 f) The message is a duplicated message for a a given InitiatingParty and a given RecipientParty
1557 when the following fields have the same value:
1558 Header.ExchangeIdentification
1559 CreationDateTime
1560 Header.RetransmissionCounter if present.
1564 a) The type of message (Header.MessageFunction) is not supported by the RecipientParty, which is
1565 not able to process the message and send a response message to the InitiatingParty.
1566 b) The RecipientParty is not able to process the message for lack of resources (e.g. congestion of
1567 server, HSM unavailable). For that reason, a message response could not be built and the
1568 message is not processed.
1577 a) The transport connection used to send the request or advice has been released or broken, and the
1578 Acquirer is then unable to send the response messsage.
1579 b) The timer monitoring the receipt of the response message has expired before the receipt of the
1580 complete response message.
1616 The size of the value exceeds the maximum size defined in the schema.
1617 Inconsistency between data elements (e.g. Header.MessageFunction value inconsistent with
1618 the body of the message).
1619 A rule or a condition of presence defined in the section 4 is not respected (e.g.
1620 ProtectedCardData and PlainCardData both present in the AcceptorAuthorisationResponse
1621 message).
1622 A data element in a Response message (resp. AdviceResponse message) is specified as
1623 "Copy", and has not the same value as in the related Request message (resp. Advice
1624 message).
1625 If a data element or data structure is not known by the receiver of the message, this data element is
1626 ignored (the schema validation of the XML message is not required).
1636 a) The message cannot be considered as a response to the request or the advice:
1637 Message identification (Header.ExchangeIdentification, Header.InitiatingParty,
1638 Header.RecipientParty) does not have the same value as the request or the advice.
1639 If the response is not an AcceptorRejection, the message types (Header.MessageFunction or
1640 the message body) is not related to the request or the advice (e.g.
1641 MessageFunction=FinancialAuthorisationRequest in the request message and
1642 MessageFunction=AuthorisationResponse in the response message, or the message body
1643 AuthorisationRequest is in the request message and CancellationResponse in the response
1644 message).
1645 A data element specified as to be copied from the request or the advice has not the same
1646 value (e.g. Transaction.TransactionIdentification.TransactionDateTime or
1647 Transaction.TransactionIdentification.TransactionReference)
1648 b) The message received is an AcceptorRejection related to the request or the advice.
1649 c) The response message is received too late, i.e. after the expiration of the time out, or just after the
1650 transport connection release.
1652 Regardless of the root cause, the message received by the RecipientParty has already
1653 been received.
1654 See duplicate message definition below.
1655 In that case, the RejectReason is set to DuplicateMessage
1662 Following sections describe each type of error handling of the Acceptor and the
1663 conditions under which this handling has to be performed. The diagram below
1664 summarises for each error case defined in the section 3.4.1, the error handling per
1665 message the Acquirer must perform.
Acceptor
Unable to process
No response
Unacceptable unmatched response Unable to send
Unacceptable matched response
Too late response
DuplicateMessage
1 2 3 4 3
Reverse the Terminate Terminate
Retransmission Ignore
Transaction Exchange Exchange
Terminate
exchange in error
1722 Following sections describe each type of error handling of the Acquirer and the conditions
1723 under which this process has to be performed.
Acquirer
CompletionAdvice
All messages CancellationAdvice All messages
CurrencyConversion
Advice
1 2 3
Message
Retransmission Ignore
Rejection
<Hdr>
2 MessageFunction [1..1] C1 The only valid codes to request an authorisation for a
C13 normal payment are:
AuthorisationRequest: Request without financial
capture (TransactionCapture="False")
FinancialAuthorisationRequest: Request with financial
capture TransactionCapture="True")
(if an invalid value is received, a Reject message is sent
by the Recipient with RejectReason equal to
"ParsingError")
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] * The current version is 8.0 (reference list of specification
documents). version is 8.0
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] Identifier per InitiatingParty/RecipientParty and per pair
of messages used to assign a response to a request and
to identify duplicate messages.
It may be used in combination with CreationDateTime to
allow the Recipient to identify retransmissions.
It may be a cyclic counter that increments by one with
each new message, starting at 0.
<XchgId>::Number
2 CreationDateTime [1..1] Date and time of the creation of the message Time
accuracy has to be at least tenth of a second.
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] Information used to identify the initiator of an exchange.
The content is bilaterally agreed between InitiatingParty
and RecipientParty.
<InitgPty>
3 Identification [1..1] Config The value of this identifier is bilaterally agreed between
InitiatingParty and RecipientParty. The Recipient of the
message must validate without ambiguity the Initiator of
the message.
<Id>::Max35Text
3 Type [0..1] Config * Indicates the type of InitiatingParty, allowed values:
OriginatingPOI: from POI Terminal to an Intermediary
Agent or an Acquirer.
IntermediaryAgent: from an Intermediary Agent to
another Intermediary Agent or an Acquirer.
Acceptor: from a POI server performing functions of
the payment application.
<Tp>::PartyType3Code
3 Issuer [0..1] Config Indicates the assigner of the Identification value of the
InitiatingParty.
<Issr>::PartyType4Code
<RcptPty>
3 Identification [1..1] Config <Id>::Max35Text
3 Type [0..1] Config * Indicates the type of RecipientParty, allowed values:
IntermediaryAgent: from POI System or an
Intermediary Agent to an Intermediary Agent.
Acquirer: from POI System or an Intermediary Agent
to an Acquirer.
<Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] Config see section 3.2 Traceability
<Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] Config <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Config <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 AuthorisationRequest [1..1] C1 The Header.MessageFunction must be
"AuthorisationRequest" or
"FinancialAuthorisationRequest".
(In case of an invalid value, a Reject message is sent by
the Recipient with RejectReason equal to "ParsingError")
<AuthstnReq>
2 Environment [1..1] <Envt>
3 Acquirer [0..1] Config Acquirer configuration parameter defines if this
component needs to be present.
<Acqrr>
4 Identification [0..1] Config <Id>
5 Identification [1..1] Appli Identification of the Acquirer or the Intermediary Agent
determined by the application from the card and other
data used in this transaction.
<Id>::Max35Text
5 Type [0..1] Appli * default Acquirer
Allowed values: Acquirer, IntermediaryAgent
<Tp>::PartyType3Code
5 Issuer [0..1] * Allowed values: Acquirer and IntermediaryAgent
<Issr>::PartyType4Code
5 Country [0..1] Country of the Acquirer (must be ISO 3166-1 alpha-2 or
alpha-3)
<Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Name of the Acquirer or Intermediary Agent (e.g. name
of the bank or the processor)
<ShrtNm>::Max35Text
4 ParametersVersion [1..1] This value can be used by the Acquirer or the
Intermediary Agent to:
- decline the request if the configuration parameters
are obsolete,
- checks if a request to the POI to initiate an update
of its configuration parameters (populating
TMSTrigger in the response) is necessary.
This element may be filled with a configuration parameter
(DataSet.Identification.Version of the TMS data set of the
AcceptorConfigurationUpdate message)
<ParamsVrsn>::Max256Text
3 Merchant [0..1] C2 Present if it contains any data.
<Mrchnt>
4 Identification [0..1] Config <Id>
5 Identification [1..1] Appli Identification of the Merchant determined by the
application profile.
<Id>::Max35Text
5 Type [0..1] Appli * default Merchant
Allowed values: Merchant, Acceptor, IntermediaryAgent
Merchant may be used to mention the retailer
headquarters name and/or details
Acceptor is used to identify the actual POI entity
processing the transaction (e.g. a subsidiary of the
Merchant)
<Tp>::PartyType3Code
5 Issuer [0..1] Config * The party assigning the identification.
Allowed values: Acquirer and IntermediaryAgent
<Issr>::PartyType4Code
5 ShortName [0..1] Config Name of the merchant assigned by the Acquirer or
IntermediaryAgent.
<ShrtNm>::Max35Text
4 CommonName [0..1] Config Name of the merchant as appearing on the receipt.
<CmonNm>::Max70Text
4 LocationCategory [0..1] Config Code usually derived from the merchant contract.
Indicates the type of location where the transaction took
place (e.g. train, in-flight, nomadic, etc.).
Note:
for this data element MOTO corresponds to virtual
shop including electronic commerce
Fixed corresponds to physical shop
<LctnCtgy>::LocationCategory1Code
4 LocationAndContact [0..1] Config Based on CommunicationAddress
<LctnAndCtct>
<Id>
5 Identification [1..1] Appli Part of the Acquirer/IntermediaryAgent or Merchant
configuration.
<Id>::Max35Text
5 Type [0..1] * default OriginatingPOI
Allowed values: OriginatingPOI, IntermediaryAgent
<Tp>::PartyType3Code
5 Issuer [0..1] Config * Allowed values: Merchant, Acquirer and
IntermediaryAgent
<Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 SystemName [0..1] Config Allows a fast identification of the POI type by the
Acquirer to monitor the transaction.
<SysNm>::Max70Text
4 GroupIdentification [0..1] Config This identifier can be used as a way for a merchant to
group a set of POI transactions for reconciliation.
<GrpId>::Max35Text
4 Capabilities [0..1] C3 Present if it contains any data.
<Cpblties>
5 CardReadingCapabilities [0..*] Config Capabilities available to the payment application.
<CardRdngCpblties>::CardDataReading5Code
CardholderVerificationCapabilities [0..*] Config Capabilities available to the payment application.
<CrdhldrVrfctnCpblties>::CardholderVerificationCapabilit
y4Code
PINLengthCapabilities [0..1] <PINLngthCpblties>::Number
ApprovalCodeLength [0..1] <ApprvlCdLngth>::Number
MaxScriptLength [0..1] <MxScrptLngth>::Number
CardCaptureCapable [0..1] <CardCaptrCpbl>::TrueFalseIndicator
5 OnLineCapabilities [0..1] Config Indicates whether the POI authorises transactions
exclusively offline (OffLine), exclusively online (OnLine)
or only authorises online if required by the payment
application (Semi OffLine).
<OnLineCpblties>::OnLineCapability1Code
5 MessageCapabilities [0..*] <MsgCpblties>
6 Destination [1..*] <Dstn>::UserInterface4Code
6 AvailableFormat [0..*] <AvlblFrmt>::OutputFormat1Code
6 NumberOfLines [0..1] <NbOfLines>::Number
6 LineWidth [0..1] <LineWidth>::Number
6 AvailableLanguage [0..*] <AvlblLang>::LanguageCode
4 TimeZone [0..1] Time zone name as defined by IANA (Internet Assigned
Numbers Authority) in the time zone data base. America/
Chicago or Europe/Paris are examples of time zone
names.
<TmZone>::Max70Text
<TermnlIntgtn>::LocationCategory3Code
4 Component [0..*] Config / Based on PointOfInteractionComponent
Appli
Information used by the Acquirer for :
The traceability of components used for the
transaction.
Identifying the version of the component (this
information may cause the TMSTrigger to be set in
the response).
The approval of POI components.
<Cmpnt>
3 Card [0..1] Config The Acquirer configuration indicates if either
ProtectedCardData or PlainCardData is present (e.g.
TMS parameter
AcquirerProtocolParameters.ProtectCardData).
<Card>
4 ProtectedCardData [0..1] C4 Present if Card.PlainCardData absent.
Encryption of the PlainCardData component, including
the envelope, using CMS ContentType.EnvelopedData..
See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] Can be used to carry Card data encrypted by private
format not covered by nexo Standard, P2PE product for
example.
<PrvtCardData>::Max100KBinary
4 PlainCardData [0..1] C4 Present if ProtectedCardData absent.
<PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
5 CardSequenceNumber [0..1] Appli <CardSeqNb>::Min2Max3NumericText
5 EffectiveDate [0..1] Appli <FctvDt>::Max10Text
5 ExpiryDate [1..1] <XpryDt>::Max10Text
5 ServiceCode [0..1] Appli <SvcCd>::Exact3NumericText
5 Track1 [0..1] <Trck1>::Max76Text
5 Track2 [0..1] <Trck2>::Max37Text
5 Track3 [0..1] <Trck3>::Max104Text
5 CardholderName [0..1] <CrdhldrNm>::Max45Text
4 PaymentAccountReference [0..1] Unique reference to the card, used by both merchants
and acquirers to link tokenised and non-tokenised
transactions associated to the same underlying card.
<IssrBIN>::Max15NumericText
4 CardCountryCode [0..1] Appli Alphabetic with 2 or 3 characters, or numeric code
conforms to ISO 3166 – 1. Indicates the country of the
card issuer.
<CardCtryCd>::Max3Text
4 CardCurrencyCode [0..1] Currency code of the card issuer (ISO 4217 numeric
code).
<CardCcyCd>::Exact3AlphaNumericText
4 CardProductProfile [0..1] Config Defines the acceptance processing and rules performed
by the POI, after analysis of the application profile.
Assigned by the Acquirer.
<CardPdctPrfl>::Max35Text
4 CardBrand [0..1] Appli Brand name of the card or the scheme.
<CardBrnd>::Max35Text
4 CardProductType [0..1] <CardPdctTp>::CardProductType1Code
4 CardProductSubType [0..1] <CardPdctSubTp>::Max35Text
4 InternationalCard [0..1] “True” if the card may be used abroad. Else “False” for
domestic cards only.
<IntrnlCard>::TrueFalseIndicator
4 AllowedProduct [0..*] Product that can be purchased with the card. The list of
allowed products contained in some specific cards (eg.
Petrol cards)
<AllwdPdct>::Max70Text
4 ServiceOption [0..1] Options to the service provided by the card.
<SvcOptn>::Max35Text
4 AdditionalCardData [0..1] Appli Additional data taken from specific card products.
<AddtlCardData>::Max70Text
3 CustomerDevice [0..1] Device used by the customer to perform the payment
transaction
<CstmrDvc>
4 Identification [0..1] Identification of the customer device used for payment
<Id>::Max35Text
4 Type [0..1] Type of the device in free text
<Tp>::Max35Text
4 Provider [0..1] Provider of the device
<Prvdr>::Max35Text
3 Wallet [0..1] Container for tenders used by the customer to perform
the payment transaction.
<Wllt>
4 Identification [0..1] Identification of the wallet used for payment
<Id>::Max35Text
4 Type [0..1] Type of wallet in free text
<Prvdr>::Max35Text
3 PaymentToken [0..1] Based on type CardPaymentToken..
<PmtTkn>
3 Cardholder [0..1] C5 Present if it contains any data.
<Crdhldr>
4 Identification [0..1] Appli For verification of the Cardholder identity. A Cardholder
may be identified by more than one identification method.
<Id>
5 DriverLicenseNumber [0..1] <DrvrLicNb>::Max35Text
5 DriverLicenseLocation [0..1] <DrvrLicLctn>::Max35Text
5 DriverLicenseName [0..1] <DrvrLicNm>::Max35Text
5 DriverIdentification [0..1] <DrvrId>::Max35Text
5 CustomerNumber [0..1] <CstmrNb>::Max35Text
5 SocialSecurityNumber [0..1] <SclSctyNb>::Max35Text
5 AlienRegistrationNumber [0..1] <AlnRegnNb>::Max35Text
5 PassportNumber [0..1] <PsptNb>::Max35Text
5 TaxIdentificationNumber [0..1] <TaxIdNb>::Max35Text
5 IdentityCardNumber [0..1] <IdntyCardNb>::Max35Text
5 EmployerIdentificationNumber [0..1] <MplyrIdNb>::Max35Text
5 EmployeeIdentification-Number [0..1] <MplyeeIdNb>::Max35Text
5 JobNumber [0..1] <JobNb>::Max35Text
5 Department [0..1] <Dept>::Max35Text
5 EmailAddress [0..1] <EmailAdr>::Max256Text
5 DateAndPlaceOfBirth [0..1] <DtAndPlcOfBirth>
6 BirthDate [1..1] <BirthDt>::ISODate
6 ProvinceOfBirth [0..1] <PrvcOfBirth>::Max35Text
6 CityOfBirth [1..1] <CityOfBirth>::Max35Text
6 CountryOfBirth [1..1] <CtryOfBirth>::CountryCode
5 Other [0..*] <Othr>
6 Identification [1..1] <Id>::Max35Text
6 IdentificationType [1..1] <IdTp>::Max35Text
4 Name [0..1] Appli For verification of the Cardholder identity.
<Nm>::Max45Text
4 Language [0..1] Appli Advise the Acquirer of the cardholder language so that
messages to the Cardholder can be customized to that
language.
<Lang>::LanguageCode
4 BillingAddress [0..1] Based on PostalAddress22
<BllgAdr>
4 TripNumber [0..1] <TripNb>::Max35Text
4 Vehicle [0..1] <Vhcl>
5 VehicleNumber [0..1] <VhclNb>::Max35NumericText
5 TrailerNumber [0..1] <TrlrNb>::Max35NumericText
5 VehicleTag [0..1] <VhclTag>::Max35Text
5 VehicleTagEntryMode [0..1] <VhclTagNtryMd>::CardDataReading5Code
<Authntcn>
5 AuthenticationMethod [1..1] Method used to authenticate the cardholder:
<AuthntcnMtd>::AuthenticationMethod5Code
5 AuthenticationValue [0..1] C6 Present if AuthenticationMethod="SecureCertificate" or
"SecureNoCertificate".
(e.g. Visa Cardholder Authentication Verification Value
(CAVV) or Mastercard Accountholder Authentication
Value (AVV).
<AuthntcnVal>::Max5000Binary
5 ProtectedAuthenticationValue [0..1] See MDR for sub elements
<PrtctdAuthntcnVal>
5 CardholderOnLinePIN [0..1] C7 Present if AuthenticationMethod="PINOnline"
PIN verification by the Issuer during an online
authorisation.
<CrdhldrOnLinePIN>
6 EncryptedPINBlock [1..1] Transport the PIN in an encrypted form using the
EnvelopedData CMS data structure.
See MDR for sub elements
<NcrptdPINBlck>
6 PINFormat [1..1] Appli <PINFrmt>::PINFormat3Code
6 AdditionalInput [0..1] Appli Additional information required for the PIN verification,
(e.g. the driver number for some fleet cards).
<AddtlInpt>::Max35Text
5 CardholderIdentification [0..1] See MDR for sub elements
<CrdhldrId>
5 AddressVerification [0..1] C8 Present if it contains any data
For verifying the cardholder's billing address.
<AdrVrfctn>
6 AddressDigits [0..1] Appli Numerics from the cardholder's address excluding the
postal code (i.e. house number).
<AdrDgts>::Max5NumericText
6 PostalCodeDigits [0..1] Appli Numerics from the cardholder's postal code.
<PstlCdDgts>::Max5NumericText
5 AuthenticationType [0..1] Type of authentication for a given method - e.g. three-
domain authentication, scheme-proprietary
authentication, etc.
<AuthntcnTp>::Max35Text
5 AuthenticationLevel [0..1] Level of authentication for a given type – e.g. value
assigned by scheme rules or by bilateral agreements
<AuthntcnLvl>::Max35Text
5 AuthenticationResult [0..1] Result of authentication
<AuthntcnRslt>::AuthenticationResult1Code
5 AuthenticationAdditional- [0..1] Additional information related to the result of the
Information authentication
<AuthntcnAddtlInf>::Max35Text
4 TransactionVerificationResult [0..*] Result of performed verifications for the transaction.
Several methods may have been used for verification
<TxVrfctnRslt>
5 Method [1..1] Method of verification that has been performed.
<Mtd>::AuthenticationMethod6Code
5 VerificationEntity [0..1] Entity or device that has performed the verification
<VrfctnNtty>::AuthenticationEntity2Code
5 Result [0..1] Result of the verification.
<Rslt>::Verification1Code
5 AdditionalResult [0..1] Additional result of the verification
<AddtlRslt>::Max500Text
4 PersonalData [0..1] Appli Not to be used for cardholder identification or
authentication.
<PrsnlData>::Max70Text
3 ProtectedCardholderData [0..1] See MDR for sub elements
<PrtctdCrdhldrData>
2 Context [1..1] <Cntxt>
3 PaymentContext [0..1] <PmtCntxt>
4 CardPresent [0..1] C9 default True
Indicates whether the transaction has been initiated by a
card physically present or not:
Not present if CardDataEntryMode="AccountData",
Present or not if CardDataEntryMode="Physical",
Present for other values of CardDataEntryMode.
<CardPres>::TrueFalseIndicator
4 CardholderPresent [0..1] C10 default True
Indicates whether the transaction has been initiated in
presence of the cardholder or not (e.g. False for the 2nd
and subsequent payments on a recurring transaction).
<CrdhldrPres>::TrueFalseIndicator
4 OnLineContext [0..1] <OnLineCntxt>::TrueFalseIndicator
4 AttendanceContext [0..1] Config C10 If CardholderPresent is "True":
Attended: an attendant is present and performs the
financial transaction (face to face).
SemiAttended: one attendant monitors several POIs, to
offer assistance if needed.
Unattended: an attendant is not present
Otherwise the element is absent
<AttndncCntxt>::AttendanceContext1Code
4 TransactionEnvironment [0..1] default Merchant
Information required by some Acquirers or card
schemes:
Merchant: POI is located at the premises of the
merchant.
Private: remote payment, not at the premises of the
merchant
Public: POI is located in a public area, not at the
premises of the merchant.
<TxEnvt>::TransactionEnvironment1Code
4 TransactionChannel [0..1] Config Information required by some Acquirers or card schemes
for specific environments.
MailOrder: services or good purchased by mail
(written).
TelephoneOrder: services or good purchased by phone
(voice)
ElectronicCommerce: services or good purchased by
Internet (electronic)
TelevisionPayment: services or good purchased by TV
<TxChanl>::TransactionChannel5Code
4 AttendantMessageCapable [0..1] C11 default True
Indicates to the Acquirer whether a message in the
authorisation response can be displayed to the Cashier
or not.
<AttndntMsgCpbl>::TrueFalseIndicator
4 AttendantLanguage [0..1] C11 Present If AttendantMessageCapable is True
Indicates to the Acquirer in the Authorisation Response
message the language of the message to be displayed
to the Cashier.
<AttndntLang>::LanguageCode
4 CardDataEntryMode [0..1] C9 The entry mode used to get the card data, and not the
list of entry modes in case of fall-back.
.
<CardDataNtryMd>::CardDataReading6Code
4 FallbackIndicator [0..1] Appli default False
Card data entry mode fallback..
<FllbckInd>::CardFallback1Code
4 SupportedOption [0..*] Payment options the card acceptor can support.
<SpprtdOptn>::SupportedPaymentOption1Code
3 SaleContext [0..1] C12 Present if it contains any data.
Information provided by the sale system (e.g. EPAS
Retailer protocol).
<SaleCntxt>
4 SaleIdentification [0..1] Appli <SaleId>::Max35Text
<Adr>
5 AccountIdentification [0..1] <AcctId>::CashAccountIdentification7Choice
6 IBAN [1..1] <IBAN>::IBAN2007Identifier
6 BBAN [1..1] <BBAN>::BBANIdentifier
6 UPIC [1..1] <UPIC>::UPICIdentifier
6 DomesticAccount [1..1] <DmstAcct>
7 Identification [1..1] <Id>::Max35Text
4 CreditorIdentification [1..1] <CdtrId>
5 Creditor [1..1] <Cdtr>::PartyIdentification178Choice
6 AnyBIC [1..1] <AnyBIC>::AnyBICDec2014Identifier
6 ProprietaryIdentification [1..1] <PrtryId>
7 Identification [1..1] <Id>::Max35Text
7 Issuer [1..1] <Issr>::Max35Text
7 SchemeName [0..1] <SchmeNm>::Max35Text
6 NameAndAddress [1..1] <NmAndAdr>
7 Name [1..1] <Nm>::Max70Text
<Adr>
5 RegistrationIdentification [0..1] <RegnId>::Max35Text
4 MandateRelatedInformation [1..1] <MndtRltdInf>
5 MandateIdentification [1..1] <MndtId>::Max35Text
5 DateOfSignature [0..1] <DtOfSgntr>::ISODate
5 MandateImage [0..1] <MndtImg>::Max2MBBinary
2 Transaction [1..1] <Tx>
3 TransactionCapture [1..1] C13 If "True", this financial transaction must be captured for
clearing by the Acquirer.
MessageFunction value must be "AuthorisationRequest"
if TransactionCapture = "False",
"FinancialAuthorisationRequest" if TransactionCapture =
"True".
<TxCaptr>::TrueFalseIndicator
3 TransactionType [0..1] C14 <TxTp>::CardPaymentServiceType12Code
3 AdditionalService [0..*] <AddtlSvc>::CardPaymentServiceType9Code
3 ServiceAttribute [0..1] <SvcAttr>::CardPaymentServiceType3Code
3 LastTransactionFlag [0..1] <LastTxFlg>::TrueFalseIndicator
3 MerchantCategoryCode [0..1] Code assigned by the Acquirer, containing the
ISO18245-4 MCC code associated with the category of
services or goods purchased in this transaction (the
merchant can have several MCCs associated to its
business).
<MrchntCtgyCd>::Min3Max4Text
3 CustomerConsent [0..*] This enables retailers, if they so wish, to clearly indicate
whether the consent of the customer was explicitly
obtained for a given service instead of being implicitly
derived.
<CstmrCnsnt>::TrueFalseIndicator
3 CardProgrammeProposed [0..*] The card program proposed by a retailer to a cardholder
among a series of payment programmes offered by the
retailer.
<CardPrgrmmPropsd>::Max35Text
3 CardProgrammeApplied [0..1] * The card program actually selected by the cardholder
among the ones supported by the retailer and/or the one
actually proposed to him. At most one
CardProgrammeApplied should be provided.
<CardPrgrmmApld>::Max35Text
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Based on TransactionIdentifier
<TxId>
3 OriginalTransaction [0..1] Appli C15 Not used if TransactionType="CardPayment",
"DeferredPayment" or "CashBack". If
TransactionType="Refund", when available it must be
used to provide elements from the original transaction.
Not used if TransactionType="Reservation” and
ServiceAttribute=”InitialReservation”
If TransactionType="Reservation” and
ServiceAttribute=”UpdateReservation”, when available it
must be used to provide elements from the original
transaction.
Not used if TransactionType="Reservation and
<OrgnlTx>
4 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
4 TransactionIdentification [1..1] Based on TransactionIdentifier
<TxId>
4 POIIdentification [0..1] Appli <POIId>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 ShortName [0..1] Config <ShrtNm>::Max35Text
InitiatorTransactionIdentification [0..1] If present in the original transaction
<InitrTxId>::Max35Text
RecipientTransactionIdentification [0..1] If present in the original transaction
<RcptTxId>::Max35Text
4 TransactionType [1..1] <TxTp>::CardPaymentServiceType12Code
4 AdditionalService [0..*] <AddtlSvc>::CardPaymentServiceType9Code
4 ServiceAttribute [0..1] <SvcAttr>::CardPaymentServiceType3Code
4 CardDataEntryMode [0..1] <CardDataNtryMd>::CardDataReading5Code
4 TransactionResult [0..1] Appli <TxRslt>
5 AuthorisationEntity [0..1] <AuthstnNtty>
6 Identification [0..1] <Id>::Max35Text
6 Type [1..1] <Tp>::PartyType14Code
6 Issuer [0..1] Copy <Issr>::PartyType4Code
6 Country [0..1] <Ctry>::Min2Max3AlphaText
6 ShortName [0..1] Copy <ShrtNm>::Max35Text
ResponseToAuthorisation [1..1] <RspnToAuthstn>
6 Response [1..1] <Rspn>::Response4Code
6 ResponseReason [0..1] Appli <RspnRsn>::Max35Text
6 AdditionalResponse-Information [0..1] <AddtlRspnInf>::Max140Text
5 AuthorisationCode [0..1] Appli <AuthstnCd>::Min6Max8Text
3 InitiatorTransactionIdentification [0..1] Appli A value provided by the card acceptor that is meaningful
in the card acceptor’s system and that the acquirer can
use in referencing back to this transaction.
<InitrTxId>::Max35Text
3 ReconciliationIdentification [0..1] Appli Identification of the reconciliation period assigned by the
POI to the transaction.
Conforming to the configuration parameters (by the
EPAS TMS configuration parameters
ReconciliationByAcquirer and ReconciliationExchange),
absent if:
The acquirer assigns the reconciliation period, and
provides it in the response, or
There is no reconciliation exchange (e.g. capture in
batch)
<RcncltnId>::Max35Text
3 TransactionDetails [1..1] <TxDtls>
4 Currency [0..1] Appli Currency of TotalAmount and DetailedAmount if present
<TtlAmt>::ImpliedCurrencyAndAmount
4 CumulativeAmount [0..1] <CmltvAmt>::ImpliedCurrencyAndAmount
4 AmountQualifier [0..1] C14 default Actual
Allowed values depends on the TransactionType value:
"CardPayment": Actual
"DeferredPayment": Estimated or Maximum
"Reservation": Estimated, Incremental or Decremental
<AmtQlfr>::TypeOfAmount8Code
4 DetailedAmount [0..1] Appli <DtldAmt>
5 AmountGoodsAndServices [0..1] <AmtGoodsAndSvcs>::ImpliedCurrencyAndAmount
5 CashBack [0..1] <CshBck>::ImpliedCurrencyAndAmount
5 Gratuity [0..1] <Grtty>::ImpliedCurrencyAndAmount
5 Fees [0..*] <Fees>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Rebate [0..*] <Rbt>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 ValueAddedTax [0..*] <ValAddedTax>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Surcharge [0..*] <Srchrg>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
4 RequestedAmount [0..1] <ReqdAmt>::ImpliedCurrencyAndAmount
4 AuthorisedAmount [0..1] <AuthrsdAmt>::ImpliedCurrencyAndAmount
4 InvoiceAmount [0..1] <InvcAmt>::ImpliedCurrencyAndAmount
4 ValidityDate [0..1] Appli <VldtyDt>::ISODate
4 OnLineReason [0..*] Appli Indicates to the Acquirer the primary reason why the
transaction has been sent online by the Card Acceptor.
<OnLineRsn>::OnLineReason1Code
4 UnattendedLevelCategory [0..1] Appli Some card schemes may require for unattended POI
terminals that the application determines the category
level for the transaction.
The value of this data is set by the application in
compliance with the rules of the card scheme.
<UattnddLvlCtgy>::Max35NumericText
4 AccountType [0..1] Appli defaut Default
Allows a cardholder to select the type of account used for
the transaction.
<AcctTp>::CardAccountType3Code
4 CurrencyConversionResult [0..1] <CcyConvsRslt>
5 AcceptedByCardholder [0..1] <AccptdByCrdhldr>::TrueFalseIndicator
5 Conversion [0..1] <Convs>
6 CurrencyConversion-Identification [0..1] <CcyConvsId>::Max35Text
6 TargetCurrency [1..1] <TrgtCcy>
7 AlphaCode [1..1] <AlphaCd>::ActiveCurrencyCode
<ActlAmt>::ImpliedCurrencyAndAmount
7 MinimumAmount [0..1] Minimum amount for conversion (in case of range of
amounts)
<MinAmt>::ImpliedCurrencyAndAmount
7 MaximumAmount [0..1] Maximum amount for conversion (in case of range of
amounts)
<MaxAmt>::ImpliedCurrencyAndAmount
6 CommissionDetails [0..*] <ComssnDtls>
7 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
7 AdditionalInformation [0..1] <AddtlInf>::Max350Text
6 MarkUpDetails [0..*] <MrkUpDtls>
7 Rate [1..1] <Rate>::PercentageRate
7 AdditionalInformation [0..1] <AddtlInf>::Max350Text
6 DeclarationDetails [0..1] <DclrtnDtls>
7 Format [0..1] <Frmt>::OutputFormat1Code
7 MessageContent [1..1] <MsgCntt>::Max20000Text
4 Instalment [0..1] Appli <Instlmt>
<ICCRltdData>::Max10000Binary
3 MerchantReferenceData [0..1] <MrchntRefData>::Max70Text
3 AccountFrom [0..1] <AcctFr>
4 SelectionMethod [0..1] <SelctnMtd>::AccountChoiceMethod1Code
4 SelectedAccountType [0..1] <SelctdAcctTp>::CardAccountType3Code
4 AccountName [0..1] <AcctNm>::Max70Text
4 AccountOwner [0..1] <AcctOwnr>
5 Name [1..1] <Nm>::Max70Text
5 Address [1..1] Based on PostalAddress1
<Adr>
4 Currency [0..1] <Ccy>::ActiveCurrencyCode
4 AccountIdentifier [0..1] <AcctIdr>::AccountIdentification39Choice
5 Card [1..1] <Card>::Min8Max28NumericText
5 MSISDN [1..1] <MSISDN>::Max16Text
5 EMail [1..1] <EMail>::Max256Text
5 IBAN [1..1] <IBAN>::IBANIdentifier
5 BBAN [1..1] <BBAN>::BBANIdentifier
5 UPIC [1..1] <UPIC>::UPICIdentifier
<SctyTrlr>
“FinancialAuthorisationRequest”
C2 If AuthorisationRequest.Environment.Merch
AuthorisationRequest.Environment.Merchant ant
is present it must have at least one child
C3 If AuthorisationRequest.Environment.POI.Ca
AuthorisationRequest.Environment.POI.Capabi pabilities
lities is present it must have at least one child
C4 Either AuthorisationRequest.Environment.Card.P
AuthorisationRequest.Environment.Card.Prote rotectedCardData
ctedCardData or AuthorisationRequest.Environment.Card.P
AuthorisationRequest.Environment.Card.Plain lainCardData
CardData must be present.
C5 If AuthorisationRequest.Environment.Cardh
AuthorisationRequest.Environment.Cardholde older
r is present it must have at least one child
C6 AuthenticationValue must be present if AuthorisationRequest.Environment.Cardh
AuthenticationMethod is "SecureCertificate" older.
or "SecureNoCertificate". Authentication.AuthenticationMethod
AuthorisationRequest.Environment.Cardh
older. Authentication.AuthenticationValue
C7 CardholderOnlinePIN must be present if AuthorisationRequest.Environment.Cardh
AuthenticationMethod is "PINOnline". older.Authentication.AuthenticationMetho
d
AuthorisationRequest.Environment.Cardh
older.
Authentication.CardholderOnlinePIN
C8 If AddressVerification is present it must have AuthorisationRequest.Environment.Cardh
at least one child older. Authentication. AddressVerification
C9 CardPresent must be absent if AuthorisationRequest.Context.PaymentCo
CardDataEntryMode="AccountData", ntext.CardPresent
CardPresent must be present if AuthorisationRequest.Context.PaymentCo
CardDataEntryMode has any other value than ntext.CardDataEntryMode
"AccountData" and "Physical"
C10 AttendanceContext must present only if AuthorisationRequest.Context.Attendance
CardholderPresent is "True" and has value Context
“Attended”, “SemiAttended” or “Unattended” AuthorisationRequest.Context.Cardholder
Present
C11 AttendantLanguage must be present If AuthorisationRequest.Context.
AttendantMessageCapable is “True” AttendantLanguage
AuthorisationRequest.Context.
AttendantMessageCapable
C12 If SaleContext is present it must have at least AuthorisationRequest.Context.SaleContex
one child t
C13 MessageFunction value must be Header.MessageFunction
"AuthorisationRequest" if TransactionCapture AuthorisationRequest.Transaction.Transa
= "False", "FinancialAuthorisationRequest" if ctionCapture
TransactionCapture = "True".
C14 If TransactionType value is "CardPayment" or AuthorisationRequest.Transaction.Transa
“Refund” then AmountQualifier value must ctionType
be “Actual” or absent. If TransactionType AuthorisationRequest.Transaction.Transa
value is "DeferredPayment" then ctionDetails.AmountQualifier
AmountQualifier value must be either
“Estimated” or “Maximum”.
If TransactionType value is "Reservation"
then AmountQualifier value must be either
“Estimated”, “Incremental” or “Decremental”
C15 Not used if TransactionType="CardPayment", AuthorisationRequest.Transaction.Transa
"DeferredPayment" or "CashBack". If ctionType
TransactionType="Refund", when available it AuthorisationRequest.Transaction.Origina
must be used to provide elements from the lTransaction
original transaction.
Not used if TransactionType="Reservation”
and ServiceAttribute=”InitialReservation”
If TransactionType="Reservation” and
ServiceAttribute=”UpdateReservation”, when
available it must be used to provide elements
from the original transaction.
Not used if TransactionType="Reservation
and ServiceAttribute=”“AdditionalPayment”
<Hdr>
2 MessageFunction [1..1] C1 The only valid codes in a normal payment response are:
AuthorisationResponse: Response for
AuthorisationRequest
FinancialAuthorisationResponse: Response for
FinancialAuthorisationRequest
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] Copy The Recipient Party has to adapt the
AcceptorAuthorisationResponse format to the version of
the Initiator sent in the AuthroisationRequest. If this
version is not supported the Recipient must reject the
request.with RejectReason = ProtocolVersion.
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] Copy <XchgId>::Number
2 CreationDateTime [1..1] Date and time of the creation of the message response.
Time accuracy has to be at least tenth of a second.
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] Copy <InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
2 RecipientParty [0..1] Copy <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] Present and completed if present in the request.
see section 3.2 Traceability
<Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] Copy <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 AuthorisationResponse [1..1] C1 The Header.MessageFunction must be
<AuthstnRspn>
2 Environment [1..1] <Envt>
3 AcquirerIdentification [0..1] Appli If the identification is present in the request:
It must be present in the response, but it may be
different.
If the identification is absent in the request:
It may be absent in the response (if the POI does not
need it for capture, reconciliation, reporting, etc)
It may be present in the response (if the choice is not
made by the POI, and the POI needs it)
<AcqrrId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Acquirer
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 MerchantIdentification [0..1] If the identification is present in the request:
It must be present in the response, but it may be
different from the request.
If the identification is absent in the request:
It may be absent in the response (if the POI don’t
need it for capture, reconciliation, report, etc)
<MrchntId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Merchant
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 POIIdentification [0..1] Appli May be different from the request.
<POIId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 Card [0..1] <Card>
4 ProtectedCardData [0..1] Appli - - Encryption of the PlainCardData component,
including the envelope, using CMS
ContentType.EnvelopedData.
Present if:
- - the protection of sensitive card data is
required (TMS parameter
ProtectedCardData equal to True) and
- - the validation of card data by the acceptor is
required. These card data could be a
subset of those in the reques
See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
<PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
5 CardSequenceNumber [0..1] <CardSeqNb>::Min2Max3NumericText
5 EffectiveDate [0..1] <FctvDt>::Max10Text
5 ExpiryDate [1..1] <XpryDt>::Max10Text
5 ServiceCode [0..1] <SvcCd>::Exact3NumericText
5 Track1 [0..1] <Trck1>::Max76Text
5 Track2 [0..1] <Trck2>::Max37Text
5 Track3 [0..1] <Trck3>::Max104Text
5 CardholderName [0..1] <CrdhldrNm>::Max45Text
4 PaymentAccountReference [0..1] <PmtAcctRef>::Max70Text
4 MaskedPAN [0..1] <MskdPAN>::Max30Text
4 IssuerBIN [0..1] <IssrBIN>::Max15NumericText
4 CardCountryCode [0..1] <CardCtryCd>::Max3Text
4 CardCurrencyCode [0..1] <CardCcyCd>::Exact3AlphaNumericText
4 CardProductProfile [0..1] <CardPdctPrfl>::Max35Text
4 CardBrand [0..1] <CardBrnd>::Max35Text
4 CardProductType [0..1] <CardPdctTp>::CardProductType1Code
4 CardProductSubType [0..1] <CardPdctSubTp>::Max35Text
4 InternationalCard [0..1] <IntrnlCard>::TrueFalseIndicator
4 AllowedProduct [0..*] <AllwdPdct>::Max70Text
4 ServiceOption [0..1] <SvcOptn>::Max35Text
4 AdditionalCardData [0..1] <AddtlCardData>::Max70Text
3 PaymentToken [0..1] Based on type CardPaymentToken..
<PmtTkn>
2 Transaction [1..1] <Tx>
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Copy Based on TransactionIdentifier
For verification.
<TxId>
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] Appli Used by the InitiatingParty when it refers back to the
transaction of the RecipientParty (e.g. reconciliation
mismatch). If supplied, it is mandatory in the completion
and the batch.
<RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] Copy or Conforming to the configuration parameters
Appli ReconciliationByAcquirer and ReconciliationExchange.
Present if:
The acquirer copies the value of the request assigned
by the acceptor.
The acquirer assigns the reconciliation period, and
provides it in the response.
<RcncltnId>::Max35Text
3 InterchangeData [0..1] Appli Data received from a card scheme message and
required by the card scheme to be sent in the financial
capture.
<IntrchngData>::Max140Text
3 TransactionDetails [1..1] <TxDtls>
4 Currency [0..1] Copy <Ccy>::ActiveCurrencyCode
4 TotalAmount [1..1] If the Response is PartialApproved, the TotalAmount (ie
the amount authorised) must be different from the
amount requested; otherwise it must be the same as in
the request message. PartialApproved may be in case of
payment with cashback, where only the payment part is
approved or may be for prepaid card, where approved
amount is the remaining balance.
<TtlAmt>::ImpliedCurrencyAndAmount
4 CumulativeAmount [0..1] <CmltvAmt>::ImpliedCurrencyAndAmount
4 AmountQualifier [0..1] <AmtQlfr>::TypeOfAmount8Code
4 DetailedAmount [0..1] Appli <DtldAmt>
5 AmountGoodsAndServices [0..1] <AmtGoodsAndSvcs>::ImpliedCurrencyAndAmount
5 CashBack [0..1] <CshBck>::ImpliedCurrencyAndAmount
5 Gratuity [0..1] <Grtty>::ImpliedCurrencyAndAmount
5 Fees [0..*] <Fees>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Rebate [0..*] <Rbt>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 ValueAddedTax [0..*] <ValAddedTax>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Surcharge [0..*] <Srchrg>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
4 RequestedAmount [0..1] <ReqdAmt>::ImpliedCurrencyAndAmount
4 AuthorisedAmount [0..1] <AuthrsdAmt>::ImpliedCurrencyAndAmount
4 InvoiceAmount [0..1] <InvcAmt>::ImpliedCurrencyAndAmount
4 ValidityDate [0..1] Appli <VldtyDt>::ISODate
4 OnLineReason [0..*] <OnLineRsn>::OnLineReason1Code
4 UnattendedLevelCategory [0..1] <UattnddLvlCtgy>::Max35NumericText
4 AccountType [0..1] Appli If present in the request this field must contain a copy of
the request value.
If not present in the request, it may inform the cardholder
about the account used for the transaction.
<AcctTp>::CardAccountType3Code
4 CurrencyConversionResult [0..1] <CcyConvsRslt>
5 AcceptedByCardholder [0..1] <AccptdByCrdhldr>::TrueFalseIndicator
5 Conversion [0..1] <Convs>
6 CurrencyConversionIdentification [0..1] <CcyConvsId>::Max35Text
6 TargetCurrency [1..1] <TrgtCcy>
7 AlphaCode [1..1] <AlphaCd>::ActiveCurrencyCode
7 NumericCode [1..1] <NmrcCd>::Exact3NumericText
<ICCRltdData>::Max10000Binary
3 MerchantReferenceData [0..1] <MrchntRefData>::Max70Text
2 TransactionResponse [1..1] <TxRspn>
3 AuthorisationResult [1..1] <AuthstnRslt>
4 AuthorisationEntity [0..1] Identifies the entity which initially sets the Response
value (approves, declines, or generates a "technical
error" ).
<AuthstnNtty>
5 Identification [0..1] <Id>::Max35Text
5 Type [1..1] Intermediary Agent, Acquirer: conforming to the rules of
the card scheme, the Acquirer authorises the transaction
(e.g. because a stand-in process, or declined because of
technical problem).
CardIssuer: the standard case.
DelegateIssuer: for this transaction, the Issuer delegated
the authorising right to another entity, for some reason.
<Tp>::PartyType14Code
5 Issuer [0..1] Appli <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Appli <ShrtNm>::Max35Text
4 ResponseToAuthorisation [1..1] <RspnToAuthstn>
5 Response [1..1] C6 Declined: authorisation is declined or the requested
capture is not performed.
Approved: authorisation is approved for the full amount
requested, including capture if requested
PartialApproved: same as Approved, with TotalAmount
lower in the response than in the request.
<Rspn>::Response4Code
5 ResponseReason [0..1] Appli Additional information related to the response.
<RspnRsn>::Max35Text
5 AdditionalResponse-Information [0..1] <AddtlRspnInf>::Max140Text
4 AuthorisationCode [0..1] Appli This code proves the approval delivered by the
authorising entity (e.g. ISO 8583 - Elem. 38 - approval
code).
<AuthstnCd>::Min6Max8Text
4 CompletionRequired [0..1] If the flag has the value "True", an
AcceptorCompletionAdvice has to be sent after the end
of the transaction (see Table 2 : List of Payment Cases
for the details)
<CmpltnReqrd>::TrueFalseIndicator
4 TMSTrigger [0..1] Appli Present when the POI needs maintenance. The POI may
require maintenance prior to the execution of a specific
service.
<TMSTrggr>
5 TMSContactLevel [1..1] * Allowed values:
C3 Critical: TMS to be contacted before the next
transaction
ASAP: TMS to be contacted as soon as possible (e.g.
after reconciliation)
DateTime: TMS to be contacted at the date and time
provided in TMSContactDateTime
<TMSCtctLvl>::TMSContactLevel1Code
5 TMSIdentification [0..1] Appli * Must be present if TMSTrigger is not empty
<TMSId>::Max35Text
5 TMSContactDateTime [0..1] C3 Present if TMSContactLevel = DateTime
<TMSCtctDtTm>::ISODateTime
3 TransactionVerificationResult [0..*] Present if data structure is not empty
<TxVrfctnRslt>
4 Method [1..1] <Mtd>::AuthenticationMethod6Code
4 VerificationEntity [0..1] <VrfctnNtty>::AuthenticationEntity2Code
4 Result [0..1] <Rslt>::Verification1Code
4 AdditionalResult [0..1] <AddtlRslt>::Max500Text
3 AllowedProductCode [0..*] <AllwdPdctCd>
4 ProductCode [1..1] <PdctCd>::Max70Text
4 AdditionalProductCode [0..1] <AddtlPdctCd>::Max70Text
3 NotAllowedProductCode [0..*] <NotAllwdPdctCd>
4 ProductCode [1..1] <PdctCd>::Max70Text
4 AdditionalProductCode [0..1] <AddtlPdctCd>::Max70Text
3 AdditionalAvailableProduct [0..*] <AddtlAvlblPdct>
4 ProductCode [1..1] <PdctCd>::Max70Text
4 AdditionalProductCode [0..1] <AddtlPdctCd>::Max70Text
4 AmountLimit [0..1] <AmtLmt>::ImpliedCurrencyAndAmount
4 QuantityLimit [0..1] <QtyLmt>::DecimalNumber
4 UnitOfMeasure [0..1] <UnitOfMeasr>::UnitOfMeasure6Code
3 Balance [0..1] Appli <Bal>
3 ProtectedBalance [0..1] See MDR for sub elements
<PrtctdBal>
3 Action [0..*] Appli Several combinations of actions may be sent in the
response (e.g. CaptureCard plus a display message for
<Actn>
4 ActionType [1..1] C5 Additional actions to complete the transaction:
C6 DisplayMessage: Display a message.
PrintMessage: Print a message.
One of the following actions may be sent, if the
Response is “Declined”:
Busy: Server busy. Try later.
CaptureCard: Capture card.
ForbidOverride: Payment application cannot offer to
the merchant the possibility to override the
transaction.
IDRequired: Additional identification required
(passport, ID card, etc.).
PINRetry: PIN verification retry.
PINLastTry: Last PIN try.
Referral: Referral with a voice authorisation has to be
performed.
RequestData: Request additional data through a
displayed text and request confirmation by
attendant.
<ActnTp>::ActionType7Code
4 MessageToPresent [0..1] C5 if ActionType is DisplayMessage or PrintMessage
<MsgToPres>
5 MessageDestination [1..1] <MsgDstn>::UserInterface4Code
5 Format [0..1] <Frmt>::OutputFormat1Code
5 MessageContent [1..1] <MsgCntt>::Max20000Text
MessageContentSignature [0..1] Appli <MsgCnttSgntr>::Max140Binary
CurrencyConversionEligibility [0..1] <CcyConvsElgblty>
CurrencyConversion-Identification [0..1] <CcyConvsId>::Max35Text
TargetCurrency [1..1] <TrgtCcy>
AlphaCode [1..1] <AlphaCd>::ActiveCurrencyCode
NumericCode [1..1] <NmrcCd>::Exact3NumericText
Decimal [1..1] <Dcml>::Number
Name [0..1] <Nm>::Max35Text
ResultingAmount [1..1] <RsltgAmt>::ImpliedCurrencyAndAmount
ExchangeRate [1..1] <XchgRate>::PercentageRate
InvertedExchangeRate [0..1] <NvrtdXchgRate>::PercentageRate
QuotationDate [0..1] <QtnDt>::ISODateTime
ValidUntil [0..1] <VldUntil>::ISODateTime
SourceCurrency [1..1] <SrcCcy>
AlphaCode [0..1] <AlphaCd>::ActiveCurrencyCode
NumericCode [0..1] <NmrcCd>::Exact3NumericText
Decimal [0..1] <Dcml>::Number
Name [0..1] <Nm>::Max35Text
OriginalAmount [1..1] <OrgnlAmt>
ActualAmount [0..1] Actual amount to be converted
<ActlAmt>::ImpliedCurrencyAndAmount
MinimumAmount [0..1] Minimum amount for conversion (in case of range of
amounts)
<MaxAmt>::ImpliedCurrencyAndAmount
CommissionDetails [0..*] <ComssnDtls>
Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
AdditionalInformation [0..1] <AddtlInf>::Max350Text
MarkUpDetails [0..*] <MrkUpDtls>
Rate [1..1] <Rate>::PercentageRate
AdditionalInformation [0..1] <AddtlInf>::Max350Text
DeclarationDetails [0..1] <DclrtnDtls>
Format [0..1] <Frmt>::OutputFormat1Code
MessageContent [1..1] <MsgCntt>::Max20000Text
SupplementaryData [0..*] See MDR for sub elements
<SplmtryData>
1 SecurityTrailer [0..1] CMS data structure ContentInfoType with the
AuthenticatedData alternative, containing the MAC of the
message body AuthorisationResponse including the
body envelope (see chapter ).
See MDR for sub elements
<SctyTrlr>
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] * see AcceptorAuthorisationRequest
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] see AcceptorAuthorisationRequest
<XchgId>::Number
2 ReTransmissionCounter [0..1] default 0
see 3.3 Message Retransmission
<ReTrnsmssnCntr>::Max3NumericText
2 CreationDateTime [1..1] see AcceptorAuthorisationRequest
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] see AcceptorAuthorisationRequest
<InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
2 RecipientParty [0..1] Config see AcceptorAuthorisationRequest
<RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<CmpltnAdvc>
2 Environment [1..1] <Envt>
3 Acquirer [0..1] Config If Acquirer identification has been sent in the
Authorisation response, this value has to be used in
CompletionAdvice.
<Acqrr>
4 Identification [0..1] <Id>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] * default Acquirer
see AcceptorAuthorisationRequest
<Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] <ShrtNm>::Max35Text
4 ParametersVersion [1..1] CCopy For online authorisation, the value has to be the same as
that in the Authorisation.
<ParamsVrsn>::Max256Text
3 Merchant [0..1] CCopy Conditional copy for online transactions.
Configurable for offline transactions.
<Mrchnt>
4 Identification [0..1] <Id>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] default Merchant
<Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 ShortName [0..1] <ShrtNm>::Max35Text
4 CommonName [0..1] <CmonNm>::Max70Text
4 LocationCategory [0..1] Allowed values Fixed, Aboard, Nomadic and Home
<LctnCtgy>::LocationCategory1Code
4 LocationAndContact [0..1] Config Based on CommunicationAddress
<LctnAndCtct>
<POI>
4 Identification [1..1] Copy from AcceptorAuthorisationResponse if any.
<Id>
5 Identification [1..1] Identification of a POI terminal or system.
<Id>::Max35Text
5 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] <ShrtNm>::Max35Text
4 SystemName [0..1] <SysNm>::Max70Text
4 GroupIdentification [0..1] <GrpId>::Max35Text
4 Capabilities [0..1] <Cpblties>
CardReadingCapabilities [0..*] <CardRdngCpblties>::CardDataReading5Code
CardholderVerificationCapabilities [0..*] <CrdhldrVrfctnCpblties>::CardholderVerificationCapabilit
y4Code
PINLengthCapabilities [0..1] <PINLngthCpblties>::Number
ApprovalCodeLength [0..1] <ApprvlCdLngth>::Number
MaxScriptLength [0..1] <MxScrptLngth>::Number
CardCaptureCapable [0..1] <CardCaptrCpbl>::TrueFalseIndicator
5 OnLineCapabilities [0..1] <OnLineCpblties>::OnLineCapability1Code
5 MessageCapabilities [0..*] <MsgCpblties>
6 Destination [1..*] <Dstn>::UserInterface4Code
6 AvailableFormat [0..*] <AvlblFrmt>::OutputFormat1Code
6 NumberOfLines [0..1] <NbOfLines>::Number
6 LineWidth [0..1] <LineWidth>::Number
6 AvailableLanguage [0..*] <AvlblLang>::LanguageCode
4 TimeZone [0..1] <TmZone>::Max70Text
4 TerminalIntegration [0..1] <TermnlIntgtn>::LocationCategory3Code
4 Component [0..*] Based on PointOfInteractionComponent
see AcceptorAuthorisationRequest
<Cmpnt>
3 Card [0..1] <Card>
4 ProtectedCardData [0..1] Only present if requested by the Acquirer configuration
(e.g. TMS parameter CardDataVerification is “True” and
ProtectCardData is “True”) or
AcceptorAuthorisationResponse was not received.
See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
4 PlainCardData [0..1] Only present if requested by the Acquirer configuration
(e.g. TMS parameter CardDataVerification is “True” and
ProtectCardData is “False”) or
AcceptorAuthorisationResponse was not received.
<PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
<CardCtryCd>::Max3Text
4 CardCurrencyCode [0..1] <CardCcyCd>::Exact3AlphaNumericText
4 CardProductProfile [0..1] Config see AcceptorAuthorisationRequest
<CardPdctPrfl>::Max35Text
4 CardBrand [0..1] Appli see AcceptorAuthorisationRequest
<CardBrnd>::Max35Text
4 CardProductType [0..1] <CardPdctTp>::CardProductType1Code
4 CardProductSubType [0..1] <CardPdctSubTp>::Max35Text
4 InternationalCard [0..1] <IntrnlCard>::TrueFalseIndicator
4 AllowedProduct [0..*] <AllwdPdct>::Max70Text
4 ServiceOption [0..1] <SvcOptn>::Max35Text
4 AdditionalCardData [0..1] <AddtlCardData>::Max70Text
3 CustomerDevice [0..1] <CstmrDvc>
4 Identification [0..1] <Id>::Max35Text
4 Type [0..1] <Tp>::Max35Text
4 Provider [0..1] <Prvdr>::Max35Text
3 Wallet [0..1] <Wllt>
4 Identification [0..1] <Id>::Max35Text
4 Type [0..1] <Tp>::Max35Text
4 Provider [0..1] <Prvdr>::Max35Text
3 PaymentToken [0..1] Based on type CardPaymentToken..
<PmtTkn>
<Crdhldr>
4 Identification [0..1] <Id>
5 DriverLicenseNumber [0..1] <DrvrLicNb>::Max35Text
5 DriverLicenseLocation [0..1] <DrvrLicLctn>::Max35Text
5 DriverLicenseName [0..1] <DrvrLicNm>::Max35Text
5 DriverIdentification [0..1] <DrvrId>::Max35Text
5 CustomerNumber [0..1] <CstmrNb>::Max35Text
5 SocialSecurityNumber [0..1] <SclSctyNb>::Max35Text
5 AlienRegistrationNumber [0..1] <AlnRegnNb>::Max35Text
5 PassportNumber [0..1] <PsptNb>::Max35Text
5 TaxIdentificationNumber [0..1] <TaxIdNb>::Max35Text
<BllgAdr>
4 ShippingAddress [0..1] Based on PostalAddress22
<ShppgAdr>
4 TripNumber [0..1] <TripNb>::Max35Text
4 Vehicle [0..1] <Vhcl>
5 VehicleNumber [0..1] <VhclNb>::Max35NumericText
5 TrailerNumber [0..1] <TrlrNb>::Max35NumericText
5 VehicleTag [0..1] <VhclTag>::Max35Text
5 VehicleTagEntryMode [0..1] <VhclTagNtryMd>::CardDataReading5Code
5 UnitNumber [0..1] <UnitNb>::Max35NumericText
5 ReplacementCar [0..1] <RplcmntCar>::TrueFalseIndicator
5 Odometer [0..1] <Odmtr>::DecimalNumber
5 Hubometer [0..1] <Hbmtr>::DecimalNumber
5 TrailerHours [0..1] <TrlrHrs>::Max35Text
5 ReferHours [0..1] <RefrHrs>::Max35Text
5 MaintenanceIdentification [0..1] <MntncId>::Max35Text
5 DriverOrVehicleCard [0..1] <DrvrOrVhclCard>
6 PAN [0..1] <PAN>::Min8Max28NumericText
6 Track1 [0..1] <Trck1>::Max76Text
6 Track2 [0..1] <Trck2>::Max37Text
6 Track3 [0..1] <Trck3>::Max104Text
6 AdditionalCardData [0..*] <AddtlCardData>::Max35Text
6 EntryMode [0..1] <NtryMd>::CardDataReading5Code
5 AdditionalVehicleData [0..*] <AddtlVhclData>
6 Type [0..1] <Tp>::Max35Text
6 EntryMode [0..1] <NtryMd>::CardDataReading5Code
6 Data [1..1] <Data>::Max35Text
4 Authentication [0..*] <Authntcn>
5 AuthenticationMethod [1..1] <AuthntcnMtd>::AuthenticationMethod5Code
<CardPres>::TrueFalseIndicator
4 CardholderPresent [0..1] default True
see AcceptorAuthorisationRequest
<CrdhldrPres>::TrueFalseIndicator
4 OnLineContext [0..1] default True
The flag is set to “False” if the authorisation was offline
without the need of sending an
AcceptorAuthorisationRequest during the transaction.
<OnLineCntxt>::TrueFalseIndicator
4 AttendanceContext [0..1] default Attended
see AcceptorAuthorisationRequest
<AttndncCntxt>::AttendanceContext1Code
4 TransactionEnvironment [0..1] default Merchant
see AcceptorAuthorisationRequest
<TxEnvt>::TransactionEnvironment1Code
4 TransactionChannel [0..1] Config see AcceptorAuthorisationRequest
<TxChanl>::TransactionChannel5Code
4 AttendantMessageCapable [0..1] <AttndntMsgCpbl>::TrueFalseIndicator
4 AttendantLanguage [0..1] <AttndntLang>::LanguageCode
4 CardDataEntryMode [0..1] see AcceptorAuthorisationRequest
<CardDataNtryMd>::CardDataReading6Code
4 FallbackIndicator [0..1] Appli default False
see AcceptorAuthorisationRequest
<FllbckInd>::CardFallback1Code
4 SupportedOption [0..*] <SpprtdOptn>::SupportedPaymentOption1Code
3 SaleContext [0..1] C4 Present if it contains any data.
see AcceptorAuthorisationRequest
<SaleCntxt>
4 SaleIdentification [0..1] Appli <SaleId>::Max35Text
4 SaleReferenceNumber [0..1] Appli <SaleRefNb>::Max35Text
SaleReconciliationIdentification [0..1] Appli <SaleRcncltnId>::Max35Text
4 CashierIdentification [0..1] Appli <CshrId>::Max35Text
4 CashierLanguage [0..*] <CshrLang>::LanguageCode
4 ShiftNumber [0..1] Appli <ShftNb>::Max2NumericText
4 CustomerOrderRequestFlag [0..1] <CstmrOrdrReqFlg>::TrueFalseIndicator
4 PurchaseOrderNumber [0..1] <PurchsOrdrNb>::Max35Text
4 InvoiceNumber [0..1] <InvcNb>::Max35Text
4 DeliveryNoteNumber [0..1] <DlvryNoteNb>::Max35Text
4 SponsoredMerchant [0..*] <SpnsrdMrchnt>
5 CommonName [1..1] <CmonNm>::Max70Text
5 Address [0..1] <Adr>::Max140Text
5 CountryCode [1..1] <CtryCd>::ISO3NumericCountryCode
5 MerchantCategoryCode [1..1] <MrchntCtgyCd>::Min3Max4Text
5 RegisteredIdentifier [1..1] <RegdIdr>::Max35Text
4 SplitPayment [0..1] <SpltPmt>::TrueFalseIndicator
4 RemainingAmount [0..1] <RmngAmt>::ImpliedCurrencyAndAmount
<TxCaptr>::TrueFalseIndicator
3 TransactionType [0..1] <TxTp>::CardPaymentServiceType12Code
3 AdditionalService [0..*] VoiceAuthorisation if transaction approved by phone
after Referral as ActionType in the declined authorisation
<AddtlSvc>::CardPaymentServiceType9Code
3 ServiceAttribute [0..1] <SvcAttr>::CardPaymentServiceType3Code
3 LastTransactionFlag [0..1] <LastTxFlg>::TrueFalseIndicator
3 MerchantCategoryCode [0..1] see AcceptorAuthorisationRequest
<MrchntCtgyCd>::Min3Max4Text
3 CustomerConsent [0..*] This enables retailers, if they so wish, to clearly indicate
whether the consent of the customer was explicitly
obtained for a given service instead of being implicitly
derived.
<CstmrCnsnt>::TrueFalseIndicator
3 CardProgrammeProposed [0..*] The card program proposed by a retailer to a cardholder
among a series of payment programmes offered by the
retailer.
<CardPrgrmmPropsd>::Max35Text
3 CardProgrammeApplied [0..1] * The card program actually selected by the cardholder
among the ones supported by the retailer and/or the one
actually proposed to him. At most one
CardProgrammeApplied should be provided.
<CardPrgrmmApld>::Max35Text
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] CCopy Based on TransactionIdentifier
<TxId>
3 OriginalTransaction [0..1] Appli <OrgnlTx>
4 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
4 TransactionIdentification [1..1] Based on TransactionIdentifier
<TxId>
4 POIIdentification [0..1] <POIId>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
<TxSucss>::TrueFalseIndicator
3 Reversal [0..1] default False
If True, a reversal of the online authorisation is requested
(see section 5).
<Rvsl>::TrueFalseIndicator
3 MerchantOverride [0..1] Appli default False
True if the acceptor has forced the transaction to be
successful (see section 5).
<MrchntOvrrd>::TrueFalseIndicator
3 FailureReason [0..*] Appli. C6 Mandatory if TransactionSuccess is False, or Reversal is
True or MerchantOverride is True (see section 5).
CardDeclined: Integrated circuit card declines the
transaction after the authorisation.
CustomerCancel: Customer cancellation, for example
removing the chip card after sending the
AcceptorAuthorisationRequest, but before the end of
the transaction.
Malfunction: Suspected malfunction (e.g. card reader
defect, printer out of order).
OfflineDeclined: Offline authorisation declined the
transaction.
OnLineDeclined: Online authorisation declined the
transaction.
SuspectedFraud: Card payment transaction failed
because the merchant suspected a fraud.
TimeOut: Timeout waiting for response from the
acquirer, or no response was received (for example
connection release before receiving the response).
TooLateResponse: Response to the authorisation
received too late.
UnableToComplete: Card acceptor device unable to
complete transaction after the authorisation response
(e.g. written signature invalid).
<FailrRsn>::FailureReason3Code
3 InitiatorTransactionIdentification [0..1] Appli Copy from AuthorisationRequest if any.
<InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] Appli Copy from AuthorisationResponse if any.
<RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] Appli For online transactions:
If the transaction is captured during the
authorisation or by batch, copy from
AuthorisationRequest.
If the transaction is captured by the Completion,
identification of the reconciliation period. The value
may be different from the
AcceptorAuthorisationRequest.
see AcceptorAuthorisationRequest for offline
transactions.
<RcncltnId>::Max35Text
3 InterchangeData [0..1] Appli Copy from AuthorisationResponse if any.
<IntrchngData>::Max140Text
3 TransactionDetails [1..1] <TxDtls>
4 Currency [0..1] <Ccy>::ActiveCurrencyCode
4 TotalAmount [1..1] Final amount of the payment transaction when
TransactionSuccess is "True".
If TransactionSuccess is "False":
the amount of AuthorisationResponse for an online
approval,
the amount of AuthorisationRequest if unable to go
online or timeout,
the purchase amount for a declined offline
authorisation
<TtlAmt>::ImpliedCurrencyAndAmount
4 CumulativeAmount [0..1] <CmltvAmt>::ImpliedCurrencyAndAmount
4 AmountQualifier [0..1] Appli <AmtQlfr>::TypeOfAmount8Code
4 DetailedAmount [0..1] Appli <DtldAmt>
5 AmountGoodsAndServices [0..1] <AmtGoodsAndSvcs>::ImpliedCurrencyAndAmount
5 CashBack [0..1] <CshBck>::ImpliedCurrencyAndAmount
5 Gratuity [0..1] <Grtty>::ImpliedCurrencyAndAmount
5 Fees [0..*] <Fees>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Rebate [0..*] <Rbt>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 ValueAddedTax [0..*] <ValAddedTax>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Surcharge [0..*] <Srchrg>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
4 RequestedAmount [0..1] <ReqdAmt>::ImpliedCurrencyAndAmount
4 AuthorisedAmount [0..1] <AuthrsdAmt>::ImpliedCurrencyAndAmount
<UattnddLvlCtgy>::Max35NumericText
4 AccountType [0..1] Appli defaut Default
see AcceptorAuthorisationRequest
<AcctTp>::CardAccountType3Code
4 CurrencyConversionResult [0..1] <CcyConvsRslt>
5 AcceptedByCardholder [0..1] <AccptdByCrdhldr>::TrueFalseIndicator
5 Conversion [0..1] <Convs>
6 CurrencyConversion-Identification [0..1] <CcyConvsId>::Max35Text
6 TargetCurrency [1..1] <TrgtCcy>
7 AlphaCode [1..1] <AlphaCd>::ActiveCurrencyCode
7 NumericCode [1..1] <NmrcCd>::Exact3NumericText
7 Decimal [1..1] <Dcml>::Number
7 Name [0..1] <Nm>::Max35Text
6 ResultingAmount [1..1] <RsltgAmt>::ImpliedCurrencyAndAmount
6 ExchangeRate [1..1] <XchgRate>::PercentageRate
6 InvertedExchangeRate [0..1] <NvrtdXchgRate>::PercentageRate
6 QuotationDate [0..1] <QtnDt>::ISODateTime
6 ValidUntil [0..1] <VldUntil>::ISODateTime
6 SourceCurrency [1..1] <SrcCcy>
7 AlphaCode [0..1] <AlphaCd>::ActiveCurrencyCode
7 NumericCode [0..1] <NmrcCd>::Exact3NumericText
7 Decimal [0..1] <Dcml>::Number
7 Name [0..1] <Nm>::Max35Text
6 OriginalAmount [1..1] <OrgnlAmt>
7 ActualAmount [0..1] <ActlAmt>::ImpliedCurrencyAndAmount
7 MinimumAmount [0..1] <MinAmt>::ImpliedCurrencyAndAmount
7 MaximumAmount [0..1] <MaxAmt>::ImpliedCurrencyAndAmount
6 CommissionDetails [0..*] <ComssnDtls>
7 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
7 AdditionalInformation [0..1] <AddtlInf>::Max350Text
6 MarkUpDetails [0..*] <MrkUpDtls>
7 Rate [1..1] <Rate>::PercentageRate
7 AdditionalInformation [0..1] <AddtlInf>::Max350Text
6 DeclarationDetails [0..1] <DclrtnDtls>
7 Format [0..1] <Frmt>::OutputFormat1Code
7 MessageContent [1..1] <MsgCntt>::Max20000Text
4 Instalment [0..1] <Instlmt>
5 InstalmentPlan [0..*] <InstlmtPlan>::InstalmentPlan1Code
5 PlanIdentification [0..1] <PlanId>::Max35Text
5 SequenceNumber [0..1] <SeqNb>::Number
5 PeriodUnit [0..1] <PrdUnit>::Frequency3Code
5 InstalmentPeriod [0..1] <InstlmtPrd>::Number
5 TotalNumberOfPayments [0..1] <TtlNbOfPmts>::Number
5 FirstPaymentDate [0..1] <FrstPmtDt>::ISODate
<ICCRltdData>::Max10000Binary
3 AuthorisationResult [0..1] Appli Present for online authorisation if an
AcceptorAuthorisationResponse has been received.
<AuthstnRslt>
4 AuthorisationEntity [0..1] CCopy see AcceptorAuthorisationResponse if received,
otherwise absent.
<AuthstnNtty>
5 Identification [0..1] <Id>::Max35Text
5 Type [1..1] <Tp>::PartyType14Code
<RspnToAuthstn>
5 Response [1..1] <Rspn>::Response4Code
5 ResponseReason [0..1] Appli <RspnRsn>::Max35Text
5 AdditionalResponse-Information [0..1] <AddtlRspnInf>::Max140Text
4 AuthorisationCode [0..1] Appli Obtained from the corresponding
AcceptorAuthorisationResponse if any. For Voice
Authorisation the AuthorisationCode is obtained from the
Acquirer (see section 6.1).
<AuthstnCd>::Min6Max8Text
3 TransactionVerificationResult [0..*] Appli <TxVrfctnRslt>
4 Method [1..1] <Mtd>::AuthenticationMethod6Code
4 VerificationEntity [0..1] <VrfctnNtty>::AuthenticationEntity2Code
4 Result [0..1] <Rslt>::Verification1Code
4 AdditionalResult [0..1] <AddtlRslt>::Max500Text
3 MerchantReferenceData [0..1] <MrchntRefData>::Max70Text
3 AccountFrom [0..1] See MDR for sub elements
<AcctFr>
3 AccountTo [0..1] See MDR for sub elements
<AcctTo>
3 AdditionalTransactionData [0..*] Appli <AddtlTxData>::Max70Text
<SctyTrlr>
it must be ”False”.
C6 FailureReason must be present if CompletionAdvice.Transaction.Transactio
TransactionSuccess is “False”. nSuccess
CompletionAdvice.Transaction.FailureRea
son
C7 If TransactionSuccess is "True" then CompletionAdvice.Transaction.Transactio
TotalAmount must be Final amount of the nDetails.TotalAmount
payment transaction. CompletionAdvice.Transaction.Transactio
Otherwhise, TotalAmount is: nSuccess
the amount of AuthorisationResponse for an
online approval,
the amount of AuthorisationRequest if unable
to go online or timeout,
the purchase amount for an offline
authorisation
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] * The Recipient Party has to adapt the response format to
the version of the Initiator sent in the advice. If this
version is not supported the Recipient must reject the
advice with RejectReason = ProtocolVersion.
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] Copy <XchgId>::Number
2 ReTransmissionCounter [0..1] CCopy <ReTrnsmssnCntr>::Max3NumericText
2 CreationDateTime [1..1] <CreDtTm>::ISODateTime
2 InitiatingParty [1..1] Copy <InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
2 RecipientParty [0..1] Copy <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] Present if present in the completion advice.
see section 3.2 Traceability
<Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] Copy <Issr>::PartyType4Code
4 Country [0..1] Config <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
<AcqrrId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Acquirer
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 MerchantIdentification [0..1] Copy from AcceptorCompletionAdvice if present
<MrchntId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Merchant
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 POIIdentification [0..1] Copy from AcceptorCompletionAdvice
<POIId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
4 Issuer [0..1] Config <Issr>::PartyType4Code
4 ShortName [0..1] Config <ShrtNm>::Max35Text
3 Card [0..1] <Card>
4 ProtectedCardData [0..1] Appli see AcceptorAuthorisationResponse
See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
4 PlainCardData [0..1] Appli see AcceptorAuthorisationResponse
<PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
5 CardSequenceNumber [0..1] <CardSeqNb>::Min2Max3NumericText
5 EffectiveDate [0..1] <FctvDt>::Max10Text
5 ExpiryDate [1..1] <XpryDt>::Max10Text
5 ServiceCode [0..1] <SvcCd>::Exact3NumericText
5 Track1 [0..1] <Trck1>::Max76Text
5 Track2 [0..1] <Trck2>::Max37Text
5 Track3 [0..1] <Trck3>::Max104Text
5 CardholderName [0..1] <CrdhldrNm>::Max45Text
4 PaymentAccountReference [0..1] <PmtAcctRef>::Max70Text
4 MaskedPAN [0..1] <MskdPAN>::Max30Text
4 IssuerBIN [0..1] <IssrBIN>::Max15NumericText
4 CardCountryCode [0..1] <CardCtryCd>::Max3Text
4 CardCurrencyCode [0..1] <CardCcyCd>::Exact3AlphaNumericText
<PmtTkn>
2 Transaction [1..1] <Tx>
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Based on TransactionIdentifier
<TxId>
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] Appli Used by the InitiatingParty when it refers back to the
transaction of the RecipientParty (e.g. reconciliation
mismatch). If supplied, it is mandatory in the completion
and the batch.
<RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] see AcceptorAuthorisationResponse
<RcncltnId>::Max35Text
3 Response [1..1] Approved: the CompletionAdvice is accepted.
For other responses, an error resolution process has to
be performed which is out of scope of the protocol.
<Rspn>::Response4Code
2 TMSTrigger [0..1] Appli see AcceptorAuthorisationResponse
<TMSTrggr>
3 TMSContactLevel [1..1] C2 <TMSCtctLvl>::TMSContactLevel1Code
3 TMSIdentification [0..1] Appli <TMSId>::Max35Text
3 TMSContactDateTime [0..1] C2 Present if TMSContactLevel = DateTime
see AcceptorAuthorisationResponse
<TMSCtctDtTm>::ISODateTime
2 SupplementaryData [0..*] See MDR for sub elements
<SplmtryData>
1 SecurityTrailer [0..1] CMS data structure ContentInfoType with the
AuthenticatedData alternative, containing the MAC of the
message body CompletionAdviceResponse including the
body envelope, using the MAC key of the related
AcceptorCompletionAdvice message.
See MDR for sub elements
<SctyTrlr>
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] see AcceptorAuthorisationRequest
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] see AcceptorAuthorisationRequest
<XchgId>::Number
2 CreationDateTime [1..1] see AcceptorAuthorisationRequest
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] see AcceptorAuthorisationRequest
<InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
2 RecipientParty [0..1] Config see AcceptorAuthorisationRequest
<RcptPty>
3 Identification [1..1] Config <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] Config see section 3.2 Traceability
<Tracblt>
3 RelayIdentification [1..1] Config <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Config <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
<CxlReq>
2 Environment [1..1] see AcceptorAuthorisationRequest
<Envt>
3 Acquirer [0..1] Config <Acqrr>
4 Identification [0..1] Config <Id>
5 Identification [1..1] Appli <Id>::Max35Text
5 Type [0..1] default Acquirer
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 ParametersVersion [1..1] see AcceptorAuthorisationRequest
<ParamsVrsn>::Max256Text
3 Merchant [0..1] C2 Present if it contains any data.
see AcceptorAuthorisationRequest
<Mrchnt>
4 Identification [0..1] Config see AcceptorAuthorisationRequest
<Id>
5 Identification [1..1] Appli <Id>::Max35Text
5 Type [0..1] default Merchant
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 CommonName [0..1] <CmonNm>::Max70Text
4 LocationCategory [0..1] Allowed values Fixed, Aboard, Nomadic and Home
<LctnCtgy>::LocationCategory1Code
4 LocationAndContact [0..1] Based on CommunicationAddress
<LctnAndCtct>
4 SchemeData [0..1] Config <SchmeData>::Max140Text
3 POI [0..1] see AcceptorAuthorisationRequest
<POI>
4 Identification [1..1] <Id>
5 Identification [1..1] Config <Id>::Max35Text
5 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 SystemName [0..1] Config see AcceptorAuthorisationRequest
<SysNm>::Max70Text
4 GroupIdentification [0..1] Config see AcceptorAuthorisationRequest
<GrpId>::Max35Text
4 Capabilities [0..1] Present if it contains any data
see AcceptorAuthorisationRequest
<Cpblties>
CardReadingCapabilities [0..*] Config <CardRdngCpblties>::CardDataReading5Code
CardholderVerificationCapabilities [0..*] Config <CrdhldrVrfctnCpblties>::CardholderVerificationCapabilit
y4Code
PINLengthCapabilities [0..1] <PINLngthCpblties>::Number
ApprovalCodeLength [0..1] <ApprvlCdLngth>::Number
MaxScriptLength [0..1] <MxScrptLngth>::Number
CardCaptureCapable [0..1] <CardCaptrCpbl>::TrueFalseIndicator
5 OnLineCapabilities [0..1] Config <OnLineCpblties>::OnLineCapability1Code
5 MessageCapabilities [0..*] <MsgCpblties>
6 Destination [1..*] <Dstn>::UserInterface4Code
6 AvailableFormat [0..*] <AvlblFrmt>::OutputFormat1Code
6 NumberOfLines [0..1] <NbOfLines>::Number
6 LineWidth [0..1] <LineWidth>::Number
6 AvailableLanguage [0..*] <AvlblLang>::LanguageCode
4 TimeZone [0..1] <TmZone>::Max70Text
4 TerminalIntegration [0..1] <TermnlIntgtn>::LocationCategory3Code
4 Component [0..*] Config Based on PointOfInteractionComponent
see AcceptorAuthorisationRequest
<Cmpnt>
3 Card [0..1] Appli see AcceptorAuthorisationRequest
<Card>
4 ProtectedCardData [0..1] see AcceptorAuthorisationRequest
See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
4 PlainCardData [0..1] see AcceptorAuthorisationRequest
<PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
5 CardSequenceNumber [0..1] Appli <CardSeqNb>::Min2Max3NumericText
5 EffectiveDate [0..1] Appli <FctvDt>::Max10Text
5 ExpiryDate [1..1] <XpryDt>::Max10Text
5 ServiceCode [0..1] Appli <SvcCd>::Exact3NumericText
5 Track1 [0..1] <Trck1>::Max76Text
5 Track2 [0..1] <Trck2>::Max37Text
5 Track3 [0..1] <Trck3>::Max104Text
5 CardholderName [0..1] <CrdhldrNm>::Max45Text
4 PaymentAccountReference [0..1] <PmtAcctRef>::Max70Text
4 MaskedPAN [0..1] <MskdPAN>::Max30Text
4 IssuerBIN [0..1] <IssrBIN>::Max15NumericText
4 CardCountryCode [0..1] Appli <CardCtryCd>::Max3Text
<PmtTkn>
3 Cardholder [0..1] See MDR for sub elements
<Crdhldr>
3 ProtectedCardholderData [0..1] See MDR for sub elements
<PrtctdCrdhldrData>
2 Context [1..1] <Cntxt>
3 PaymentContext [0..1] Context of the cancellation transaction
<PmtCntxt>
4 CardPresent [0..1] default True
see AcceptorAuthorisationRequest
<CardPres>::TrueFalseIndicator
4 CardholderPresent [0..1] default True
see AcceptorAuthorisationRequest
<CrdhldrPres>::TrueFalseIndicator
4 OnLineContext [0..1] <OnLineCntxt>::TrueFalseIndicator
4 AttendanceContext [0..1] Config see AcceptorAuthorisationRequest
<AttndncCntxt>::AttendanceContext1Code
4 TransactionEnvironment [0..1] default Merchant
see AcceptorAuthorisationRequest
<TxEnvt>::TransactionEnvironment1Code
4 TransactionChannel [0..1] Config see AcceptorAuthorisationRequest
<TxChanl>::TransactionChannel5Code
4 AttendantMessageCapable [0..1] C4 default True
Indicates to the acquirer whether a message in the
cancellation response can be displayed to the attendant.
<AttndntMsgCpbl>::TrueFalseIndicator
4 AttendantLanguage [0..1] C4 Present If AttendantMessageCapable is True
Indiciates the language of message in the cancellation
response to be displayed to the attendant
<CardDataNtryMd>::CardDataReading6Code
4 FallbackIndicator [0..1] Appli default False
Alternative for the card data entry mode of the
cancellation transaction.
<FllbckInd>::CardFallback1Code
4 SupportedOption [0..*] <SpprtdOptn>::SupportedPaymentOption1Code
3 SaleContext [0..1] Appli C5 Present if it contains any data.
see AcceptorAuthorisationRequest
<SaleCntxt>
4 SaleIdentification [0..1] Appli <SaleId>::Max35Text
4 SaleReferenceNumber [0..1] Appli <SaleRefNb>::Max35Text
SaleReconciliationIdentification [0..1] Appli <SaleRcncltnId>::Max35Text
4 CashierIdentification [0..1] Appli <CshrId>::Max35Text
4 CashierLanguage [0..*] <CshrLang>::LanguageCode
4 ShiftNumber [0..1] Appli <ShftNb>::Max2NumericText
4 CustomerOrderRequestFlag [0..1] <CstmrOrdrReqFlg>::TrueFalseIndicator
4 PurchaseOrderNumber [0..1] <PurchsOrdrNb>::Max35Text
4 InvoiceNumber [0..1] <InvcNb>::Max35Text
4 DeliveryNoteNumber [0..1] <DlvryNoteNb>::Max35Text
4 SponsoredMerchant [0..*] <SpnsrdMrchnt>
5 CommonName [1..1] <CmonNm>::Max70Text
5 Address [0..1] <Adr>::Max140Text
5 CountryCode [1..1] <CtryCd>::ISO3NumericCountryCode
5 MerchantCategoryCode [1..1] <MrchntCtgyCd>::Min3Max4Text
5 RegisteredIdentifier [1..1] <RegdIdr>::Max35Text
4 SplitPayment [0..1] <SpltPmt>::TrueFalseIndicator
4 RemainingAmount [0..1] <RmngAmt>::ImpliedCurrencyAndAmount
4 ForceOnlineFlag [0..1] <ForceOnlnFlg>::TrueFalseIndicator
4 ReuseCardDataFlag [0..1] <ReuseCardDataFlg>::TrueFalseIndicator
4 AllowedEntryMode [0..*] <AllwdNtryMd>::CardDataReading6Code
4 SaleTokenScope [0..1] <SaleTknScp>::SaleTokenScope1Code
4 AdditionalSaleData [0..1] Appli <AddtlSaleData>::Max70Text
3 DirectDebitContext [0..1] See MDR for sub elements
<DrctDbtCntxt>
2 Transaction [1..1] <Tx>
3 TransactionCapture [0..1] Not used in this version
<TxCaptr>::TrueFalseIndicator
3 MerchantCategoryCode [1..1] see AcceptorAuthorisationRequest
<MrchntCtgyCd>::Min3Max4Text
3 CustomerConsent [0..*] This enables retailers, if they so wish, to clearly indicate
whether the consent of the customer was explicitly
obtained for a given service instead of being implicitly
derived.
<CstmrCnsnt>::TrueFalseIndicator
3 CardProgrammeProposed [0..*] The card program proposed by a retailer to a cardholder
among a series of payment programmes offered by the
<CardPrgrmmPropsd>::Max35Text
3 CardProgrammeApplied [0..*] * The card program actually selected by the cardholder
among the ones supported by the retailer and/or the one
actually proposed to him. At most one
CardProgrammeApplied should be provided.
<CardPrgrmmApld>::Max35Text
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Identification of the cancellation transaction assigned by
the POI. This identification must be different from the
original transaction that is being cancelled.
<TxId>
3 OriginalTransaction [1..1] Appli Information about the transaction to be cancelled.
The OriginalTransaction components must have the
value of the related components of the transaction to
cancel.
<OrgnlTx>
4 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
4 TransactionIdentification [1..1] Appli Based on TransactionIdentifier
<TxId>
4 POIIdentification [0..1] Appli POI where the transaction to cancel was performed.
<POIId>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 ShortName [0..1] <ShrtNm>::Max35Text
InitiatorTransactionIdentification [0..1] Appli Present if present in the transaction to cancel, with the
same value.
<InitrTxId>::Max35Text
RecipientTransactionIdentification [0..1] Appli Present if present in the transaction to cancel, with the
same value.
<RcptTxId>::Max35Text
4 TransactionType [1..1] Copy TransactionType of the original transaction.
<TxTp>::CardPaymentServiceType12Code
4 AdditionalService [0..*] Copy Cancellation of a transaction must cancel all associated
additional services; partial cancellation is not permitted.
<AddtlSvc>::CardPaymentServiceType9Code
4 ServiceAttribute [0..1] Copy Cancellation of the original transaction cancels the
transaction with its service attributes.
<SvcAttr>::CardPaymentServiceType3Code
4 CardDataEntryMode [0..1] <CardDataNtryMd>::CardDataReading5Code
4 TransactionResult [0..1] Appli TransactionResult of the transaction to cancel.
<TxRslt>
5 AuthorisationEntity [0..1] Appli AuthorisationEntity which has approved the transaction
to be cancelled.
<AuthstnNtty>
6 Identification [0..1] <Id>::Max35Text
6 Type [1..1] <Tp>::PartyType14Code
6 Issuer [0..1] <Issr>::PartyType4Code
6 Country [0..1] <Ctry>::Min2Max3AlphaText
6 ShortName [0..1] <ShrtNm>::Max35Text
ResponseToAuthorisation [1..1] ResponseToAuthorisation of the transaction to be
cancelled.
see AcceptorAuthorisationResponse
<RspnToAuthstn>
6 Response [1..1] <Rspn>::Response4Code
6 ResponseReason [0..1] Appli <RspnRsn>::Max35Text
6 AdditionalResponse-Information [0..1] <AddtlRspnInf>::Max140Text
5 AuthorisationCode [0..1] Appli AuthorisationCode of the transaction to be cancelled.
see AcceptorAuthorisationResponse
<AuthstnCd>::Min6Max8Text
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] <RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] Appli Identification of the reconciliation period assigned by the
POI to the cancellation transaction.
see AcceptorAuthorisationRequest
<RcncltnId>::Max35Text
3 TransactionDetails [1..1] <TxDtls>
4 Currency [0..1] Copy Currency of TotalAmount of the transaction to cancel
<Ccy>::ActiveCurrencyCode
4 TotalAmount [1..1] Copy Amount to cancel which is always the TotalAmount of the
approved transaction to cancel. Only the full amount of
the transaction can be cancelled.
<TtlAmt>::ImpliedCurrencyAndAmount
4 ValidityDate [0..1] Appli <VldtyDt>::ISODate
<ICCRltdData>::Max10000Binary
3 AdditionalTransactionData [0..*] Appli <AddtlTxData>::Max70Text
1 SecurityTrailer [0..1] CMS data structure ContentInfoType with the
AuthenticatedData alternative, containing the MAC of the
message body CancellationRequest including the body
envelope.
See MDR for sub elements
<SctyTrlr>
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] Copy C1 The Recipient Party has to adapt the
AcceptorCacellationResponse format to the version of
the Initiator sent in the AcceptorCancellationRequest. If
this version is not supported the Recipient must reject
the request.
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] Copy <XchgId>::Number
2 CreationDateTime [1..1] see AcceptorAuthorisationResponse
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] Copy <InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
2 RecipientParty [0..1] Copy <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] Present if present in the request.
see section 3.2 Traceability
<Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] Copy <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 CancellationResponse [1..1] C1 <CxlRspn>
2 Environment [1..1] <Envt>
3 AcquirerIdentification [0..1] Appli see AcceptorAuthorisationResponse
<AcqrrId>
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 MerchantIdentification [0..1] see AcceptorAuthorisationResponse
<MrchntId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Merchant
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 POIIdentification [0..1] Appli see AcceptorAuthorisationResponse
<POIId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 Card [0..1] <Card>
4 ProtectedCardData [0..1] Appli see AcceptorAuthorisationResponse
See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
4 PlainCardData [0..1] Appli see AcceptorAuthorisationResponse
<PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
5 CardSequenceNumber [0..1] Appli <CardSeqNb>::Min2Max3NumericText
5 EffectiveDate [0..1] Appli <FctvDt>::Max10Text
5 ExpiryDate [1..1] <XpryDt>::Max10Text
5 ServiceCode [0..1] <SvcCd>::Exact3NumericText
5 Track1 [0..1] <Trck1>::Max76Text
5 Track2 [0..1] <Trck2>::Max37Text
5 Track3 [0..1] <Trck3>::Max104Text
5 CardholderName [0..1] <CrdhldrNm>::Max45Text
4 PaymentAccountReference [0..1] <PmtAcctRef>::Max70Text
4 MaskedPAN [0..1] <MskdPAN>::Max30Text
4 IssuerBIN [0..1] <IssrBIN>::Max15NumericText
4 CardCountryCode [0..1] <CardCtryCd>::Max3Text
4 CardCurrencyCode [0..1] <CardCcyCd>::Exact3AlphaNumericText
4 CardProductProfile [0..1] <CardPdctPrfl>::Max35Text
4 CardBrand [0..1] <CardBrnd>::Max35Text
4 CardProductType [0..1] <CardPdctTp>::CardProductType1Code
4 CardProductSubType [0..1] <CardPdctSubTp>::Max35Text
4 InternationalCard [0..1] <IntrnlCard>::TrueFalseIndicator
4 AllowedProduct [0..*] <AllwdPdct>::Max70Text
4 ServiceOption [0..1] <SvcOptn>::Max35Text
<PmtTkn>
2 Transaction [1..1] <Tx>
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Copy Based on TransactionIdentifier
see AcceptorAuthorisationResponse
<TxId>
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] Appli see AcceptorAuthorisationResponse
<RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] Copy or see AcceptorAuthorisationResponse
Appli
<RcncltnId>::Max35Text
3 InterchangeData [0..1] Appli see AcceptorAuthorisationResponse
<IntrchngData>::Max140Text
3 TransactionDetails [1..1] <TxDtls>
4 Currency [1..1] Copy <Ccy>::ActiveCurrencyCode
4 TotalAmount [1..1] Amount to cancel which is always the TotalAmount of the
transaction to cancel. Only the full amount of the
transaction can be cancelled.
<TtlAmt>::ImpliedCurrencyAndAmount
4 ICCRelatedData [0..1] <ICCRltdData>::Max10000Binary
2 TransactionResponse [1..1] <TxRspn>
3 AuthorisationResult [1..1] Outcome of the CancellationRequest
<AuthstnRslt>
4 AuthorisationEntity [0..1] Qualify and allows recognition the entity which has
authorises the cancellation offline or line:
see AcceptorAuthorisationResponse
<AuthstnNtty>
5 Identification [0..1] <Id>::Max35Text
5 Type [1..1] <Tp>::PartyType14Code
5 Issuer [0..1] Appli <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Appli <ShrtNm>::Max35Text
4 ResponseToAuthorisation [1..1] <RspnToAuthstn>
5 Response [1..1] * Valid values are:
Approved: cancellation is approved, including capture
if requested.
Declined: cancellation is declined.
<Rspn>::Response4Code
5 ResponseReason [0..1] Appli see AcceptorAuthorisationResponse
<RspnRsn>::Max35Text
5 AdditionalResponse-Information [0..1] <AddtlRspnInf>::Max140Text
4 AuthorisationCode [0..1] Appli <AuthstnCd>::Min6Max8Text
4 TMSTrigger [0..1] Appli see AcceptorAuthorisationResponse
<TMSTrggr>
5 TMSContactLevel [1..1] C2 <TMSCtctLvl>::TMSContactLevel1Code
5 TMSIdentification [0..1] Appli <TMSId>::Max35Text
5 TMSContactDateTime [0..1] C2 Present if TMSContactLevel = DateTime
<TMSCtctDtTm>::ISODateTime
3 Action [0..*] Appli see AcceptorAuthorisationResponse
<Actn>
4 ActionType [1..1] * Allowed values: Busy, CaptureCard, DisplayMessage or
C3 PrintMessage
<ActnTp>::ActionType7Code
4 MessageToPresent [0..1] C3 if ActionType is DisplayMessage or PrintMessage
<MsgToPres>
5 MessageDestination [1..1] <MsgDstn>::UserInterface4Code
5 Format [0..1] <Frmt>::OutputFormat1Code
5 MessageContent [1..1] <MsgCntt>::Max20000Text
MessageContentSignature [0..1] Appli <MsgCnttSgntr>::Max140Binary
1 SecurityTrailer [0..1] CMS data structure ContentInfoType with the
AuthenticatedData alternative, containing the MAC of the
message body CancellationResponse including the body
envelope, using the MAC key of the related
AcceptorCancellationRequest message.
See MDR for sub elements
<SctyTrlr>
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] see AcceptorAuthorisationRequest
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] see AcceptorAuthorisationRequest
<XchgId>::Number
2 ReTransmissionCounter [0..1] default 0
see 3.3 Message Retransmission
<ReTrnsmssnCntr>::Max3NumericText
2 CreationDateTime [1..1] see AcceptorAuthorisationRequest
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] see AcceptorAuthorisationRequest
<InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] Config <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
2 RecipientParty [0..1] Config see AcceptorAuthorisationRequest
<RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] Config <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] Config see section 3.2 Traceability
<Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] Config <Issr>::PartyType4Code
4 Country [0..1] Config <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Config <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
<CxlAdvc>
2 Environment [1..1] <Envt>
3 Acquirer [0..1] Config see AcceptorAuthorisationRequest
<Acqrr>
4 Identification [0..1] Config <Id>
5 Identification [1..1] Appli <Id>::Max35Text
5 Type [0..1] default Acquirer
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 ParametersVersion [1..1] see AcceptorAuthorisationRequest and
AcceptorCompletionAdvice
<ParamsVrsn>::Max256Text
3 Merchant [0..1] see AcceptorAuthorisationRequest
<Mrchnt>
4 Identification [0..1] Config <Id>
5 Identification [1..1] Appli <Id>::Max35Text
5 Type [0..1] default Merchant
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 CommonName [0..1] Config <CmonNm>::Max70Text
4 LocationCategory [0..1] Config Allowed values Fixed, Aboard, Nomadic and Home
<LctnCtgy>::LocationCategory1Code
4 LocationAndContact [0..1] Config Based on CommunicationAddress
<LctnAndCtct>
4 SchemeData [0..1] Config <SchmeData>::Max140Text
3 POI [0..1] <POI>
4 Identification [1..1] see AcceptorAuthorisationRequest
<Id>
5 Identification [1..1] Config <Id>::Max35Text
5 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 SystemName [0..1] Config <SysNm>::Max70Text
4 GroupIdentification [0..1] Config <GrpId>::Max35Text
4 Capabilities [0..1] C2 Present if it contains any data
see AcceptorAuthorisationRequest
see AcceptorAuthorisationRequest
<Cmpnt>
3 Card [0..1] Appli Card components retrieved from the transaction to
cancel (e.g. log or receipt), or read from the card.
<Card>
4 ProtectedCardData [0..1] see AcceptorAuthorisationRequest
See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
4 PlainCardData [0..1] see AcceptorAuthorisationRequest
<PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
5 CardSequenceNumber [0..1] Appli <CardSeqNb>::Min2Max3NumericText
5 EffectiveDate [0..1] Appli <FctvDt>::Max10Text
5 ExpiryDate [1..1] <XpryDt>::Max10Text
5 ServiceCode [0..1] Appli <SvcCd>::Exact3NumericText
5 Track1 [0..1] <Trck1>::Max76Text
5 Track2 [0..1] <Trck2>::Max37Text
5 Track3 [0..1] <Trck3>::Max104Text
5 CardholderName [0..1] <CrdhldrNm>::Max45Text
4 PaymentAccountReference [0..1] <PmtAcctRef>::Max70Text
4 MaskedPAN [0..1] <MskdPAN>::Max30Text
4 IssuerBIN [0..1] <IssrBIN>::Max15NumericText
4 CardCountryCode [0..1] Appli see AcceptorAuthorisationRequest
<CardCtryCd>::Max3Text
4 CardCurrencyCode [0..1] <CardCcyCd>::Exact3AlphaNumericText
4 CardProductProfile [0..1] Config see AcceptorAuthorisationRequest
<CardPdctPrfl>::Max35Text
<CardBrnd>::Max35Text
4 CardProductType [0..1] <CardPdctTp>::CardProductType1Code
4 CardProductSubType [0..1] <CardPdctSubTp>::Max35Text
4 InternationalCard [0..1] <IntrnlCard>::TrueFalseIndicator
4 AllowedProduct [0..*] <AllwdPdct>::Max70Text
4 ServiceOption [0..1] <SvcOptn>::Max35Text
4 AdditionalCardData [0..1] <AddtlCardData>::Max70Text
3 CustomerDevice [0..1] <CstmrDvc>
4 Identification [0..1] <Id>::Max35Text
4 Type [0..1] <Tp>::Max35Text
4 Provider [0..1] <Prvdr>::Max35Text
3 Wallet [0..1] <Wllt>
4 Identification [0..1] <Id>::Max35Text
4 Type [0..1] <Tp>::Max35Text
4 Provider [0..1] <Prvdr>::Max35Text
3 PaymentToken [0..1] Based on type CardPaymentToken..
<PmtTkn>
3 Cardholder [0..1] See MDR for sub elements
<Crdhldr>
3 ProtectedCardholderData [0..1] See MDR for sub elements
<PrtctdCrdhldrData>
2 Context [0..1] C3 Present if it contains any data
<Cntxt>
3 PaymentContext [0..1] Context of the cancellation transaction
<PmtCntxt>
4 CardPresent [0..1] default True
see AcceptorAuthorisationRequest
<CardPres>::TrueFalseIndicator
4 CardholderPresent [0..1] default True
see AcceptorAuthorisationRequest
<CrdhldrPres>::TrueFalseIndicator
4 OnLineContext [0..1] default True
True if a CancellationRequest has been sent previously.
<OnLineCntxt>::TrueFalseIndicator
4 AttendanceContext [0..1] Config default Attended
see AcceptorAuthorisationRequest
<AttndncCntxt>::AttendanceContext1Code
4 TransactionEnvironment [0..1] default Merchant
see AcceptorAuthorisationRequest
<TxEnvt>::TransactionEnvironment1Code
4 TransactionChannel [0..1] Config see AcceptorAuthorisationRequest
<TxChanl>::TransactionChannel5Code
4 AttendantMessageCapable [0..1] <AttndntMsgCpbl>::TrueFalseIndicator
4 AttendantLanguage [0..1] <AttndntLang>::LanguageCode
4 CardDataEntryMode [0..1] see AcceptorAuthorisationRequest
<CardDataNtryMd>::CardDataReading6Code
4 FallbackIndicator [0..1] default False
see AcceptorAuthorisationRequest
<FllbckInd>::CardFallback1Code
4 SupportedOption [0..*] <SpprtdOptn>::SupportedPaymentOption1Code
3 SaleContext [0..1] C4 Present if it contains any data.
Context of the cancellation transaction
see AcceptorAuthorisationRequest
<SaleCntxt>
4 SaleIdentification [0..1] Appli <SaleId>::Max35Text
4 SaleReferenceNumber [0..1] Appli <SaleRefNb>::Max35Text
SaleReconciliationIdentification [0..1] Appli <SaleRcncltnId>::Max35Text
4 CashierIdentification [0..1] Appli <CshrId>::Max35Text
4 CashierLanguage [0..*] <CshrLang>::LanguageCode
4 ShiftNumber [0..1] Appli <ShftNb>::Max2NumericText
4 CustomerOrderRequestFlag [0..1] <CstmrOrdrReqFlg>::TrueFalseIndicator
4 PurchaseOrderNumber [0..1] <PurchsOrdrNb>::Max35Text
4 InvoiceNumber [0..1] <InvcNb>::Max35Text
4 DeliveryNoteNumber [0..1] <DlvryNoteNb>::Max35Text
4 SponsoredMerchant [0..*] <SpnsrdMrchnt>
5 CommonName [1..1] <CmonNm>::Max70Text
5 Address [0..1] <Adr>::Max140Text
5 CountryCode [1..1] <CtryCd>::ISO3NumericCountryCode
5 MerchantCategoryCode [1..1] <MrchntCtgyCd>::Min3Max4Text
5 RegisteredIdentifier [1..1] <RegdIdr>::Max35Text
4 SplitPayment [0..1] <SpltPmt>::TrueFalseIndicator
4 RemainingAmount [0..1] <RmngAmt>::ImpliedCurrencyAndAmount
4 ForceOnlineFlag [0..1] <ForceOnlnFlg>::TrueFalseIndicator
4 ReuseCardDataFlag [0..1] <ReuseCardDataFlg>::TrueFalseIndicator
4 AllowedEntryMode [0..*] <AllwdNtryMd>::CardDataReading6Code
4 SaleTokenScope [0..1] <SaleTknScp>::SaleTokenScope1Code
4 AdditionalSaleData [0..1] Appli <AddtlSaleData>::Max70Text
3 DirectDebitContext [0..1] See MDR for sub elements
<DrctDbtCntxt>
2 Transaction [1..1] <Tx>
3 MerchantCategoryCode [1..1] see AcceptorAuthorisationRequest
<MrchntCtgyCd>::Min3Max4Text
3 CustomerConsent [0..*] <CstmrCnsnt>::TrueFalseIndicator
3 CardProgrammeProposed [0..*] <CardPrgrmmPropsd>::Max35Text
3 CardProgrammeApplied [0..*] <CardPrgrmmApld>::Max35Text
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Based on TransactionIdentifier
<TxId>
3 OriginalTransaction [0..1] see AcceptorCancellationRequest
<OrgnlTx>
4 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
4 TransactionIdentification [1..1] Appli Based on TransactionIdentifier
see AcceptorCancellationRequest
<TxId>
4 POIIdentification [0..1] Appli see AcceptorCancellationRequest
<POIId>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 ShortName [0..1] <ShrtNm>::Max35Text
InitiatorTransactionIdentification [0..1] Appli see AcceptorCancellationRequest
<InitrTxId>::Max35Text
RecipientTransactionIdentification [0..1] Appli see AcceptorCancellationRequest
<RcptTxId>::Max35Text
4 TransactionType [1..1] Copy see AcceptorCancellationRequest
<TxTp>::CardPaymentServiceType12Code
4 AdditionalService [0..*] see AcceptorCancellationRequest
<AddtlSvc>::CardPaymentServiceType9Code
4 ServiceAttribute [0..1] see AcceptorCancellationRequest
<SvcAttr>::CardPaymentServiceType3Code
4 CardDataEntryMode [0..1] <CardDataNtryMd>::CardDataReading5Code
4 TransactionResult [0..1] Appli see AcceptorCancellationRequest
<TxRslt>
5 AuthorisationEntity [0..1] Appli AuthorisationEntity which has approved the transaction
to cancel.
see AcceptorAuthorisationResponse
<AuthstnNtty>
6 Identification [0..1] <Id>::Max35Text
6 Type [1..1] <Tp>::PartyType14Code
6 Issuer [0..1] <Issr>::PartyType4Code
6 Country [0..1] <Ctry>::Min2Max3AlphaText
6 ShortName [0..1] <ShrtNm>::Max35Text
ResponseToAuthorisation [1..1] ResponseToAuthorisation of the transaction to cancel.
see AcceptorAuthorisationResponse
<RspnToAuthstn>
6 Response [1..1] <Rspn>::Response4Code
6 ResponseReason [0..1] Appli <RspnRsn>::Max35Text
6 AdditionalResponse-Information [0..1] <AddtlRspnInf>::Max140Text
5 AuthorisationCode [0..1] Appli AuthorisationCode of the transaction to cancel.
see AcceptorAuthorisationResponse
<AuthstnCd>::Min6Max8Text
3 TransactionSuccess [1..1] <TxSucss>::TrueFalseIndicator
3 Reversal [0..1] Default: False
<Rvsl>::TrueFalseIndicator
3 FailureReason [0..*] * No acceptable CancellationResponse message has
been received.
Allowed values: Malfunction or Timeout (see
AcceptorCompletionAdvice).
<FailrRsn>::FailureReason3Code
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] Appli see AcceptorCancellationRequest
<RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] Appli Identification of the reconciliation period assigned by the
POI to the cancellation transaction.
see AcceptorCompletionAdvice
<RcncltnId>::Max35Text
3 InterchangeData [0..1] Appli see AcceptorCompletionAdvice
<IntrchngData>::Max140Text
3 TransactionDetails [1..1] <TxDtls>
4 Currency [0..1] copy Currency of TotalAmount of the transaction to cancel
<Ccy>::ActiveCurrencyCode
4 TotalAmount [1..1] copy TotalAmount of the transaction to cancel
<TtlAmt>::ImpliedCurrencyAndAmount
4 ValidityDate [0..1] Appli <VldtyDt>::ISODate
<ICCRltdData>::Max10000Binary
3 AuthorisationResult [0..1] Result of the outcome of the
AcceptorCancellationResponse if any.
<AuthstnRslt>
4 AuthorisationEntity [0..1] see AcceptorCancellationResponse
<AuthstnNtty>
5 Identification [0..1] <Id>::Max35Text
5 Type [1..1] <Tp>::PartyType14Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] <ShrtNm>::Max35Text
4 ResponseToAuthorisation [1..1] see AcceptorCancellationResponse
<RspnToAuthstn>
5 Response [1..1] <Rspn>::Response4Code
5 ResponseReason [0..1] <RspnRsn>::Max35Text
5 AdditionalResponse-Information [0..1] <AddtlRspnInf>::Max140Text
4 AuthorisationCode [0..1] <AuthstnCd>::Min6Max8Text
4 TMSTrigger [0..1] Not used in this message.
<TMSTrggr>
5 TMSContactLevel [1..1] <TMSCtctLvl>::TMSContactLevel1Code
<SctyTrlr>
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] Copy <PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] Copy <XchgId>::Number
2 ReTransmissionCounter [0..1] CCopy <ReTrnsmssnCntr>::Max3NumericText
2 CreationDateTime [1..1] see AcceptorCompletionAdviceResponse
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] Copy <InitgPty>
3 Identification [1..1] Copy <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
2 RecipientParty [0..1] Copy <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] Present if present in the advice.
see section 3.2 Traceability
<Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] Copy <Issr>::PartyType4Code
4 Country [0..1] Config <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 CancellationAdviceResponse [1..1] <CxlAdvcRspn>
2 Environment [1..1] <Envt>
3 AcquirerIdentification [0..1] Appli Copy from AcceptorCancellationAdvice if present
<AcqrrId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Acquirer
<Tp>::PartyType3Code
<MrchntId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Merchant
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 POIIdentification [0..1] Copy <POIId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 Card [0..1] <Card>
4 ProtectedCardData [0..1] Appli see AcceptorAuthorisationResponse
See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
4 PlainCardData [0..1] Appli see AcceptorAuthorisationResponse
<PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
5 CardSequenceNumber [0..1] Appli <CardSeqNb>::Min2Max3NumericText
5 EffectiveDate [0..1] Appli <FctvDt>::Max10Text
5 ExpiryDate [1..1] <XpryDt>::Max10Text
5 ServiceCode [0..1] <SvcCd>::Exact3NumericText
5 Track1 [0..1] <Trck1>::Max76Text
5 Track2 [0..1] <Trck2>::Max37Text
5 Track3 [0..1] <Trck3>::Max104Text
5 CardholderName [0..1] <CrdhldrNm>::Max45Text
4 PaymentAccountReference [0..1] <PmtAcctRef>::Max70Text
4 MaskedPAN [0..1] <MskdPAN>::Max30Text
4 IssuerBIN [0..1] <IssrBIN>::Max15NumericText
4 CardCountryCode [0..1] <CardCtryCd>::Max3Text
4 CardCurrencyCode [0..1] <CardCcyCd>::Exact3AlphaNumericText
4 CardProductProfile [0..1] <CardPdctPrfl>::Max35Text
4 CardBrand [0..1] <CardBrnd>::Max35Text
4 CardProductType [0..1] <CardPdctTp>::CardProductType1Code
4 CardProductSubType [0..1] <CardPdctSubTp>::Max35Text
4 InternationalCard [0..1] <IntrnlCard>::TrueFalseIndicator
4 AllowedProduct [0..*] <AllwdPdct>::Max70Text
4 ServiceOption [0..1] <SvcOptn>::Max35Text
4 AdditionalCardData [0..1] <AddtlCardData>::Max70Text
3 PaymentToken [0..1] Based on type CardPaymentToken..
<PmtTkn>
For verification.
<TxId>
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] Appli Used by the InitiatingParty when it refers back to the
transaction of the RecipientParty (e.g. reconciliation
mismatch). If supplied, it is mandatory in the completion
and the batch.
<RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] see AcceptorAuthorisationResponse
<RcncltnId>::Max35Text
3 Response [1..1] see AcceptorCompletionAdvice.
<Rspn>::Response4Code
2 TMSTrigger [0..1] Appli see AcceptorAuthorisationResponse
<TMSTrggr>
3 TMSContactLevel [1..1] <TMSCtctLvl>::TMSContactLevel1Code
3 TMSIdentification [0..1] Appli <TMSId>::Max35Text
3 TMSContactDateTime [0..1] Present if TMSContactLevel = DateTime
see AcceptorAuthorisationResponse
<TMSCtctDtTm>::ISODateTime
1 SecurityTrailer [0..1] CMS data structure ContentInfoType with the
AuthenticatedData alternative, containing the MAC of the
message body CancellationAdviceResponse including
the body envelope, using the MAC key of the related
AcceptorCancellationAdvice message.
See MDR for sub elements
<SctyTrlr>
<Hdr>
2 MessageFunction [1..1] C1 The only valid code to request the reconciliation is
ReconciliationRequest.
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] <PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] <XchgId>::Number
2 CreationDateTime [1..1] <CreDtTm>::ISODateTime
2 InitiatingParty [1..1] <InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] <ShrtNm>::Max35Text
2 RecipientParty [0..1] Config <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 ReconciliationRequest [1..1] C1 The Header.MessageFunction must be
ReconciliationRequest.
(if not the case, a Reject message is sent by the
Recipient with RejectReason equal to ParsingError)
<RcncltnReq>
2 Environment [1..1] <Envt>
3 Acquirer [0..1]
<Acqrr>
<Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] <ShrtNm>::Max35Text
4 ParametersVersion [1..1] <ParamsVrsn>::Max256Text
3 Merchant [0..1] <Mrchnt>
4 Identification [0..1] <Id>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 ShortName [0..1] <ShrtNm>::Max35Text
4 CommonName [0..1] <CmonNm>::Max70Text
4 LocationCategory [0..1] Allowed values Fixed, Aboard, Nomadic and Home
<LctnCtgy>::LocationCategory1Code
4 LocationAndContact [0..1] Based on CommunicationAddress
<LctnAndCtct>
4 SchemeData [0..1] <SchmeData>::Max140Text
3 POI [0..1] <POI>
4 Identification [1..1] <Id>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] <ShrtNm>::Max35Text
4 SystemName [0..1] <SysNm>::Max70Text
4 GroupIdentification [0..1] <GrpId>::Max35Text
4 Capabilities [0..1] <Cpblties>
5 CardReadingCapabilities [0..*] <CardRdngCpblties>::CardDataReading5Code
5 CardholderVerificationCapabilities [0..*] <CrdhldrVrfctnCpblties>::CardholderVerificationCapabilit
y4Code
5 PINLengthCapabilities [0..1] <PINLngthCpblties>::Number
5 ApprovalCodeLength [0..1] <ApprvlCdLngth>::Number
5 MaxScriptLength [0..1] <MxScrptLngth>::Number
5 CardCaptureCapable [0..1] <CardCaptrCpbl>::TrueFalseIndicator
5 OnLineCapabilities [0..1] <OnLineCpblties>::OnLineCapability1Code
5 MessageCapabilities [0..*] <MsgCpblties>
6 Destination [1..*] <Dstn>::UserInterface4Code
6 AvailableFormat [0..*] <AvlblFrmt>::OutputFormat1Code
6 NumberOfLines [0..1] <NbOfLines>::Number
6 LineWidth [0..1] <LineWidth>::Number
6 AvailableLanguage [0..*] <AvlblLang>::LanguageCode
4 TimeZone [0..1] <TmZone>::Max70Text
4 TerminalIntegration [0..1] <TermnlIntgtn>::LocationCategory3Code
4 Component [0..*] Based on PointOfInteractionComponent
<Cmpnt>
<PmtTkn>
3 Cardholder [0..1] * Must be absent
See MDR for sub elements
<Crdhldr>
3 ProtectedCardholderData [0..1] * Must be absent
See MDR for sub elements
<PrtctdCrdhldrData>
2 Transaction [1..1] <Tx>
3 ClosePeriod [0..1] default True
True: notifies that the reconciliation period must be
closed after the reconciliation exchange.
False: the current reconciliation period must stay open
after this exchange.
<ClsPrd>::TrueFalseIndicator
3 ReconciliationTransactionIdentification [1..1] Based on TransactionIdentifier
<RcncltnTxId>
3 ReconciliationIdentification [1..1] Identification of the reconciliation period.
If ClosePeriod is True, ReconciliationIdentification
identifies the current reconciliation period.
If ClosePeriod is False, ReconciliationIdentification
identifies the current or a closed reconciliation period.
<RcncltnId>::Max35Text
3 TransactionTotals [0..*] TransactionTotals of the reconciliation period.
TransactionTotals is absent if the reconciliation period
contains no transactions.
<TxTtls>
4 POIGroupIdentification [0..1] Appli Collection of transactions containing this value sent in
the POI.GroupIdentification component of the message
request and advice.
<POIGrpId>::Max35Text
4 CardProductProfile [0..1] Appli Collection of transactions containing this value sent in
the Card.CardProductProfile component of the message
request and advice.
<CardPdctPrfl>::Max35Text
4 Currency [0..1] Appli Currency is present when TransactionTotals are
computed per currency (TMS configuration parameter
AcquirerProtocolParameters.TotalsPerCurrency is True).
<Ccy>::ActiveCurrencyCode
4 Type [1..1] * All the values are allowed:
<Tp>::TypeTransactionTotals2Code
4 TotalNumber [1..1] * Total number of transactions for the related Type,
Currency, CardProductProfile and
POIGroupIdentification, performed by the InitiatingParty
during the reconciliation period
ReconciliationIdentification.
<TtlNb>::Number
4 CumulativeAmount [1..1] * Total amount of transactions for the related Type,
Currency, CardProductProfile and
POIGroupIdentification, performed by the InitiatingParty
during the reconciliation period
ReconciliationIdentification.
<CmltvAmt>::ImpliedCurrencyAndAmount
3 AdditionalTransactionData [0..1] Appli <AddtlTxData>::Max70Text
<SctyTrlr>
<Hdr>
2 MessageFunction [1..1] C1 The only valid code to request the reconciliation is
ReconciliationResponse.
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] <PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] Copy <XchgId>::Number
2 CreationDateTime [1..1] <CreDtTm>::ISODateTime
2 InitiatingParty [1..1] Copy <InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] <ShrtNm>::Max35Text
2 RecipientParty [0..1] Copy <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 ReconciliationResponse [1..1] C1 The Header.MessageFunction must be
ReconciliationResponse.
(if not the case, a Reject message is sent by the
RecipientParty with RejectReason equal to ParsingError)
<RcncltnRspn>
2 Environment [1..1] <Envt>
3 AcquirerIdentification [0..1] Copy <AcqrrId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Acquirer
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
<MrchntId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Merchant
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 POIIdentification [0..1] Copy <POIId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 Card [0..1] See MDR for sub elements
<Card>
3 PaymentToken [0..1] See MDR for sub elements
<PmtTkn>
2 TransactionResponse [1..1] <TxRspn>
3 Response [1..1] * The following codes are allowed:
Approved: The reconciliation is accepted, totals of
transactions performed by the Recipient are
provided in the response, or not computed in real-
time.
Declined: Totals are different.
<Rspn>::Response4Code
3 ResponseReason [0..1] One of the reasons defined in section 2.6.4 p. 71, if
Response is not Approved.
<RspnRsn>::Max35Text
3 AdditionalResponseInformation [0..1] <AddtlRspnInf>::Max140Text
2 Transaction [1..1] <Tx>
3 ClosePeriod [0..1] Copy <ClsPrd>::TrueFalseIndicator
3 ReconciliationTransactionIdentification [1..1] Copy <RcncltnTxId>
3 ReconciliationIdentification [1..1] Copy if the value of the request is not 0, otherwise put
the last used value of the ReconciliationIdentification.
<RcncltnId>::Max35Text
3 TransactionTotals [0..*] TransactionTotals is absent if the reconciliation period
contains no transactions, or the totals computation is not
performed in real-time by the acquirer.
The sequence of TransactionTotals components, if
present, must be in the same order as the request,
according to the value of Type, Currency,
CardProductProfile and POIGroupIdentification.
In case of discrepancy, additional TransactionTotals
must be located at the end of the sequence.
<TxTtls>
4 POIGroupIdentification [0..1] Appli see AcceptorReconciliationRequest
<CardPdctPrfl>::Max35Text
4 Currency [0..1] Appli see AcceptorReconciliationRequest
<Ccy>::ActiveCurrencyCode
4 Type [1..1] <Tp>::TypeTransactionTotals2Code
4 TotalNumber [1..1] * Total number of transactions for the related Type,
Currency, CardProductProfile and
POIGroupIdentification, performed by the RecipientParty
during the reconciliation period
ReconciliationIdentification. The value can be zero.
<TtlNb>::Number
4 CumulativeAmount [1..1] * Sum of TotalAmount of transactions for the related Type,
Currency, CardProductProfile and
POIGroupIdentification, performed by the RecipientParty
during the reconciliation period
ReconciliationIdentification. The value can be zero.
<CmltvAmt>::ImpliedCurrencyAndAmount
3 AdditionalTransactionData [0..1] Appli <AddtlTxData>::Max70Text
<SctyTrlr>
<DwnldTrf>::TrueFalseIndicator
2 FormatVersion [1..1] Same value as ProtocolVersion
see AcceptorAuthorisationRequest
<FrmtVrsn>::Max6Text
2 ExchangeIdentification [1..1] Unique identifier for the InitiatingParty to detect
duplication of the transfer for a period of time.
It is a cyclic counter that increments by one with
each new transfer between the InitiatingParty
and the RecipientParty.
<XchgId>::Number
2 CreationDateTime [1..1] Date and time of the file creation. Time accuracy
has to be at least tenth of a second.
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] see AcceptorAuthorisationRequest
<InitgPty>
3 Identification [1..1] The value of this identifier is bilaterally agreed
between InitiatingParty and RecipientParty. The
Recipient of the message must identify without
ambiguity the Initiator of the message.
<Id>::Max35Text
3 Type [0..1] Appli Indicates the type of InitiatingParty:
Acceptor, Merchant, OriginatingPOI,
IntermediaryAgent.
<Tp>::PartyType3Code
3 Issuer [0..1] Config Indicates the assigner for identifying the
InitiatingParty.
<Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
2 RecipientParty [0..1] Config Information used to identify the recipient of an
exchange. The structure and content is
bilaterally agreed between InitiatingParty and
RecipientParty.
<RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] Indicates the type of RecipientParty:
Acceptor, Merchant, IntermediaryAgent,
Acquirer, DelegateIssuer.
<Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
<RmotAccs>
1 BatchTransfer [1..1] <BtchTrf>
2 TransactionTotals [0..*] Appli TransactionTotals of the whole BatchTransfer.
TransactionTotals is absent if the batch contains
no transactions.
<TxTtls>
3 POIGroupIdentification [0..1] Appli see AcceptorReconciliationRequest
<POIGrpId>::Max35Text
3 CardProductProfile [0..1] Appli see AcceptorReconciliationRequest
<CardPdctPrfl>::Max35Text
3 Currency [0..1] see AcceptorReconciliationRequest
<Ccy>::ActiveCurrencyCode
3 Type [1..1] see AcceptorReconciliationRequest
<Tp>::TypeTransactionTotals2Code
3 TotalNumber [1..1] see AcceptorReconciliationRequest
<TtlNb>::Number
3 CumulativeAmount [1..1] see AcceptorReconciliationRequest
<CmltvAmt>::ImpliedCurrencyAndAmount
2 DataSet [0..*] A data set may include both financial
(completed transactions) and non financial
transactions (uncompleted transactions).
<DataSet>
3 DataSetIdentification [1..1] Unique identifier for each of the DataSet for the
InitiatingParty
<DataSetId>
4 Name [1..1] Identifier of the DataSet for the InitiatingParty
<Nm>::Max256Text
4 Type [1..1] BatchCapture
<Tp>::DataSetCategory8Code
4 Version [0..1] Not used in batch capture context
<Vrsn>::Max256Text
4 CreationDateTime [1..1] Date and time of the creation of the data set.
Time accuracy has to be at least tenth of a
second
<CreDtTm>::ISODateTime
3 Traceability [0..*] Config An intermediary Agent must include its own
traceability info, if traceability was present in the
data set received and if the data set is
forwarded with the same transactions.
<Tracblt>
<RlayId>
5 Identification [1..1] <Id>::Max35Text
5 Type [1..1] Indicates the type of RecipientParty:
Acceptor, Merchant, IntermediaryAgent,
Acquirer, DelegateIssuer:
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 ProtocolName [0..1] <PrtcolNm>::Max35Text
4 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
4 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
4 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
3 DataSetInitiator [0..1] Config The initiating party and the dataset initiator can
be the same entity. If not, it is possible for each
data set to identify the entity that creates it by
populating DataSetInitiator.
<DataSetInitr>
4 Identification [1..1] Information used to identify the initiator of a
dataset. The structure and content is bilaterally
agreed between InitiatingParty and
RecipientParty.
<Id>::Max35Text
4 Type [0..1] Indicates the type of DataSetInitiator
Acceptor, Merchant, OriginatingPOI,
IntermediaryAgent:
default OriginatingPOI
<Tp>::PartyType3Code
4 Issuer [0..1] Indicates the assigner for identifying the
DatasetInitiator.
Acceptor, Merchant, , IntermediaryAgent,
acquirer:
<Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 TransactionTotals [1..*] TransactionTotals of the DataSet.
<TxTtls>
4 POIGroupIdentification [0..1] Appli see AcceptorReconciliationRequest
<POIGrpId>::Max35Text
4 CardProductProfile [0..1] Config see AcceptorReconciliationRequest
<CardPdctPrfl>::Max35Text
4 Currency [0..1] Appli see AcceptorReconciliationRequest
<Ccy>::ActiveCurrencyCode
4 Type [1..1] see AcceptorReconciliationRequest
<Tp>::TypeTransactionTotals2Code
<TtlNb>::Number
4 CumulativeAmount [1..1] see AcceptorReconciliationRequest
<CmltvAmt>::ImpliedCurrencyAndAmount
3 CommonData [0..1] Data common to transactions of a DataSet may
be factorised in CommonData to reduce the
message length.
All transactions of the DataSet inherit the data
element value present in CommonData except if
this data element is present in the occurrence of
TransactionToCapture.
<CmonData>
4 Environment [0..1] <Envt>
5 Acquirer [0..1] <Acqrr>
6 Identification [1..1] <Id>
7 Identification [1..1] <Id>::Max35Text
7 Type [0..1] <Tp>::PartyType3Code
7 Issuer [0..1] <Issr>::PartyType4Code
7 Country [0..1] <Ctry>::Min2Max3AlphaText
7 ShortName [0..1] <ShrtNm>::Max35Text
6 ParametersVersion [0..1] <ParamsVrsn>::Max256Text
5 Merchant [0..1] <Mrchnt>
6 Identification [1..1] <Id>
7 Identification [1..1] <Id>::Max35Text
7 Type [0..1] <Tp>::PartyType3Code
7 Issuer [0..1] <Issr>::PartyType4Code
7 ShortName [0..1] <ShrtNm>::Max35Text
6 CommonName [0..1] <CmonNm>::Max70Text
6 LocationCategory [0..1] Allowed values Fixed, Aboard, Nomadic and
Home
<LctnCtgy>::LocationCategory1Code
6 Address [0..1] <Adr>::Max140Text
6 CountryCode [0..1] <CtryCd>::ISO3NumericCountryCode
6 SchemeData [0..1] <SchmeData>::Max140Text
5 POI [0..1] C1 <POI>
6 Identification [1..1] <Id>
7 Identification [1..1] <Id>::Max35Text
7 Type [0..1] <Tp>::PartyType3Code
7 Issuer [0..1] <Issr>::PartyType4Code
7 Country [0..1] <Ctry>::Min2Max3AlphaText
7 ShortName [0..1] <ShrtNm>::Max35Text
6 SystemName [0..1] <SysNm>::Max70Text
6 GroupIdentification [0..1] <GrpId>::Max35Text
6 Capabilities [0..1] <Cpblties>
7 CardReadingCapabilities [0..*] <CardRdngCpblties>::CardDataReading5Code
7 CardholderVerificationCapabilities [0..*] <CrdhldrVrfctnCpblties>::CardholderVerification
Capability4Code
7 PINLengthCapabilities [0..1] <PINLngthCpblties>::Number
7 ApprovalCodeLength [0..1] <ApprvlCdLngth>::Number
7 MaxScriptLength [0..1] <MxScrptLngth>::Number
<Cmpnt>
4 Context [0..1] <Cntxt>
5 PaymentContext [0..1] <PmtCntxt>
6 CardPresent [0..1] <CardPres>::TrueFalseIndicator
6 CardholderPresent [0..1] <CrdhldrPres>::TrueFalseIndicator
6 OnLineContext [0..1] <OnLineCntxt>::TrueFalseIndicator
6 AttendanceContext [0..1] <AttndncCntxt>::AttendanceContext1Code
6 TransactionEnvironment [0..1] <TxEnvt>::TransactionEnvironment1Code
6 TransactionChannel [0..1] <TxChanl>::TransactionChannel5Code
6 AttendantMessageCapable [0..1] <AttndntMsgCpbl>::TrueFalseIndicator
6 AttendantLanguage [0..1] <AttndntLang>::LanguageCode
6 CardDataEntryMode [0..1] <CardDataNtryMd>::CardDataReading6Code
6 FallbackIndicator [0..1] <FllbckInd>::CardFallback1Code
6 SupportedOption [0..*] <SpprtdOptn>::SupportedPaymentOption1Code
5 SaleContext [0..1] <SaleCntxt>
6 SaleIdentification [0..1] <SaleId>::Max35Text
6 SaleReferenceNumber [0..1] <SaleRefNb>::Max35Text
6 SaleReconciliationIdentification [0..1] <SaleRcncltnId>::Max35Text
6 CashierIdentification [0..1] <CshrId>::Max35Text
6 CashierLanguage [0..*] <CshrLang>::LanguageCode
6 ShiftNumber [0..1] <ShftNb>::Max2NumericText
6 CustomerOrderRequestFlag [0..1] <CstmrOrdrReqFlg>::TrueFalseIndicator
6 PurchaseOrderNumber [0..1] <PurchsOrdrNb>::Max35Text
6 InvoiceNumber [0..1] <InvcNb>::Max35Text
6 DeliveryNoteNumber [0..1] <DlvryNoteNb>::Max35Text
6 SponsoredMerchant [0..*] <SpnsrdMrchnt>
7 CommonName [1..1] <CmonNm>::Max70Text
7 Address [0..1] <Adr>::Max140Text
7 CountryCode [1..1] <CtryCd>::ISO3NumericCountryCode
7 MerchantCategoryCode [1..1] <MrchntCtgyCd>::Min3Max4Text
7 RegisteredIdentifier [1..1] <RegdIdr>::Max35Text
6 SplitPayment [0..1] <SpltPmt>::TrueFalseIndicator
6 RemainingAmount [0..1] <RmngAmt>::ImpliedCurrencyAndAmount
6 ForceOnlineFlag [0..1] <ForceOnlnFlg>::TrueFalseIndicator
6 ReuseCardDataFlag [0..1] <ReuseCardDataFlg>::TrueFalseIndicator
6 AllowedEntryMode [0..*] <AllwdNtryMd>::CardDataReading6Code
6 SaleTokenScope [0..1] <SaleTknScp>::SaleTokenScope1Code
6 AdditionalSaleData [0..1] <AddtlSaleData>::Max70Text
<TxTp>::CardPaymentServiceType12Code
4 AdditionalService [0..*] <AddtlSvc>::CardPaymentServiceType9Code
4 ServiceAttribute [0..1] <SvcAttr>::CardPaymentServiceType3Code
4 MerchantCategoryCode [0..1] C3 <MrchntCtgyCd>::Min3Max4Text
4 ReconciliationIdentification [0..1] <RcncltnId>::Max35Text
4 Currency [0..1] <Ccy>::ActiveCurrencyCode
3 Transaction [1..*] Transaction of the data set.It must be a
completion, a cancellation advice, an
authorisation request or an authorisation
response.
<Tx>::CardPaymentDataSetTransaction7Choic
e
4 {Or Completion [1..1] <Cmpltn>
<AuthstnReq>
[1..1] Authorisation response of a card payment
4 Or} AuthorisationResponse transaction.
<AuthstnRspn>
1 SecurityTrailer [0..1] See MDR for sub elements
<SctyTrlr>
<DwnldTrf>::TrueFalseIndicator
2 FormatVersion [1..1] The Recipient Party has to adapt the batch transfer
response format to the version of the Initiator sent in the
batch transfer.
<FrmtVrsn>::Max6Text
2 ExchangeIdentification [1..1] Copy Several AcceptorBatchTransferResponse related to the
same AcceptorBatchTransfer share the same
ExchangeIdentification value.
Duplication of a AcceptorBatchTransferResponse is
detected with a common value of CreationDateTime.
Mixing DataSet from different AcceptorBatchTransfer in
the same AcceptorBatchTransferResponse is forbidden.
<XchgId>::Number
2 CreationDateTime [1..1] see AcceptorBatchTransfer
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] Copy Initiator of the AcceptorBatchTransfer
see AcceptorBatchTransfer
<InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
2 RecipientParty [0..1] Copy <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
1 BatchTransferResponse [1..1] <BtchTrfRspn>
2 TransactionTotals [0..*] Appli <TxTtls>
3 POIGroupIdentification [0..1] Appli <POIGrpId>::Max35Text
3 CardProductProfile [0..1] Appli <CardPdctPrfl>::Max35Text
3 Currency [0..1] <Ccy>::ActiveCurrencyCode
3 Type [1..1] <Tp>::TypeTransactionTotals2Code
3 TotalNumber [1..1] <TtlNb>::Number
3 CumulativeAmount [1..1] <CmltvAmt>::ImpliedCurrencyAndAmount
2 DataSet [0..*] DataSet result concerns all the transactions present in
the original DataSet.
Each occurrence of DataSet present in the
AcceptorBatchTransferResponse must be present in the
original AcceptorBatchTransfer.
Part of the DataSet could be missing and transferred in
<DataSet>
3 DataSetIdentification [1..1] Copy <DataSetId>
4 Name [1..1] <Nm>::Max256Text
4 Type [1..1] CaptureResponse
<Tp>::DataSetCategory8Code
4 Version [0..1] Not used in Batch Capture context
<Vrsn>::Max256Text
4 CreationDateTime [1..1] <CreDtTm>::ISODateTime
3 DataSetResult [1..1] Global result of the DataSet.
<DataSetRslt>
4 Response [1..1] C1 Approved: all transactions in DataSet are accepted.
Declined: all transactions in DataSet are rejected.
PartialApproved: only a subset of transactions is
accepted and the others are rejected.
<Rspn>::Response4Code
4 ResponseReason [0..1] <RspnRsn>::Max35Text
4 AdditionalResponseInformation [0..1] <AddtlRspnInf>::Max140Text
3 RemoveDataSet [1..1] May be used to inform the Initiator to remove the
transactions from the memory.
<RmvDataSet>::TrueFalseIndicator
3 DataSetInitiator [0..1] Copy <DataSetInitr>
4 Identification [1..1] Copy <Id>::Max35Text
4 Type [0..1] Copy <Tp>::PartyType3Code
4 Issuer [0..1] Copy <Issr>::PartyType4Code
4 Country [0..1] Config <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 TransactionTotals [1..*] <TxTtls>
4 POIGroupIdentification [0..1] Copy <POIGrpId>::Max35Text
4 CardProductProfile [0..1] Copy <CardPdctPrfl>::Max35Text
4 Currency [0..1] Copy <Ccy>::ActiveCurrencyCode
4 Type [1..1] Copy See AcceptorReconciliation Request
<Tp>::TypeTransactionTotals2Code
4 TotalNumber [1..1] This data element contains the total number of
transactions calculated by the recipient.
In case of a difference with the total calculated by the
InitatingParty, the InitiatingParty has to take care of the
error which has to be resolved by other mean.
<TtlNb>::Number
4 CumulativeAmount [1..1] This data element contains the cumulative amount of
transactrions calculated by the recipient.
In case of a difference with the CumulativeAmount
calculated by the InitatingParty, the InitiatingParty has to
take care of the error which has to be resolved by other
mean.
<CmltvAmt>::ImpliedCurrencyAndAmount
3 RejectedTransaction [0..*] C1 Present if DataSetResult.Response is PartialApproved.
All transactions with TransactioResponse equal to
Declined or TechnicalError must be present.
<Rspn>::Response1Code
5 ResponseReason [0..1] <RspnRsn>::Max35Text
4 Environment [1..1] <Envt>
5 AcquirerIdentification [0..1] Copy <AcqrrId>
6 Identification [1..1] <Id>::Max35Text
6 Type [0..1] Copy <Tp>::PartyType3Code
6 Issuer [0..1] <Issr>::PartyType4Code
6 Country [0..1] Config <Ctry>::Min2Max3AlphaText
6 ShortName [0..1] <ShrtNm>::Max35Text
5 MerchantIdentification [0..1] Copy <MrchntId>
6 Identification [1..1] <Id>::Max35Text
6 Type [0..1] <Tp>::PartyType3Code
6 Issuer [0..1] <Issr>::PartyType4Code
6 ShortName [0..1] <ShrtNm>::Max35Text
5 POIIdentification [0..1] Copy <POIId>
6 Identification [1..1] <Id>::Max35Text
6 Type [0..1] <Tp>::PartyType3Code
6 Issuer [0..1] <Issr>::PartyType4Code
6 ShortName [0..1] <ShrtNm>::Max35Text
5 Card [0..1] <Card>
6 ProtectedCardData [0..1] Copy see AcceptorBatchTransfer
See MDR for sub elements
<PrtctdCardData>
6 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
6 PlainCardData [0..1] Copy see AcceptorBatchTransfer
<PlainCardData>
7 PAN [1..1] <PAN>::Min8Max28NumericText
CardSequenceNumber [0..1] <CardSeqNb>::Min2Max3NumericText
7 EffectiveDate [0..1] <FctvDt>::Max10Text
7 ExpiryDate [1..1] <XpryDt>::Max10Text
7 ServiceCode [0..1] <SvcCd>::Exact3NumericText
7 Track1 [0..1] <Trck1>::Max76Text
7 Track2 [0..1] <Trck2>::Max37Text
7 Track3 [0..1] <Trck3>::Max104Text
7 CardholderName [0..1] <CrdhldrNm>::Max45Text
6 PaymentAccountReference [0..1] <PmtAcctRef>::Max70Text
6 MaskedPAN [0..1] <MskdPAN>::Max30Text
6 IssuerBIN [0..1] <IssrBIN>::Max15NumericText
6 CardCountryCode [0..1] <CardCtryCd>::Max3Text
6 CardCurrencyCode [0..1] <CardCcyCd>::Exact3AlphaNumericText
6 CardProductProfile [0..1] <CardPdctPrfl>::Max35Text
6 CardBrand [0..1] <CardBrnd>::Max35Text
6 CardProductType [0..1] <CardPdctTp>::CardProductType1Code
6 CardProductSubType [0..1] <CardPdctSubTp>::Max35Text
<PmtTkn>
4 Transaction [1..1] <Tx>
5 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
5 TransactionIdentification [1..1] Copy Based on TransactionIdentifier
<TxId>
5 Response [1..1] Same value as
RejectedTransaction.TransactionResponse.Response
(not to be verified by the RecipientParty)
<Rspn>::Response1Code
1 SecurityTrailer [0..1] See MDR for sub elements
<SctyTrlr>
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] see AcceptorAuthorisationRequest
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] see AcceptorAuthorisationRequest
<XchgId>::Number
2 CreationDateTime [1..1] see AcceptorAuthorisationRequest
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] see AcceptorAuthorisationRequest
<InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
2 RecipientParty [0..1] Config see AcceptorAuthorisationRequest
<RcptPty>
3 Identification [1..1] Config <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Config <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Config <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 DiagnosticRequest [1..1] C1 The Header.MessageFunction must be
DiagnosticRequest.
<DgnstcReq>
2 Environment [1..1] see AcceptorAuthorisationRequest
<Envt>
3 Acquirer [1..1] <Acqrr>
4 Identification [0..1] Appli <Id>
5 Identification [1..1] Appli <Id>::Max35Text
5 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
5 Issuer [0..1] Config <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] Config <ShrtNm>::Max35Text
4 ParametersVersion [1..1] <ParamsVrsn>::Max256Text
3 AcquirerAvailabilityRequested [0..1] <AcqrrAvlbtyReqd>::TrueFalseIndicator
3 MerchantIdentification [0..1] Config see AcceptorAuthorisationRequest
<MrchntId>
4 Identification [1..1] Appli <Id>::Max35Text
4 Type [0..1] default Merchant
<Tp>::PartyType3Code
4 Issuer [0..1] Config <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] Config <ShrtNm>::Max35Text
3 POIIdentification [0..1] <POIId>
4 Identification [1..1] Config <Id>::Max35Text
4 Type [0..1] default OriginatingPOI
<Tp>::PartyType3Code
4 Issuer [0..1] Config <Issr>::PartyType4Code
4 ShortName [0..1] Config <ShrtNm>::Max35Text
3 POIComponent [0..*] Based on PointOfInteractionComponent
<POICmpnt>
3 AcquirerAvailable [0..1] <AcqrrAvlbl>::TrueFalseIndicator
1 SecurityTrailer [0..1] CMS data structure ContentInfoType with the
AuthenticatedData alternative, containing the MAC of the
message body DiagnosticRequest including the body
envelope.
See MDR for sub elements
<SctyTrlr>
<MsgFctn>::MessageFunction14Code
2 ProtocolVersion [1..1] Copy see AcceptorAuthorisationResponse
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] Copy <XchgId>::Number
2 CreationDateTime [1..1] see AcceptorAuthorisationResponse
<CreDtTm>::ISODateTime
2 InitiatingParty [1..1] Copy <InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
2 RecipientParty [0..1] Copy <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] Copy <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] Copy <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] Config <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 DiagnosticResponse [1..1] <DgnstcRspn>
2 Environment [1..1] <Envt>
3 Acquirer [1..1] <Acqrr>
4 Identification [0..1] <Id>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] default Merchant
<Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 Country [0..1] Config <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] <ShrtNm>::Max35Text
<MrchntId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] default Merchant
<Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] Config <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 POIIdentification [0..1] Copy <POIId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
3 POIComponent [0..*] Based on PointOfInteractionComponent
<POICmpnt>
3 AcquirerAvailable [0..1] <AcqrrAvlbl>::TrueFalseIndicator
2 TMSTrigger [0..1] Appli see AcceptorAuthorisationResponse
<TMSTrggr>
3 TMSContactLevel [1..1] <TMSCtctLvl>::TMSContactLevel1Code
3 TMSIdentification [0..1] Appli <TMSId>::Max35Text
3 TMSContactDateTime [0..1] Present if TMSContactLevel = DateTime
<TMSCtctDtTm>::ISODateTime
1 SecurityTrailer [0..1] CMS data structure ContentInfoType with the
AuthenticatedData alternative, containing the MAC of the
message body DiagnosticResponse including the body
envelope, using the MAC key of the related
AcceptorDiagnosticRequest message.
See MDR for sub elements
<SctyTrlr>
<Hdr>
2 MessageFunction [1..1] * The only valid codes to be used in the case a reject
message is sent is:
Rejection: The receiving party could not handle the
request or the advice.
<MsgFctn>::MessageFunction9Code
2 ProtocolVersion [1..1] see AcceptorAuthorisationResponse
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [0..1] Copy from the request if successfully extracted.
<XchgId>::Number
2 CreationDateTime [1..1] see AcceptorAuthorisationResponse
<CreDtTm>::ISODateTime
2 InitiatingParty [0..1] Copy from the request if successfully extracted .
<InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
3 Country [0..1] <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] <ShrtNm>::Max35Text
2 RecipientParty [0..1] Copy from the request if successfully extracted,
otherwise absent.
<RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
3 Country [0..1] <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 Reject [1..1] <Rjct>
<RjctRsn>::RejectReason1Code
2 AdditionalInformation [0..1] Appli Additional information related to the sending of a reject
message in response to a request or an advice.
For logging purpose, in order to allow further analysis,
statistics and deferred processing on the success or the
failure of the request processing.
<AddtlInf>::Max500Text
2 MessageInError [0..1] Appli Message received by the recipient which has been
rejected and produced this AcceptorRejection message.
<MsgInErr>::Max100KBinary
<PrtcolVrsn>::Max6Text
2 ExchangeIdentification [1..1] <XchgId>::Number
2 CreationDateTime [1..1] <CreDtTm>::ISODateTime
2 InitiatingParty [1..1] <InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 CurrencyConversionRequest [1..1] <CcyConvsReq>
2 Environment [1..1] <Envt>
3 Acquirer [0..1] <Acqrr>
4 Identification [0..1] <Id>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 Country [0..1] <Ctry>::Min2Max3AlphaText
5 ShortName [0..1] <ShrtNm>::Max35Text
4 ParametersVersion [1..1] <ParamsVrsn>::Max256Text
3 Merchant [0..1] <Mrchnt>
4 Identification [0..1] <Id>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 ShortName [0..1] <ShrtNm>::Max35Text
4 CommonName [0..1] <CmonNm>::Max70Text
4 LocationCategory [0..1] Allowed values Fixed, Aboard, Nomadic and Home
<LctnCtgy>::LocationCategory1Code
4 LocationAndContact [0..1] Based on CommunicationAddress
<LctnAndCtct>
4 SchemeData [0..1] <SchmeData>::Max140Text
3 POI [0..1] <POI>
4 Identification [1..1] <Id>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
<Cmpnt>
3 Card [0..1] <Card>
4 ProtectedCardData [0..1] See MDR for sub elements
<PrtctdCardData>
4 PrivateCardData [0..1] <PrvtCardData>::Max100KBinary
4 PlainCardData [0..1] <PlainCardData>
5 PAN [1..1] <PAN>::Min8Max28NumericText
5 CardSequenceNumber [0..1] <CardSeqNb>::Min2Max3NumericText
5 EffectiveDate [0..1] <FctvDt>::Max10Text
5 ExpiryDate [1..1] <XpryDt>::Max10Text
5 ServiceCode [0..1] <SvcCd>::Exact3NumericText
5 Track1 [0..1] <Trck1>::Max76Text
5 Track2 [0..1] <Trck2>::Max37Text
5 Track3 [0..1] <Trck3>::Max104Text
5 CardholderName [0..1] <CrdhldrNm>::Max45Text
4 PaymentAccountReference [0..1] <PmtAcctRef>::Max70Text
4 MaskedPAN [0..1] <MskdPAN>::Max30Text
4 IssuerBIN [0..1] <IssrBIN>::Max15NumericText
4 CardCountryCode [0..1] <CardCtryCd>::Max3Text
4 CardCurrencyCode [0..1] <CardCcyCd>::Exact3AlphaNumericText
4 CardProductProfile [0..1] <CardPdctPrfl>::Max35Text
4 CardBrand [0..1] <CardBrnd>::Max35Text
4 CardProductType [0..1] <CardPdctTp>::CardProductType1Code
4 CardProductSubType [0..1] <CardPdctSubTp>::Max35Text
4 InternationalCard [0..1] <IntrnlCard>::TrueFalseIndicator
4 AllowedProduct [0..*] <AllwdPdct>::Max70Text
<PmtTkn>
3 Cardholder [0..1] See MDR for sub elements
<Crdhldr>
3 ProtectedCardholderData [0..1] See MDR for sub elements
<PrtctdCrdhldrData>
2 Transaction [1..1] <Tx>
3 TransactionCapture [0..1] <TxCaptr>::TrueFalseIndicator
3 TransactionType [1..1] <TxTp>::CardPaymentServiceType5Code
3 AdditionalService [0..*] <AddtlSvc>::CardPaymentServiceType9Code
3 ServiceAttribute [0..1] <SvcAttr>::CardPaymentServiceType3Code
3 LastTransactionFlag [0..1] <LastTxFlg>::TrueFalseIndicator
3 MerchantCategoryCode [0..1] <MrchntCtgyCd>::Min3Max4Text
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Based on TransactionIdentifier
<TxId>
3 OriginalTransaction [0..1] <OrgnlTx>
4 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
4 TransactionIdentification [1..1] <TxId>
4 POIIdentification [1..1] <POIId>
5 Identification [1..1] <Id>::Max35Text
5 Type [0..1] <Tp>::PartyType3Code
5 Issuer [0..1] <Issr>::PartyType4Code
5 ShortName [0..1] <ShrtNm>::Max35Text
4 CurrencyConversion [1..1] <CcyConvs>
5 Result [1..1] <Rslt>::CurrencyConversionResponse3Code
5 ResultReason [0..1] <RsltRsn>::Max35Text
5 ConversionDetails [0..*] * At least one occurrence must be present.
<ConvsDtls>
6 CurrencyConversionIdentification [0..1] <CcyConvsId>::Max35Text
6 TargetCurrency [1..1] <TrgtCcy>
7 AlphaCode [1..1] <AlphaCd>::ActiveCurrencyCode
7 NumericCode [1..1] <NmrcCd>::Exact3NumericText
7 Decimal [1..1] <Dcml>::Number
7 Name [0..1] <Nm>::Max35Text
6 ResultingAmount [1..1] <RsltgAmt>::ImpliedCurrencyAndAmount
6 ExchangeRate [1..1] <XchgRate>::PercentageRate
6 InvertedExchangeRate [0..1] <NvrtdXchgRate>::PercentageRate
<Ccy>::ActiveCurrencyCode
4 TotalAmount [1..1] <TtlAmt>::ImpliedCurrencyAndAmount
4 CumulativeAmount [0..1] <CmltvAmt>::ImpliedCurrencyAndAmount
4 AmountQualifier [0..1] <AmtQlfr>::TypeOfAmount8Code
4 DetailedAmount [0..1] <DtldAmt>
5 AmountGoodsAndServices [0..1] <AmtGoodsAndSvcs>::ImpliedCurrencyAndAmount
5 CashBack [0..1] <CshBck>::ImpliedCurrencyAndAmount
5 Gratuity [0..1] <Grtty>::ImpliedCurrencyAndAmount
5 Fees [0..*] <Fees>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Rebate [0..*] <Rbt>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 ValueAddedTax [0..*] <ValAddedTax>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Surcharge [0..*] <Srchrg>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
4 RequestedAmount [0..1] <ReqdAmt>::ImpliedCurrencyAndAmount
4 AuthorisedAmount [0..1] <AuthrsdAmt>::ImpliedCurrencyAndAmount
4 InvoiceAmount [0..1] <InvcAmt>::ImpliedCurrencyAndAmount
4 ValidityDate [0..1] <VldtyDt>::ISODate
4 OnLineReason [0..*] <OnLineRsn>::OnLineReason1Code
<CstmrTkn>
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 CurrencyConversionResponse [1..1] <CcyConvsRspn>
2 Environment [1..1] <Envt>
3 AcquirerIdentification [0..1] <AcqrrId>
4 Identification [1..1] <Id>::Max35Text
<PmtTkn>
2 Transaction [1..1] <Tx>
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] < Based on TransactionIdentifier
TxId>
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
<Ccy>::ActiveCurrencyCode
4 TotalAmount [1..1] <TtlAmt>::ImpliedCurrencyAndAmount
4 CumulativeAmount [0..1] <CmltvAmt>::ImpliedCurrencyAndAmount
4 AmountQualifier [0..1] <AmtQlfr>::TypeOfAmount8Code
4 DetailedAmount [0..1] <DtldAmt>
5 AmountGoodsAndServices [0..1] <AmtGoodsAndSvcs>::ImpliedCurrencyAndAmount
5 CashBack [0..1] <CshBck>::ImpliedCurrencyAndAmount
5 Gratuity [0..1] <Grtty>::ImpliedCurrencyAndAmount
5 Fees [0..*] <Fees>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Rebate [0..*] <Rbt>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 ValueAddedTax [0..*] <ValAddedTax>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
5 Surcharge [0..*] <Srchrg>
6 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
6 Label [0..1] <Labl>::Max140Text
4 RequestedAmount [0..1] <ReqdAmt>::ImpliedCurrencyAndAmount
4 AuthorisedAmount [0..1] <AuthrsdAmt>::ImpliedCurrencyAndAmount
4 InvoiceAmount [0..1] <InvcAmt>::ImpliedCurrencyAndAmount
4 ValidityDate [0..1] <VldtyDt>::ISODate
4 OnLineReason [0..*] <OnLineRsn>::OnLineReason1Code
4 UnattendedLevelCategory [0..1] <UattnddLvlCtgy>::Max35NumericText
4 AccountType [0..1] <AcctTp>::CardAccountType3Code
4 CurrencyConversionResult [0..1] <CcyConvsRslt>
5 AcceptedByCardholder [0..1] <AccptdByCrdhldr>::TrueFalseIndicator
5 Conversion [0..1] <Convs>
6 CurrencyConversionIdentification [0..1] <CcyConvsId>::Max35Text
6 TargetCurrency [1..1] <TrgtCcy>
7 AlphaCode [1..1] <AlphaCd>::ActiveCurrencyCode
7 NumericCode [1..1] <NmrcCd>::Exact3NumericText
7 Decimal [1..1] <Dcml>::Number
7 Name [0..1] <Nm>::Max35Text
6 ResultingAmount [1..1] <RsltgAmt>::ImpliedCurrencyAndAmount
6 ExchangeRate [1..1] <XchgRate>::PercentageRate
6 InvertedExchangeRate [0..1] <NvrtdXchgRate>::PercentageRate
6 QuotationDate [0..1] <QtnDt>::ISODateTime
6 ValidUntil [0..1] <VldUntil>::ISODateTime
6 SourceCurrency [1..1] <SrcCcy>
7 AlphaCode [0..1] <AlphaCd>::ActiveCurrencyCode
7 NumericCode [0..1] <NmrcCd>::Exact3NumericText
<ConvsDtls>
CurrencyConversionIdentification [0..1] <CcyConvsId>::Max35Text
4 TargetCurrency [1..1] <TrgtCcy>
5 AlphaCode [1..1] <AlphaCd>::ActiveCurrencyCode
5 NumericCode [1..1] <NmrcCd>::Exact3NumericText
5 Decimal [1..1] <Dcml>::Number
5 Name [0..1] <Nm>::Max35Text
4 ResultingAmount [1..1] <RsltgAmt>::ImpliedCurrencyAndAmount
4 ExchangeRate [1..1] <XchgRate>::PercentageRate
4 InvertedExchangeRate [0..1] <NvrtdXchgRate>::PercentageRate
4 QuotationDate [0..1] <QtnDt>::ISODateTime
4 ValidUntil [0..1] <VldUntil>::ISODateTime
4 SourceCurrency [1..1] <SrcCcy>
5 AlphaCode [0..1] <AlphaCd>::ActiveCurrencyCode
5 NumericCode [0..1] <NmrcCd>::Exact3NumericText
5 Decimal [0..1] <Dcml>::Number
5 Name [0..1] <Nm>::Max35Text
4 OriginalAmount [1..1] <OrgnlAmt>
5 ActualAmount [0..1] <ActlAmt>::ImpliedCurrencyAndAmount
5 MinimumAmount [0..1] <MinAmt>::ImpliedCurrencyAndAmount
5 MaximumAmount [0..1] <MaxAmt>::ImpliedCurrencyAndAmount
4 CommissionDetails [0..*] <ComssnDtls>
5 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
5 AdditionalInformation [0..1] <AddtlInf>::Max350Text
4 MarkUpDetails [0..*] <MrkUpDtls>
5 Rate [1..1] <Rate>::PercentageRate
5 AdditionalInformation [0..1] <AddtlInf>::Max350Text
4 DeclarationDetails [0..1] <DclrtnDtls>
5 Format [0..1] <Frmt>::OutputFormat1Code
5 MessageContent [1..1] <MsgCntt>::Max20000Text
1 SecurityTrailer [0..1] See MDR for sub elements
<SctyTrlr>
<ReTrnsmssnCntr>::Max3NumericText
2 CreationDateTime [1..1] <CreDtTm>::ISODateTime
2 InitiatingParty [1..1] <InitgPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] <ShrtNm>::Max35Text
2 RecipientParty [0..1] Config <RcptPty>
3 Identification [1..1] <Id>::Max35Text
3 Type [0..1] <Tp>::PartyType3Code
3 Issuer [0..1] <Issr>::PartyType4Code
3 Country [0..1] Config <Ctry>::Min2Max3AlphaText
3 ShortName [0..1] <ShrtNm>::Max35Text
3 RemoteAccess [0..1] Based on NetworkParameters
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 AcceptorCurrencyConversionAdvice [1..1] <AccptrCcyConvsAdvc>
2 Environment [1..1] <Envt>
3 AcquirerIdentification [0..1] <AcqrrId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 MerchantIdentification [0..1] <MrchntId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] <Tp>::PartyType3Code
<PmtTkn>
2 Transaction [1..1] <Tx>
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Based on TransactionIdentifier
<TxId>
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] <RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] <RcncltnId>::Max35Text
3 InterchangeData [0..1] <IntrchngData>::Max140Text
3 TransactionDetails [1..1] <TxDtls>
4 Currency [0..1] <Ccy>::ActiveCurrencyCode
4 TotalAmount [1..1] <TtlAmt>::ImpliedCurrencyAndAmount
4 CumulativeAmount [0..1] <CmltvAmt>::ImpliedCurrencyAndAmount
<CcyConvsRslt>
3 AcceptedByCardholder [0..1] <AccptdByCrdhldr>::TrueFalseIndicator
3 Conversion [0..1] <Convs>
4 CurrencyConversionIdentification [0..1] <CcyConvsId>::Max35Text
4 TargetCurrency [1..1] <TrgtCcy>
5 AlphaCode [1..1] <AlphaCd>::ActiveCurrencyCode
5 NumericCode [1..1] <NmrcCd>::Exact3NumericText
5 Decimal [1..1] <Dcml>::Number
5 Name [0..1] <Nm>::Max35Text
4 ResultingAmount [1..1] <RsltgAmt>::ImpliedCurrencyAndAmount
4 ExchangeRate [1..1] <XchgRate>::PercentageRate
4 InvertedExchangeRate [0..1] <NvrtdXchgRate>::PercentageRate
4 QuotationDate [0..1] <QtnDt>::ISODateTime
4 ValidUntil [0..1] <VldUntil>::ISODateTime
4 SourceCurrency [1..1] <SrcCcy>
5 AlphaCode [0..1] <AlphaCd>::ActiveCurrencyCode
5 NumericCode [0..1] <NmrcCd>::Exact3NumericText
5 Decimal [0..1] <Dcml>::Number
5 Name [0..1] <Nm>::Max35Text
4 OriginalAmount [1..1] <OrgnlAmt>
5 ActualAmount [0..1] <ActlAmt>::ImpliedCurrencyAndAmount
5 MinimumAmount [0..1] <MinAmt>::ImpliedCurrencyAndAmount
5 MaximumAmount [0..1] <MaxAmt>::ImpliedCurrencyAndAmount
4 CommissionDetails [0..*] <ComssnDtls>
5 Amount [1..1] <Amt>::ImpliedCurrencyAndAmount
5 AdditionalInformation [0..1] <AddtlInf>::Max350Text
4 MarkUpDetails [0..*] <MrkUpDtls>
5 Rate [1..1] <Rate>::PercentageRate
5 AdditionalInformation [0..1] <AddtlInf>::Max350Text
4 DeclarationDetails [0..1] <DclrtnDtls>
5 Format [0..1] <Frmt>::OutputFormat1Code
5 MessageContent [1..1] <MsgCntt>::Max20000Text
1 SecurityTrailer [0..1] See MDR for sub elements
<SctyTrlr>
<RmotAccs>
2 Traceability [0..*] <Tracblt>
3 RelayIdentification [1..1] <RlayId>
4 Identification [1..1] <Id>::Max35Text
4 Type [1..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 ProtocolName [0..1] <PrtcolNm>::Max35Text
3 ProtocolVersion [0..1] <PrtcolVrsn>::Max6Text
3 TraceDateTimeIn [1..1] <TracDtTmIn>::ISODateTime
3 TraceDateTimeOut [1..1] <TracDtTmOut>::ISODateTime
1 CurrencyConversionAdviceResponse [1..1] <CcyConvsAdvcRspn>
2 Environment [1..1] <Envt>
3 AcquirerIdentification [0..1] <AcqrrId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 Country [0..1] <Ctry>::Min2Max3AlphaText
4 ShortName [0..1] <ShrtNm>::Max35Text
3 MerchantIdentification [0..1] <MrchntId>
4 Identification [1..1] <Id>::Max35Text
4 Type [0..1] <Tp>::PartyType3Code
4 Issuer [0..1] <Issr>::PartyType4Code
4 ShortName [0..1] <ShrtNm>::Max35Text
<PmtTkn>
2 Transaction [1..1] <Tx>
3 SaleReferenceIdentification [0..1] <SaleRefId>::Max35Text
3 TransactionIdentification [1..1] Based on TransactionIdentifier
<TxId>
3 InitiatorTransactionIdentification [0..1] <InitrTxId>::Max35Text
3 RecipientTransactionIdentification [0..1] <RcptTxId>::Max35Text
3 ReconciliationIdentification [0..1] <RcncltnId>::Max35Text
3 Response [1..1] <Rspn>::Response4Code
2 TMSTrigger [0..1] <TMSTrggr>
3 TMSContactLevel [1..1] <TMSCtctLvl>::TMSContactLevel1Code
3 TMSIdentification [0..1] <TMSId>::Max35Text
3 TMSContactDateTime [0..1] <TMSCtctDtTm>::ISODateTime
1 SecurityTrailer [0..1] See MDR for sub elements
<SctyTrlr>
1846 In the following part of this chapter we describe types that are used in various messages.
1847 In some cases, the same type could be used with different message element names.
1849 CardPaymentToken (type of PaymentToken) provides necessary and sufficient information to identify
1850 a surrogate value of a PAN. This value may be provided by the card issuer, and is known as the card
1851 payment token, or it may be provided by any other actors in the payment process.
1852 This surrogate may be only for the time of a transaction (e.g. in a multi-channel situation), or for a
1853 longer period (e.g. to recognise a customer after the first visit at a store or at a merchant site) and
1854 could be grouped in a two different kinds:
1855 1) Issuer Token: the token is an alternate PAN, usable in dedicated payment domain defined
1856 during its issuance by the token service provider of the card Issuer. The token has the same format
1857 as a PAN and belongs to a BIN range reserved to payment tokens.
1858 2) Acquirer Token: the token is an encrypted PAN or value attached to the PAN, generated by the
1859 POI System, an Acquirer or any Agent between, to replace the PAN during a payment transaction
1860 on a segment between the Merchant (or Card Acceptor) and the Acquirer.
1861 According to the characteristics of this token, this surrogate value may be used for payment services
1862 or not.
<Tkn>::Min8Max28NumericText
1 CardSequenceNumber [0..1] Identify a payment token inside a set of cards with the
same PAN.
<CardSeqNb>::Min2Max3NumericText
1 TokenExpiryDate [0..1] Expiration date of the payment token that is generated
by and maintained in the token vault.
<TknXpryDt>::Max10Text
1 TokenCharacteristic [0..*] Additional payment token information. We recommend to
at least use the following exclusive values
TRANSACTION : The token is generated to
recognise a customer during the time of a
transaction.
CUSTOMER : The token is generated to
recognise a customer for a longer period.
<TknChrtc>::Max35Text
1 TokenRequestor [0..1] <TknRqstr>
2 ProviderIdentification [1..1] Identifier of the token provider.
<PrvdrId>::Max35Text
2 RequestorIdentification [1..1] Identifier of the token requestor.
<RqstrId>::Max35Text
4 Messages and Usage - 213 - 4.10 Common nexo Acquirer message principles.
Card Payment Message Usage Guide Version 8.0
<TknAssrncLvl>::Number
1 TokenAssuranceData [0..1] Information about the identification and verification of the
cardholder.
<TknAssrncData>::Max500Binary
1 TransactionDateTime [1..1] Appli UTC date and time with offset or local date time.
<TxDtTm>::ISODateTime
1 TransactionReference [1..1] Appli Identification of the transaction that has to be unique in
combination with TransactionDateTime for the merchant
and the POI.
<TxRef>::Max35Text
<NtwkTp>::NetworkType1Code
1 AddressValue [1..1] Value of the address:
The value of an internet protocol address contains the
IP address or the DNS (Domain Name Server)
address, followed by the character ':' and the TCP port
number if the default port is not used.
The value of a public telephone address contains the
phone number with possible prefix and extensions.
<AdrVal>::Max70Text
1 UserName [0..1] Username for identification of the POI e.g. to login into
a server
<UsrNm>::Max35Text
1 AccessCode [0..1] Password for authentication of the POI e.g. to login into
a server
<AccsCd>::Max35Binary
1 ServerCertificate [0..*] X.509 Certificate required to authenticate the server.
<SvrCert>::Max10KBinary
1 ServerCertificateIdentifier [0..*] Identification of the X.509 Certificate required to
authenticate the server, for instance a digest of the
certificate, the certificate serial number with the
certificate issuer name.
<SvrCertIdr>::Max140Binary
4 Messages and Usage - 214 - 4.10 Common nexo Acquirer message principles.
Card Payment Message Usage Guide Version 8.0
<ClntCert>::Max10KBinary
1 SecurityProfile [0..1] Identification of the set of security elements to access
the host.
<SctyPrfl>::Max35Text
<Tp>::POIComponentType5Code
1 Identification [1..1] Identification of the component.
<Id>
2 ItemNumber [0..1] <ItmNb>::Max35Text
2 ProviderIdentification [0..1] Identifies the provider of the component class (it replaces
the data element ManufacturerIdentification of version 1).
<PrvdrId>::Max35Text
2 Identification [0..1] Identification of the component assigned by the provider
(it replaces the data element Model of version 1).
<Id>::Max35Text
2 SerialNumber [0..1] Serial number of the component if available.
<SrlNb>::Max35Text
1 Status [0..1] Actual status of the component.
<Sts>
2 VersionNumber [0..1] Current version of component that may include the
release number.
<VrsnNb>::Max256Text
2 Status [0..1] <Sts>::POIComponentStatus1Code
2 ExpiryDate [0..1] <XpryDt>::ISODate
1 StandardCompliance [0..*] Identification of the standard for which the component
complies with.
<StdCmplc>
2 Identification [1..1] Identification of the standard.
<Id>::Max35Text
2 Version [1..1] Version of the standard.
<Vrsn>::Max35Text
2 Issuer [1..1] Entity assigning the identification
<Issr>::Max35Text
1 Characteristics [0..1] Only used in TMS protocol.
<Chrtcs>
4 Messages and Usage - 215 - 4.10 Common nexo Acquirer message principles.
Card Payment Message Usage Guide Version 8.0
<Assmnt>
2 Type [1..1] <Tp>::POIComponentAssessment1Code
2 Assigner [1..*] <Assgnr>::Max35Text
2 DeliveryDate [0..1] <DlvryDt>::ISODateTime
2 ExpirationDate [0..1] <XprtnDt>::ISODateTime
2 Number [1..1] <Nb>::Max35Text
1 AddressLine [0..2]
1 StreetName [0..1]
1 BuildingNumber [0..1]
1 PostCode [0..1]
1 TownName [1..1]
1 CountrySubDivision [0..2]
1 Country [1..1]
4 Messages and Usage - 216 - 4.10 Common nexo Acquirer message principles.
Card Payment Message Usage Guide Version 8.0
4 Messages and Usage - 217 - 4.10 Common nexo Acquirer message principles.
Card Payment Message Usage Guide Version 8.0
1872 This chapter presents an exhaustive catalogue of payment transactions cases by:
1873 Listing exhaustively the cases from the various process flows of the payment transaction,
1874 presenting the associated sequences of Authorisation, Completion and Batch exchanges
1875 between an Acceptor and an Acquirer,
1876 determining the values of the message data components and configuration parameters
1877 relevant for theses exchanges of messages, the financial capture and the outcome of the
1878 transaction.
1917 The Merchant (Acceptor) may force the acceptance of a transaction (eg. in case of a trusted or loyal
1918 customer).
1919 A transaction can only be forced if it is allowed by the Acquirer and in accordance with the rules of the
1920 card scheme.
1921 The option to force a transaction may be presented to the Acceptor when a transaction does not
1922 complete as approved, since:
1923 No response was received
1924 The transaction was declined
1925 Some incident occurred after authorisation at the POI.
1926 If the Merchant forces the payment transaction , in the AcceptorCompletionAdvice message the
1927 following values are used:
1928 Transaction.MerchantOverride flag is set to True,
1929 Transaction.FailureReason is present with one of the values: CardDeclined, Malfunction,
1930 OfflineDeclined, OnlineDeclined, TimeOut, TooLateResponse, UnableToSend or
1931 UnableToComplete value.
1943 This configuration information is neither sent in the AcceptorAuthorisationRequest, nor in the
1944 AcceptorCompletionAdvice messages.
1965 On demand CompletionAdvice is sent after the Authorisation exchange if the CompletionRequired flag
1966 of the AcceptorAuthorisationResponse message is set to True. The OnDemand value of the
1967 CompletionExchange.ExchangePolicy has no effect on the completion behavior.
1968 Regardless of the above values, a completion exchange is also required when:
1969 The transaction completes successfully and the capture is realised during the completion
1970 exchange.
1971 An online authorisation needs to be reversed (e.g. no acceptable response to an
1972 AcceptorAuthorisationRequest or incident after an approved authorisation).
1973 The merchant successfully forces the transaction (see 5.2.1.4) and the capture must be made
1974 on-line (i.e. with an authorisation exchange or a completion exchange).
1975 a successful voice authorisation was performed and the capture must be made with the
1976 completion exchange.
1977 The authorisation is declined or the payment transactions failed and the TMS parameter
1978 BatchTransferContent is set to send declined or failed transactions.
1979 In case of reversal (Transaction.Reversal has the value True), the AcceptorCompletionAdvice
1980 message should be sent immediately after the transaction is completed, whatever the value of
1981 CompletionExchange.ExchangePolicy.
(case 3).
ent
incid
h out
d wit
plete The merchant cannot force the transaction if the
com
payment transaction completes successfully after an
fail
approved authorisation.
ved
ure
afte ed
forc
ro
r aut not
app
hor
isa
tion
mer
cha
nt fo
rces
1987 On the right side of the tree, after the case number, the figure provides the sequence of exchange
1988 related to the case:
1989 auth: Authorisation exchange (AcceptorAuthorisationRequest/Response),
1990 compl: Completion exchange (AcceptorCompletionAdvice/Response),
1991 reversal: Completion exchange with reversal(AcceptorCompletionAdvice/Response),
1992 batch: Batch exchange (AcceptorBatchTransfer/Response)
1993 The exchange is in bold and underlined if the capture is realised during that exchange, in square
1994 bracket if the exchange is optional, and define as reversal for a completion which is a reversal :
auth compl Capture is done with the Authorisation exchange, the Completion is required by the
Acquirer (without capture).
auth compl Capture is done with the Completion exchange.
auth batch Capture is done by Batch.
auth reversal Capture is done with the Authorisation exchange, no response is received by the
POI, a "financial reversal" is performed with the Completion.
auth [batch] The payment transaction fails, the transaction must be included in the batch if the
Acceptor is configured to do so.
1995 The form of "auth" and "compl" gives the value of the Header.MessageFunction component of the
1996 Authorisation and Completion messages, as summarized in the table below:
MessageFunction
auth "AuthorisationRequest" "AuthorisationResponse"
auth "FinancialAuthorisationRequest" "FinancialAuthorisationResponse"
compl "CompletionAdvice" "CompletionAdviceResponse"
compl "FinancialCompletionAdvice" "FinancialCompletionAdviceResponse"
reversal "ReversalAdvice" "ReversalAdviceResponse"
reversal "FinancialReversalAdvice" "FinancialReversalAdviceResponse"
1997 Table 2: MessageFunction Values
ca mpl . requ.
no co Case 14 auth
appro
capture compl
rce
d ba compl. requ
ired Case 15 auth compl
ot fo tch
ca
n ptu mpl . requ.
re no co Case 16 auth [batch]
compl. requ
ired Case 17 auth compl [batch]
Case 18 auth compl
auth
capture
capture compl. Case 19 auth compl
batc qu.
h ca no compl. re Case 20 auth batch
ptur
e
compl. requ
ired Case 21 auth compl batch
declined qu.
no compl. re Case 22 auth
th
au compl. requ
ired Case 23 auth compl
re
p tu
ca qu.
no compl. re Case 24 auth
capture compl
rce
d ba compl. requ
ired Case 25 auth compl
t fo tch
no ca .
ptu no compl. requ Case 26 auth [batch]
re
compl. requ
ired Case 27 auth compl [batch]
no ac
ble re
h ca
ptur Case 30 auth batch
e
compl. requ
ired Case 31 auth compl batch
s
Online
ponse
capture auth
Case 32 auth reversal
ed capture compl. Case 33 auth reversal
forc batch captur
not e Case 34 auth reversal[batch]
mer Case 35 auth compl
ch ant capture auth
forc
es capture compl. Case 36 auth compl
batch captur
e Case 37 auth compl batch
capture auth
Case 38 auth reversal
failur
e afte
r auth ed capture compl. Case 39 auth reversal
forc batch captur
orisa
tion not e Case 40 auth reversal[batch]
mer Case 41 auth compl
ca ch ant
forc capture auth
rd
a pp es capture compl. Case 42 auth compl
rov batch captur
es e Case 43 auth compl batch
Off
line
capture auth
Case 44 auth compl
a
batch captur
.
capture co
mpl Case 47 compl
qu.
batch c no compl. re Case 48 batch
apture
compl. requ
ired Case 49 compl batch
Off
lin
ed qu.
rov re no compl. re Case 50
ea
app captu l
p
com
ut h
compl. requ
ired Case 51 compl
.
ed qu.
forc batc no compl. re Case 52 [batch]
not h captu
re
compl. requ
ired Case 53 compl [batch]
declined me
rch mpl Case 54 compl
ant
for capture co
ces qu .
batch c no compl. re Case 55 batch
apture
compl. requ
ired Case 56 compl batch
fa
ilu
re qu.
re
captu l no compl. re Case 57
p
com compl. requ Case 58 compl
ired
ed qu.
forc batc no co mpl . re
Case 59 [batch]
not h captu
re
compl. requ
ired Case 60 compl [batch]
me
rch mpl Case 61 compl
ant
for capture co
ces qu.
batch c no compl. re Case 62 batch
apture
compl. requ
ired Case 63 compl batch
2001 The table below provides for each case the value of the key data components inside the messages or
2002 configuration parameters.
Authorisation
Txn Capt. Refers to TransactionCapture flag to be used in an
AcceptorAuthorisationRequest message.
Response Refers to Response data component to be used in an
AcceptorAuthorisationResponse messages to give the outcome of the on-line
authorisation:
Appr.: for the values Approved or PartialApproved.
Decl.: for the values Declined.
Compl.Requ. An AcceptorCompletionAdvice message has to be sent in this instance. For
declined and failed transaction, this flag has the priority over the configuration
parameters ExchangeDeclined and ExchangeFailed.
CompletionAdvic
e
condition Express the condition for Completion exchange:
mandatory: the Completion exchange always
occurs,
ExchPol = None (or ≠ None): the configuration
parameter OfflineTransaction.ExchangePolicy or
OfflineTransaction.ExchangePolicy has (or has not ) the value None.
ExchDecl = True or False: the configuration
parameter ExchangeDeclined has the value True or False.
ExchFail = True or False: the configuration
parameter ExchangeFailed has the value True or False.
required : Completion is sent according to the
ExchangePolicy.
Txn. Succ. Refers to TransactionSuccess flag to be used in an AcceptorCompletionAdvice
message to provide the success or the failure of the transaction.
In addition to the value of this flag, it contains the value of MessageFunction in
the Completion messages:
(c): "CompletionAdvice"
(fc): "FinancialCompletionAdvice"
(r): "ReversalAdvice"
(fr): "FinancialReversalAdvice"
Txn. Capt. Refers to TransactionCapture flag to be used in an AcceptorCompletionAdvice
message to indicate whether the transaction needs to be captured or not.
Reversal Refers to Reversal flag to be used in an AcceptorCompletionAdvice message
to indicate whether the message is to be considered as a reversal or not.
Failure Reason Refers to FailureReason data component to be used in an
AcceptorCompletionAdvice message which contains the reasons of the failure
causing the reversals, merchant override or failure of the transaction. A “+”
mean that an acceptor may send more than one failure reason.
Merch. Overr. Refers to MerchantOverride flag to be used in an AcceptorCompletionAdvice
message to indicate whether the merchant forced the acceptance of the
transaction or not.
Batch
condition Express the condition to include the payment transaction in a Batch transfer:
Empty cell: the transaction is never included in a
Batch transfer,
BatchCont=DebitCredit: the transaction is included
in the Batch transfer if the configuration parameter BatchTransferContent
has the value DebitCredit,
BatchCont=Declined: the transaction is included in
the Batch transfer if the configuration parameter BatchTransferContent has
the value Declined,
BatchCont= Failed: the transaction is included in
the Batch transfer if the configuration parameter BatchTransferContent has
the value Failed.
The number below the condition refers to the line number containing the value
of the flags TransactionSuccess, Reversal, MerchantOverride, and the data
elements FailureReason and Response of the related transaction in the
BatchTransfer.
mandatory CustCancel
Online approved
False Malfunction
6 Incident after Auth. True Appr. True True
(fr) CardDecline
Capture Auth.
Unab2Com
CustCancel
Online approved
False Malfunction
7 Incident after Auth. False Appr. absent mandatory False True
(r) CardDecline
Capture Compl.
Unab2Com
CustCancel
Online approved BatchCont=
mandatory False Malfunction
8 Incident after Auth. False Appr. False True Failed
(r) CardDecline
Batch Capture 8
Unab2Com
Online approved
Incident after Auth. Malfunction
mandatory True
9 True Appr. True True CardDecline True
(fc)
Merchant forces Unab2Com
Capture Auth.
Online approved
Incident after Auth. Malfunction
1 True
False Appr. absent mandatory True True CardDecline True
0 (fc)
Merchant forces Unab2Com
Capture Compl.
Online approved True
Incident after Auth. Malfunction BatchCont=
1 True
False Appr. False True CardDecline True DebitCredit
1 (c)
Merchant forces absent required Unab2Com 10
Batch Capture
Online declined False
1
Capture Auth. True Decl.
2 absent
Compl. not requ. ExchDecl=False
Online declined True
1 False
Capture Auth. True Decl. False OnlineDecl
3 absent (c)
Compl. required ExchDecl=True
Online declined False
1
Capture Compl. False Decl.
4 absent
Compl. not requ. ExchDecl=False
Online declined True
1 False
Capture Auth. False Decl. False OnlineDecl
5 absent (c)
Compl. required ExchDecl=True
Online declined False BatchCont=
1
Batch Capture False Decl. Declined
6 absent
Compl. not requ. ExchDecl=False 17
Online declined True BatchCont=
1 False
Batch Capture False Decl. False OnlineDecl Declined
7 absent (c)
Compl. required ExchDecl=True 17
Online declined absent
1 True
Merchant forces True Decl. or mandatory True OnlineDecl True
8 (fc)
Capture Auth. present
Online declined absent
1 True
Merchant forces False Decl. or mandatory True OnlineDecl True
9 (fc)
Capture Compl. present
Appr. mandatory
3 Online no resp. False TimeOut
True or True True
2 Capture Auth. (fr) Unable2Send
Decl.
Appr.
3 Online no resp. required False TimeOut
False or absent False True
3 Capture Compl. (r) Unable2Send
Decl.
Appr. BatchCont=
3 Online no resp. mandatory False TimeOut
False or False True Failed
4 Batch Capture (r) Unable2Send
Decl. 34
TimeOut
Unable2Send
Online no resp.
Appr. +
3 Incident after Auth. mandatory False
True or True True CustCancel
8 (fr)
Decl. Malfunction
Capture Auth.
CardDecline
Unab2Com
TimeOut
Unable2Send
Online no resp.
Appr. +
3 Incident after Auth. required False
False or False True CustCancel
9 (r)
Decl. Malfunction
Capture Compl.
CardDecline
Unab2Com
TimeOut
Unable2Send
Online no resp.
Appr. + BatchCont=
4 Incident after Auth. required False
False or False True CustCancel Failed
0 (r)
Decl. Malfunction 40
Batch Capture
CardDecline
Unab2Com
TimeOut
Online no resp.
Unable2Send
Incident after Auth. Appr.
4 mandatory True +
True or True True True
1 (fc) Malfunction
Merchant forces Decl.
CardDecline
Capture Auth.
Unab2Com
TimeOut
Online no resp.
Unable2Send
Incident after Auth. Appr.
4 mandatory True +
False or absent True True True
2 (fc) Malfunction
Merchant forces Decl.
CardDecline
Capture Compl.
Unab2Com
TimeOut
Online no resp.
Unable2Send
Incident after Auth. Appr. BatchCont=
4 required True +
False or False True True DebitCredit
3 (c) Malfunction
Merchant forces Decl. 42
CardDecline
Batch Capture
Unab2Com
2013 In the Figure 54 Cancellation Cases Tree List cancellation cases are described, based on the type of
2014 capture and the combination of Cancellation Request and Cancellation Advice requested. For batch
2015 file, the tree also shows the case where cancelled transactions must (or must not) be included in the
2016 batch transfer.
2017 Case 5 to 14 are the same, the only difference being the authorisation type. This has no impact on
2018 cancellation processing.
2019 The tree also covers the case where the transaction is not available in the log file because of at least
2020 one of the followings:
2021 the cancellation is done in a new batch
2022 the cancellation and the original transaction are not in the same reconciliation period
2023 The original transaction originates from another POI.
2024 In this case cancellation request is mandatory and a cancellation advice must be sent if the request is
2025 approved.
2026 In the right hand side of the tree, after the case number, the figure provides the sequence of
2027 exchanges related to the case:
2028 auth: Authorisation exchange (AcceptorAuthorisationRequest/Response),
2029 compl: Completion exchange (AcceptorCompletionAdvice/Response),
2030 batch: Batch exchange (AcceptorBatchTransfer/Response)
2031 canreq: Cancellation request exchange (AcceptorCancellationRequest/Response)
2032 canadv: Cancellation advice exchange (AcceptorCancellationAdvice/Response)
2033 The exchange is in bold and underlined if the capture was done in the payment processing. As for the
2034 payment case, the message is in bold and underlined if the financial capture was done. Cancellation
2035 request or advice are in bold and italic if the capture is undone.
auth canadv Capture was done on authorisation, no cancellation request and capture is
undone with a cancellation advice.
compl canreq canadv Capture was done with a completion, a cancellation request is accepted and
undo the capture, followed by a cancellation advice.
canreq canadv batch The capture hasn’t occured yet, transaction is cancelled by request and advice
and both original transaction and cancellation are included in batch.
2036 For cancellation, “canreq” and “canadv” gives the value of the Header.MessageFunction component of
2037 the Cancellation Request and CancellationAdvice messages, as summarized in the table below:
MessageFunction
canreq “CancellationRequest” “CancellationResponse”
canadv “CancellationAdvice” “CancellationAdviceResponse”
2038 Table 4: Cancellation MessageFunction Values
canadv
Case 6 compl canreq canadv
canadv
canreq Case 10 canadv
accepte d
Case 11 canreq canadv batch
canadv
Case 5 compl canadv
canadv
Case 6 compl canreq canadv
canadv
Case 10 canadv
Canreq
accepte d
Case 15 canreq canadv
canreq requ.
Case 16 canreq
Canreq
accepte d
Case 21 canreq canadv batch
canreq requ.
Case 22 canreq
2041 The table below provides for each case the value of the key data components inside the messages or
2042 configuration parameters.
2043 It reads as follows:
Payment Case Refers to the possible payment that can be cancelled according to the
cancellation case.
Cancellation Refers to both AcceptorCancellationRequest and
Request AcceptorCancellationResponse messages.
Cancellation Refers to an AcceptorCancellationAdvice message.
Advice
Batch Refers to a BatchTransfer message.
Cancellation
Request
condition Express the condition for Cancellation exchange:
CancExch = Advice: the configuration parameter
OnlineTransaction. CancellationExchange or OfflineTransaction.
CancellationExchange has the value Advice.
CancExch = Request: the configuration parameter
OnlineTransaction. CancellationExchange or OfflineTransaction.
CancellationExchange has the value Request.
Cancellation
Advice
Advice Sent Express the requirement to send or not an Advice.:
True: A cancellation advice MUST be sent.
False: A cancellation advice MUST NOT be sent.
Batch
Cancellation in Express the condition to include the cancellation transaction in a Batch
batch transfer:
Empty cell: the cancellation is never included in a
Batch transfer,
BatchCont=Cancellation: the cancellation
transaction is included in the Batch transfer because the configuration
parameter BatchTransferContent has the value Cancellation.,
BatchCont≠Cancellation: the cancellation
transaction is not included in the Batch transfer because the configuration
parameter BatchTransferContent has not the value Cancellation.,
Capture
Completion
3,9,10,18,19,2
Cancellation requ. 8,29,35,36,41, CancExch= No
8 False True False True
Canc. no response 42,44,45,47,5 Request resp.
4,61
Cancellation
advice
Batch Capture .
No cancellation
requ. 4,5,11,20,21,3 BatchCont
0,31,37,43,46, CancExch= =
9 Cancellation True False False
48,49,55,56,6 Advice Cancellatio
advice 2,63 n
Cancellation in
batch
Batch Capture
No cancellation
requ. 4,5,11,20,21,3 BatchCont
1 0,31,37,43,46, CancExch= ≠
True False False
0 Cancellation 48,49,55,56,6 Advice Cancellatio
advice 2,63 n
Cancellation not in
batch
Batch Capture
Cancellation requ.
4,5,11,20,21,3 BatchCont
1 Canc. approved 0,31,37,43,46, CancExch= =
Appr. True True False False
1 Cancellation 48,49,55,56,6 Request Cancellatio
advice 2,63 n
Cancellation in
batch
Batch Capture
Cancellation requ.
4,5,11,20,21,3 BatchCont
1 Canc. approved 0,31,37,43,46, CancExch= ≠
Appr. True True False False
2 Cancellation 48,49,55,56,6 Request Cancellatio
advice 2,63 n
Cancellation not in
batch
AcceptorAutho
online authorisation 1 risationReques
t
Response:Declined
2
se ActionType:Referral
risationRespon
AcceptorAutho
TransactionCapture:True
AdditionalService:VoiceAuthorisation
3 AcceptorComple
TransactionSuccess:True b tionAdvice
ResponseToAuthorisation:Declined
AuthorisationCode:x...x
se
ionAdviceRespon
AcceptorComplet
2072 4. If the voice authorisation is declined, the transaction fails. The Acceptor must not send a capture,
2073 and has to follow the the standard process flow of the declined transactions for the Completion
2074 exchange (see section 5 Dynamic of the Payment Exchanges). If the transaction is sent in a
2075 completion or a batch, it contains the following informations:
2076 TransactionCapture present with the value "False".
2077 An occurrence of AdditionalService must be added and set to "VoiceAuthorisation",
2078 TransactionSuccess equal "False".
2079 AuthorisationResult.AuthorisationCode is absent.
2080 ResponseToAuthorisation.Response set to "Declined"
Acceptor Acquirer
AcceptorAutho
online authorisation 1 risationReques
t
Response:Declined
2
se ActionType:Referral
risationRespon
AcceptorAutho
TransactionCapture:False AcceptorComple
tionAdvice
AdditionalService:VoiceAuthorisation
TransactionSuccess:False
ResponseToAuthorisation:Declined se
ionAdviceRespon
AcceptorComplet
2082 The Acceptor is not necessary blocked between the declined/referral authorisation and the result of
2083 the Voice Authorisation. Other transactions may be interleaved between the declined/referral
2084 authorisation and the Completion containing the outcome of the Voice Authorisation. In the figure
2085 below:
2086 An AcceptorAuthorisationRequest is declined with the ActionType "Referral" (transaction 1);
2087 Another payment transaction is performed on the terminal with an online authorisation and a
2088 completion exchange (transaction 2);
2089 The Acceptor contact the voice authorisation center to get the authorsation code for
2090 transaction 1;
2091 The Acceptor initiates a Completion after entering the authorisation code.
Acceptor Acquirer
AcceptorAuthorisationReque
start transaction 1 st 1
Response:Declined
1 ActionType:Referral
AcceptorAuthorisationResponse
AcceptorAuthorisationReque
st 2
Response:Approved
2
AcceptorAuthorisationResponse
transaction 2
AcceptorCompletionAdvice 2
esponse 2
AcceptorCompletionAdviceR
2092 Figure 57: Successful Voice Authorisation Interleaved with another transaction
2093 An example of successful Voice Authorisation with Batch capture and no Completion is presented in
2094 the figure below. The batch contains one occurrence of TransactionToCapture with:
2095 AdditionalService = "VoiceAuthorisation",
2096 TransactionSuccess = "True",
2097 ResponseToAuthorisation.Response = "Declined",
2098 AuthorisationCode containing the code provided by phone.
Acceptor Acquirer
AcceptorAuthor
online authorisation isationRequest
Response:Declined
ActionType:Referral
isationResponse
AcceptorAuthor
TransactionToCapture[n]
AdditionalService:VoiceAuthorisation
AcceptorBatch
TransactionSuccess:True Tr ansfer
ResponseToAuthorisation:Declined
AuthorisationCode:x...x
ansferResponse
AcceptorBatchTr
2099 Figure 58: Successful Voice Authorisation Captured with Batch without Completion
2107 Deferred Payment is available in attended and unattended environments. This is widely used in the
2108 petrol environment. This is also called “Outdoor Petrol” when used in the specific petrol sector.
2109 The Authorisation and Completion exchanges are required to perform a deferred payment transaction.
Acceptor Acquirer
AcceptorAuthorisationRequ
est
maximum amount
maximum amount nse
AcceptorAuthorisationRespo
Delivery of goods
Use of service
AcceptorCompletionAdvice
final amount
se
AcceptorCompletionAdviceRespon
2111 During delivery of goods, other payment transactions can be performed, and the two steps of a
2112 deferred payment transaction (Authorisation exchange and Completion exchange) may be interleaved.
Acceptor Acquirer
AcceptorAuthorisationRequest
1
1
AcceptorAuthorisationResponse
AcceptorAuthorisationRequest
Delivery of goods 2
transaction 1
2
AcceptorAuthorisationResponse
AcceptorCompletionAdvice 1
Delivery of goods
nse 1
AcceptorCompletionAdviceRespo transaction 2
AcceptorCompletionAdvice
2
nse 2
AcceptorCompletionAdviceRespo
2114 A deferred payment transaction is characterised in the exchanged messages by the value
2115 "DeferredPayment" of the data element TransactionType.
AcceptorAuthorisationRequest
maximum amount
Response:Approved
AcceptorAuthorisationResponse
delivery of goods/service
AcceptorCompletionAdvice
TotalAmount:final amount
AcceptorCompletionAdviceResponse
AcceptorAuthorisationRequest
Response:Declined
maximum amount
AcceptorAuthorisationResponse
No delivery of goods/service
(if configured to not send
declined)
2145 5. If the authorisation is approved, the Completion exchange must be performed according to the
2146 configuration after the finalisation of the delivery of goods or service with:
2147 A value of TotalAmount lower or equal the value of TotalAmount sent in the
2148 AcceptorAuthorisationResponse,
2149 AmountQualifier absent or equal to "Actual".
2150 The configuration parameters of the Completion (TMS parameters
2151 OnlineTransaction.CompletionExchange or OfflineTransaction.CompletionExchange) as well
2152 as the CompletionRequired of the AuthorisationResponse are ignored.
2153 6. The financial capture must be performed either within the Completion exchange, or through a
2154 batch transfer. It cannot be performed as part of the Authorisation exchange.
Acceptor Acquirer
AcceptorAuthorisationRequest
maximum amount
Response:Approved
AcceptorAuthorisationResponse
Delivery of goods/
Use of service
AcceptorCompletionAdvice
TransactionCapture:True
onse
AcceptorCompletionAdviceResp
Acceptor Acquirer
AcceptorAuthorisationRequest
maximum amount
Response:Approved
AcceptorAuthorisationResponse
Delivery of goods/
Use of service
AcceptorCompletionAdvice
TransactionCapture:False
nse
AcceptorCompletionAdviceRespo
AcceptorBatchTr ansfer
e
AcceptorBatchTransferRespons
2157 7. After confirmation to the sale system that the goods can be delivered (e.g. after the payment
2158 response to the sale system of the Retailer protocol), if the goods or services have not been
2159 delivered because the customer did not continue or the delivery failed, an
2160 AcceptorCompletionAdvice message must be sent with:
2161 MessageFunction = "CompletionAdvice" or "FinancialCompletionAdvice",
2162 TotalAmount with the value "0",
2163 Reversal = "False",
2164 TransactionSuccess = "True",
2165 FailureReason = "CustomerCancel", "Malfunction".
Acceptor Acquirer
AcceptorAuthorisationRequest
maximum amount
Response:Approved
AcceptorAuthorisationResponse
No delivery of goods/service
AcceptorCompletionAdvice
TotalAmount:0
AcceptorCompletionAdviceResponse
2176 9. The following scenarios from the Table 3 - List of Payment Cases do not apply to the
2177 DeferredPayment type of transaction:
2178 All the offline authorisation cases are irrelevant (cases 47 to 63)
2179 All the cases where financial capture is performed during the
2180 authorisation (cases 1, 2, 6, 9,12, 13, 18, 22, 23, 28, 32, 35, 38, 41 and 44),
2181 The successful transaction cases where the completion is not required
2182 (cases 4, 20, and 30).
2222 This protocol shows two different methods for implementing gratuity :
2223 1. Gratuity is added before authorisation
2224 2. Gratuity is added after authorisation
2225 The cardholder must be present at the POI,PaymentContext.CardholderPresent=”True”.
2226 Whenever a gratuity amount is included in a message exchange it must be clearly identified in an
2227 instance of TransactionDetails.DetailedAmount as follows :
2228 Type=”Gratuity”
2229 Value=(gratuity amount)
2245 A reservation service is mostly used in hotels and for rental business (car, video …). The reservation
2246 service is implemented through one mandatory and four optional steps:
2299 A completion for an unsuccessful transaction must be sent under the following conditions:
2300 An approved authorisation is not correctly completed at card acceptor side
2301 There is no response to the authorization request
2302 The response of the authorization request is received too late:
2308 If the authorisation request is approved and correctly processed by the card acceptor:
2309 A completion must be sent
…
ValidityDate [0..1] Config The date after which the reservation expires
...
…
ValidityDate [0..1] Config
...
(in case of an invalid value, a Reject message is sent by the Recipient with
RejectReason equal to ParsingError)
…
CompletionAdvice [1..1] The Header.MessageFunction must be FinancialCompletionAdvice.
Transaction [1..1]
TransactionDetails [1..1]
…
ValidityDate [0..1] Config
...
Transaction [1..1]
TransactionDetails [1..1]
(in case of an invalid value, a Reject message is sent by the Recipient with
RejectReason equal to ParsingError)
…
CompletionAdvice [1..1] The Header.MessageFunction must be FinancialCompletionAdvice.
(if not the case, a Reject message is sent by the Recipient with
RejectReason equal to ParsingError)
…
Transaction [1..1] CCopy
…
TransactionType [1..1] “”CardPayment”
AdditionalService [1..1] “”NoShow”
…
2390 Some transactions may be handled in foreign currencies which makes difficult for a
2391 cardholder to estimate the actual amount he will have to pay in his own currency at the
2392 moment of the payment.
2396 The cardholder can accept or not the DCC service. When DCC is allowed by the
2397 merchant, the currency conversion is managed through a DCC service provider proposing
2398 to the cardholder the converted amount to be ultimately debited on his card.
2399 If the DCC service is refused by the cardholder, the transaction then proceeds as a
2400 normal card payment transaction in the currency of the merchant.
2401 The DCC service may be relying on an agent acting between the merchant and the DCC
2402 service provider. The following use cases involve agents in the process, but direct
2403 exchanges between a merchant and a DCC service provider or between a merchant and
2404 an acquirer do follow the same logic.
2405 The role of the DCC service provider can be played by any party (Agent, Acquirer, etc.).
2407 In this process, the Dynamic Currency Conversion service is implemented during the
2408 authorisation through an AcceptorAuthorisationRequest message (“implicit rate
2409 request”).
2410 The Acceptor or Agent asks the DCC service provider whether the card is eligible for a
2411 Dynamic Currency Conversion service or not.
2412 The actual authorisation is carried out either in the currency of the card or in the currency
2413 of the merchant depending on the outcome of the DCC process and the decision of the
2414 cardholder.
2415 The conversion service is carried out along the following steps:
2416 1. The Acceptor sends an AcceptorAuthorisationRequest message to an Agent or an
2417 Acquirer.
2418 2. The Agent or Acquirer detects whether the transaction is eligible for DCC and
2419 sends an AcceptorCurrencyConversionRequest message to the DCC service
2420 provider to ensure the eligibility of the card and to get the conversion rate for the
2421 transaction in case of eligibility.
2422 3. The DCC Provider answers with an AcceptorCurrencyConversionResponse
2423 message with the requested information.
2424 4. The Agent or Acquirer sends back an AcceptorAuthorisationResponse message to
2425 the Acceptor with the proposed currency conversion data when eligibility has been
2426 confirmed.
2427 5. The Cardholder accepts the proposed currency conversion.
2428 6. The Acceptor sends an AcceptorAuthorisationRequest message to the Agent or
2429 Acquirer with the accepted converted amount and all relevant information related
2430 to the conversion process.
2431 7. The Agent or Acquirer forwards the AcceptorAuthorisationRequest for
2432 authorisation.
2433 8. The next steps follow a normal transaction flow (i.e. Completion capture, batch
2434 capture, etc.) with some additional information related to the conversion process.
2435 9. If the DCC service was accepted by the cardholder, the Agent or Acquirer advises
2436 the DCC service provider with an AcceptorCurrencyConversionAdvice that the DCC
2437 transaction was completed
2438 10. The DCC service provider responses with an
2439 AcceptorCurrencyConversionAdviceResponse about the completion of the
2440 transaction on his side.
AcceptorCu
rrencyConv
ersionReques
t Transaction
eligible for
Respons e DCC
ncyConversion
AcceptorCurre
onse
orisationResp
DCC accepted or not AcceptorAuth
by Cardholder
AcceptorAuthori
sationRe quest Acquirer
Transaction
AcceptorAuthori authorised
sationRe quest either in the
currency of
the card or in
onse
orisationResp the currency
Transaction AcceptorAuth
of the
successfully
onse Acceptor
authorised either in orisationResp
AcceptorAuth
the currency of the
card or in the currency DCC Provider
of the Acceptor Next steps follow the normal Next steps follow the normal
transaction flow transaction flow
AcceptorCurrenc DCC
yConversion Advice Provider
informed
about the
AdviceR espons outcome of
ncyConversion e
AcceptorCurre the DCC
service
2442 6.7.2.1 Transaction eligible for DCC and DCC accepted by the Cardholder
2443 In this scenario, the transaction is considered eligible for DCC by the Agent and the DCC
2444 service provider. The Cardholder accepts the DCC service for the amount in the currency
2445 of his card presented to him. The transaction proceeds as a normal card payment
2446 transaction in the currency of the card.
2447 1. The Acceptor sends an AcceptorAuthorisationRequest message to an Agent. The
2448 message contains the following information :
2449 CurrencyConversion: absent.
2450 TransactionType : CardPayment, CashAdvance, Refund, Reservation,
2451 QuasiCash or DeferredPayment.
2452 AdditionalService : Cashback, Gratuity (if TransactionType = CardPayment)
2453 TransactionDetails.TotalAmount: Total Amount in the Acceptor’s currency.
2454 2. The Agent sends an AcceptorCurrencyConversionRequest to the DCC service
2455 provider with the following information :
2456 TransactionDetails.TotalAmount: Total Amount in the Acceptor’s currency.
2457 Card.CardCurrencyCode: Target currency (currency of the card).
2458 TransactionDetails.Currency: Source currency (currency of the Acceptor).
2459 TransactionCapture: not relevant.
2460 TransactionType : copy from AcceptorAuthorisationRequest.
2461 3. The DCC service provider answers with an AcceptorCurrencyConversionResponse
2462 message with the following information:
2463 Result of currency conversion: Allowed.
2464 Conversion details.
2465 4. The Agent sends back an AcceptorAuthorisationResponse to the Acceptor with the
2466 proposed currency conversion data and the response code “Declined” with the
2467 action type “AcceptCurrencyConversion”.
2468 5. The Cardholder accepts the proposed currency conversion.
2469 6. The Acceptor sends an AcceptorAuthorisationRequest with the following data:
2470 TransactionIdentification: copy of the original
2471 AcceptorAuthorisationRequest message
2472 TransactionType: copy of the original AcceptorAuthorisationRequest
2473 message.
2474 TransactionDetail.Currency: copy of Conversion.TargetCurrency of the
2475 original AcceptorAuthorisationResponse message.
2476 TransactionDetail.TotalAmount: copy of the Conversion.ResultingAmount of
2477 original AcceptorAuthorisationResponse message.
2478 AdditionalService: copy of original AcceptorAuthorisationRequest plus DCC.
2479 AcceptedByCardholder: True.
2480 CurrencyConversion: copy of AcceptorCurrencyConversionResponse
2481 message.
2482 7. The Agent forwards the AcceptorAuthorisationRequest message to the Acquirer.
2483 8. The next steps follow the normal transaction flow (i.e. Completion capture, batch
2484 capture, etc.) with some additional information related to the conversion process.
2485 9. The Agent or Acquirer advises the DCC service provider with an
2486 AcceptorCurrencyConversionAdvice that the DCC transaction was completed.
2487 10. The DCC service provider responses with an
2488 AcceptorCurrencyConversionAdviceResponse about the completion of the
2489 transaction on his side.
2490 Figure 67: Transaction eligible for DCC and DCC accepted by the Cardholder
2491 6.7.2.2 Transaction eligible for DCC and partially approved by the Issuer
2492 In this scenario, the transaction is considered eligible for DCC by the Agent and the DCC
2493 service provider. It is also assumed that the DCC service provider accept to deliver a
2494 catalogue of a range of amounts for which DCC is offered to the cardholder which would
2495 permit partial authorisation by the Issuer. The Cardholder accepts the DCC service for the
2496 amount in the currency of his card presented to him. The transaction is authorised by the
2497 Issuer but for a reduced amount in the currency of his card (PartialAuthorisation). The
2498 Cardholder accepts the transaction for this reduced amount. The transaction proceeds as
2499 a normal card payment transaction in the currency of the card and for the reduced
2500 authorised amount.
2501 1. The Acceptor sends an AcceptorAuthorisationRequest message to an Agent. The
2502 message contains the following information :
2503 CurrencyConversion: absent.
2504 TransactionType : CardPayment, CashAdvance, Refund, Reservation,
2505 QuasiCash or DeferredPayment.
2506 AdditionalService : Cashback, Gratuity (if TransactionType = CardPayment)
2507 TransactionDetails.TotalAmount: Total Amount in the Acceptor’s currency.
2508 2. The Agent sends an AcceptorCurrencyConversionRequest to the DCC service
2509 provider with the following information :
2510 TransactionDetails.TotalAmount: Total Amount in the Acceptor’s currency.
2511 Card.CardCurrencyCode: Target currency (currency of the card).
2512 TransactionDetails.Currency: Source currency (currency of the Acceptor).
2513 TransactionCapture: not relevant.
2514 TransactionType : copy from AcceptorAuthorisationRequest.
2515 3. The DCC service provider answers with an AcceptorCurrencyConversionResponse
2516 message with the following information:
2517 CurrencyConversionResult.Result: CATG (Conversion accepted for a range
2518 of amounts - rate and fees specific per range of amounts)
2519 Conversion details per range of amounts provided.
2520 4. The Agent sends back an AcceptorAuthorisationResponse to the Acceptor with the
2521 proposed currency conversion data ranges and the response code “Declined” with
2522 the action type “AcceptCurrencyConversion”.
2523 5. The Cardholder accepts the proposed currency conversion.
2524 6. The Acceptor sends an AcceptorAuthorisationRequest with the following data:
2525 TransactionIdentification: copy of the original
2526 AcceptorAuthorisationRequest message
2527 TransactionType: copy of the original AcceptorAuthorisationRequest
2528 message.
2529 TransactionDetail.Currency: copy of Conversion.TargetCurrency of the
2530 original AcceptorAuthorisationResponse message.
2531 TransactionDetail.TotalAmount: copy of the Conversion.ResultingAmount of
2532 original AcceptorAuthorisationResponse message.
2533 AdditionalService: copy of original AcceptorAuthorisationRequest plus DCC.
2534 AcceptedByCardholder: True.
2535 CurrencyConversion: copy of AcceptorCurrencyConversionResponse
2536 message
2537 7. The Agent forwards the AcceptorAuthorisationRequest message to the Acquirer.
2538 8. The Issuer authorised the transaction but for a reduced amount. The Acquirer
2539 sends back an AcceptorAuthorisationResponse message to the Agent. The Agents
2540 computes the actual amount to be presented to the cardholder (after computation
2541 of fees and taking into account the reduced authorised amount by the Issuer) and
2542 forwards the amended message to the Acceptor. The Acceptor presents to the
2543 cardholder the reduced authorised amount after the withdrawal of fees and in the
2544 currency of his card.
2545 9. The Cardholder accepts the DCC transaction for the proposed reduced authorised
2546 amount in the currency of his card.
2547 10. The Acceptor sends an AcceptorAuthorisationRequest message to the Agent for
2548 the reduced amount which is then forwards to the Acquirer.
2549 11. The next steps follow the normal transaction flow (i.e. Completion capture, batch
2550 capture, etc.) with some additional information related to the conversion process.
2551 12. The Agent or Acquirer advises the DCC service provider with an
2552 AcceptorCurrencyConversionAdvice that the DCC transaction was completed but
2553 for a reduced amount. The details of the reduced amount accepted by the
2554 cardholder are provided to the DCC service provider.
2555 13. The DCC service provider responses with an
2556 AcceptorCurrencyConversionAdviceResponse about the completion of the
2557 transaction on his side.
2558 Figure 68: Transaction eligible for DCC and partially approved by the Issuer
-
2559 6.7.2.3 Transaction not eligible for DCC by the DCC service provider
2560 In this scenario, the transaction is considered eligible for DCC by the Agent but not by the
2561 DCC service provider. The cardholder is not offered the DCC service and the transaction
2562 proceeds as a normal card payment transaction in the currency of the merchant.
2563 1. The Acceptor sends an AcceptorAuthorisationRequest message to the Agent with
2564 the following information.
2565 CurrencyConversion : absent.
2566 TransactionType : CardPayment, CashAdvance, Refund,
2567 Reservation, QuasiCash or DeferredPayment.
2568 AdditionalService : Cashback, Gratuity (if TransactionType =
2569 CardPayment)
2570 TransactionDetails.TotalAmount: Total Amount in the Acceptor’s
2571 currency.
2572 2. The Agent sends an AcceptorCurrencyConversionRequest message to the DCC
2573 Provider with the following information.
2574 Card.CardCurrencyCode: Target currency (currency of the card).
2575 TransactionDetails.Currency: Source currency (currency of the
2576 Acceptor).
2577 TransactionCapture: not relevant.
2578 TransactionType : copy from AcceptorAuthorisationRequest.
2579 3. The DCC service provider answers with an AcceptorCurrencyConversionResponse
2580 message with the following information:
2581 Result: InvalidCard, NoRate, InvalidMerchant, NotAvailable or
2582 InvalidProduct.
2583 Conversiondetails: absent.
2584 4. The Agent sends an AcceptorAuthorisationRequest message to the Acquirer in the
2585 currency of the Acceptor.
2586 5. The Acquirer sends back an AcceptorAuthorisationResponse to the Agent.
2587 6. The Agent forwards the AcceptorAuthorisationResponse to the Acceptor.
2588 7. The next steps follow the normal transaction flow (i.e. Completion capture, batch
2589 capture, etc.).
Card
eligible for
AcceptorAuth DCC as per Card not
orisationRequ
est eligible or
agent
DCC denied
AcceptorCu by DCC
rrencyConv
ers ionRequest Provider
nResponse
encyConversio
AcceptorCurr
Acquirer
AcceptorAuth
Transaction orisationRequ
est
carried out in Transaction
currency of the authorised
Acceptor nse in the
risationRespo
Transaction AcceptorAutho currency of
the
successfully sponse
thorisationRe Acceptor
authorised in AcceptorAu
the currency of
the Acceptor Next steps follow Next steps follow DCC Provider
the normal the normal
transaction flow transaction flow
AcceptorCurr Confirmation
encyConvers ionAdvice that DCC
transaction
denied by
thorisation Response DCC
AcceptorAu Provider
2590 Figure 69: Transaction not eligible for DCC by DCC service provider
AcceptorAutho
risationRequest
DCC Provider
unaware of the
DCC request
transaction is
not eligible or
line to DCC
Provider is not
up and running
Acquirer
AcceptorAutho
risationRequest
onse
orisationResp
Transaction AcceptorAuth
successfully
onse
authorised in orisationResp
AcceptorAuth
the currency of
the Acceptor Next steps follow Next steps follow
the normal the normal
transaction flow transaction flow
2615 6.7.2.5 Transaction eligible for DCC but DCC refused by the Cardholder
2616 In this scenario, the transaction is considered eligible for DCC by the Agent and the
2617 DCC service provider. The cardholder refused the DCC service for the amount
2618 presented to him in the currency of his card. The transaction proceeds as a normal
2619 card payment transaction in the currency of the merchant.
AcceptorAuthori
sationRequest
AcceptorCu
rren cyConversio
nRequest
Transaction
Transaction eligible for
eligible for DCC Response DCC
ncyConversion
conversion AcceptorCurre conversion
se
ptorA uth or isationRespon
DCC refused by Acce
cardholder AcceptorAuthori
sationRequest Acquirer
AcceptorAuthori
sationRequest
onse
orisationResp
Transaction AcceptorAuth
successfully onse
orisationResp
authorised in AcceptorAuth
the currency of
DCC Provider
the Acceptor
Next steps follow the normal Next steps follow the normal
transaction flow transaction flow
AcceptorCurrenc
yConversionAd
vice
Resp onse
ionAdvice
yConvers
Currenc
Acceptro
2659 Figure 71: Transaction eligible for DCC but DCC refused by cardholder
2660 6.7.2.6 Transaction eligible for DCC but interrupted due to an incident
AcceptorAuthori
sationRequest
DCC Provider
unaware of
DCC conversion
Response of AcceptorA
Agent not uthorisatio
received or nResponse
corrupted
Acquirer
AcceptorAuthori
sationRequest
AcceptorAuthori
sationRequest Transaction
Transaction authorised
carried out in in the
currency of the currency of
risation Response
Transaction Acceptor AcceptorAutho the Acceptor
successfully
nse
authorised in risationRespo
the currency of AcceptorAutho
the Acceptor
Next steps follow the normal Next steps follow the normal
transaction flow transaction flow
Response of
DCC service AcceptorC
provider not urrencyCo
nversionRe
received or sponse
corrupted
Acquirer
AcceptorAuth
Transaction orisationRequ
est
carried out in Transaction
currency of the authorised in
nse the currency
Acceptor risationRespo
Transaction AcceptorAutho of the
successfully sponse Acceptor
thorisationRe
authorised in AcceptorAu
the currency of
the Acceptor
Next steps follow the normal Next steps follow the normal
DCC Provider
transaction flow transaction flow
AcceptorCu
rrencyConv
ers ionAdvice
ionAdvice Respons
encyConvers e
AcceptorCurr
2728 In this process, the Dynamic Currency Conversion service is implemented prior to the
2729 authorisation actually taking place and through an AcceptorCurrencyConversion
2730 exchange (“explicit rate request”)
2731 The Acceptor or Agent asks the DCC service provider whether the card is eligible for a
2732 Dynamic Currency Conversion service or not.
2733 The actual authorisation is carried out either in the currency of the card or in the currency
2734 of the merchant depending on the outcome of the DCC process and the decision of the
2735 cardholder.
2736 The conversion service is carried out along the following steps:
2737 1. The Acceptor sends an AcceptorCurrencyConversionRequest message to an Agent
2738 or an Acquirer to ask whether the card is eligible for a currency conversion.
2739 2. The Agent or Acquirer detects whether the transaction is eligible for DCC and, if
2740 eligible, forwards the AcceptorCurrencyConversionRequest message to the DCC
2741 service provider to ensure eligibility of the card and to get the conversion rate for
2742 the transaction.
2743 3. The DCC service provider answers with an AcceptorCurrencyConversionResponse
2744 message with the requested information.
2745 4. The Agent or Acquirer forwards the AcceptorCurrencyConversionResponse
2746 message to the Acceptor with the proposed currency conversion data.
2747 5. The Cardholder accepts the proposed currency conversion.
2748 6. The Acceptor sends an AcceptorAuthorisationRequest message to the Agent or
2749 Acquirer with the accepted converted amount and all relevant information related
2750 to the conversion process.
2751 7. The Agent or Acquirer forwards the AcceptorAuthorisationRequest message for
2752 authorisation.
2753 8. The next steps follow a normal transaction flow (i.e. Completion capture, batch
2754 capture, etc.) with some additional information related to the currency conversion
2755 process.
2756 9. The Agent or Acquirer advises the DCC service provider with an
2757 AcceptorCurrencyConversionAdvice message that the DCC transaction was
2758 completed.
2759 10. The DCC service provider responses with an
2760 AcceptorCurrencyConversionAdviceResponse message about the completion of
2761 the transaction on his side.
AcceptorCurrenc
yConversionRe
que st
AcceptorCu
rrencyConv
ersionReques
t
DCC eligible
Response
ncyConversion
AcceptorCurre
onse
orisationResp
DCC accepted or not AcceptorAuth
AcceptorAuthori
by Cardholder sationRequest
AcceptorAuthori Acquirer
sationRe quest
Transaction
authorised
onse either in the
orisationResp
AcceptorAuth currency of the
Transaction card or in the
onse
successfully orisationResp currency of the
AcceptorAuth
authorised either in Acceptor
the currency of the
card or in the currency
of the Acceptor Next steps follow the normal Next steps follow the normal
transaction flow transaction flow
DCC Provider
AcceptorCurrenc
yConversion Advice Confirmation
of DCC
accepted or
AdviceR espons denied
ncyConversion e
AcceptorCurre
2763 6.7.3.1 Transaction eligible for DCC and DCC accepted by the Cardholder
2764 In this scenario, the transaction is considered eligible for DCC by both the Agent and
2765 the DCC service provider. The cardholder accepts the DCC service for the amount
2766 presented to him in the currency of his card. The transaction proceeds as a normal
2767 card payment transaction in the currency of the card.
AcceptorCurrenc
yConversionRe
que st
Transaction is AcceptorCu
rrencyConv
eligible for DCC ersionReques Transaction
t
conversion eligible for
DCC
Response
ncyConversion conversion
AcceptorCurre
sionRespon se
rencyConver
AcceptorCur
DCC accepted by
Cardholder AcceptorAuthori
sationRe quest Acquirer
AcceptorAuthori
sationRe quest Transaction
authorised in
the currency of
on se
orisationResp the card
AcceptorAuth
onse
orisationResp
Transaction AcceptorAuth
successfully
authorised in the
currency of the card
Next steps follow the normal Next steps follow the normal
transaction flow transaction flow
DCC Provider
AcceptorCurrenc
yConversion Advice Confirmation
of DCC
accepted
AdviceR espons
ncyConversion e
AcceptorCurre
2813 Figure 75: Transaction eligible for DCC and DCC accepted by the Cardholder
2814 6.7.3.2 Transaction eligible for DCC and partially approved by the Issuer
2815 In this scenario, the transaction is considered eligible for DCC by the Agent and the
2816 DCC service provider. It is also assumed that the DCC service provider accept to
2817 deliver a catalogue of a range of amounts for which DCC is offered to the cardholder
2818 which would permit partial authorisation by the Issuer. The Cardholder accepts the
2819 DCC service for the amount in the currency of his card presented to him. The
2820 transaction is authorised by the Issuer but for a reduced amount in the currency of
2821 his card (PartialAuthorisation). The Cardholder accepts the transaction for this
2822 reduced amount. The transaction proceeds as a normal card payment transaction in
2823 the currency of the card and for the reduced authorised amount.
AcceptorCurrenc
yConversionRe
que st
AcceptorCu
rrencyConv Transaction
Transaction ersionReques
t
eligible for DCC eligible for
conversion DCC
Response conversion
ncyConversion
AcceptorCurre
sionRespon se
rencyConver
AcceptorCur
Acquirer
AcceptorAuthori
sationRequest
DCC accepted by
Cardholder AcceptorAuthori Transaction
sationRe quest authorised
Agent computes actual amount to for a
be presented to the Cardholder on se reduced
orisationResp
AcceptorAuth amount
onse
Cardholder accepts orisationResp
the reduced AcceptorAuth
authorised amount AcceptorComple
tionAdvice
Agent acknowledges acceptance of the
partial authorised amount by the
Cardholder
Response
pletionAdvice DCC Provider
AcceptorCom
AdviceR espons
ncyConversion e
AcceptorCurre
2883 Figure 76: Transaction eligible for DCC and partially approved by the Issuer
2884 6.7.3.3 Transaction not eligible for DCC by DCC service provider
2885 In this scenario, the transaction is considered eligible for DCC by the Agent but not by the
2886 DCC service provider. The cardholder is not offered the DCC service and the transaction
2887 proceeds as a normal card payment transaction in the currency of the merchant.
2888 1. The Acceptor sends an AcceptorCurrencyConversionRequest message to the
2889 Agent with the following information:
2890 CurrencyConversionResult: absent
2891 TransactionType : CardPayment, CashAdvance, Refund, Reservation,
2892 QuasiCash or DeferredPayment
2893 AdditionalService : Cashback, Gratuity (if TransactionType = CardPayment)
2894 TransactionDetails.TotalAmount: Total Amount in the Acceptor’s currency.
2895 2. The Agent detects that the transaction is eligible for DCC and forwards the
2896 AcceptorCurrencyConversionRequest message to the DCC service provider with
2897 the following information:
2898 Card.CardCurrencyCode: Target currency (currency of the card).
2899 TransactionDetails.Currency: Source currency (currency of the Acceptor).
2900 TransactionCapture: not relevant.
2901 TransactionType : copy from AcceptorCurrencyConversionRequest
2902 message
AcceptorCurrenc
yConversionRe
que st
Transaction AcceptorCu
rrencyConv
eligible for DCC ersionReques Transaction
t
conversion not eligible
for DCC
Response
ncyConversion conversion
AcceptorCurre
sionRespon se
rencyConver
AcceptorCur
Acquirer
AcceptorAuthori
sationRe quest
Transaction
AcceptorAuthori
sationRe quest authorised
in the
currency of
on se the
orisationResp
Transaction AcceptorAuth Acceptor
successfully onse
orisationResp
authorised in the AcceptorAuth
currency of the
Acceptor DCC Provider
Next steps follow the normal Next steps follow the normal
transaction flow transaction flow
AcceptorCur
rencyConver Confirmation
sionAdvice
to DCC
Provider of
non-currency
Response
ncyConversion conversion
AcceptorCurre
2930 Figure 77: Transaction not eligible for DCC by DCC service
AcceptorCurr
encyConversio
nRequest
transaction is
not eligible or
line to DCC
Provider is not
operational
onse
rsionResp
DCC not rC ur re ncyConve
Accep to Acquirer
proposed to the AcceptorAuth
Cardholder orisationReque
st
AcceptorAuth
orisationReque Transaction
st
authorised
in the
currency of
thorisatio nResponse the
Transaction AcceptorAu Acceptor
successfully
thorisatio nResponse
authorised in AcceptorAu
the currency of
the Acceptor
Next steps follow the normal Next steps follow the normal
transaction flow transaction flow
2968 Figure 78: Transaction not eligible for DCC by the Agent
2969 6.7.3.5 Transaction eligible for DCC but DCC refused by the Cardholder
2970 In this scenario, the transaction is considered eligible for DCC by both the Agent and the
2971 DCC service provider. The cardholder refused the DCC service for the amount presented
2972 to him in the currency of his card. The transaction proceeds as a normal card payment
2973 transaction in the currency of the merchant.
3014 10. The Agent or Acquirer advises the DCC service provider with an
3015 AcceptorCurrencyConversionAdvice that the DCC transaction was refused by the
3016 Cardholder.
3017 11. The DCC service provider responses with an
3018 AcceptorCurrencyConversionAdviceResponse about the completion of the
3019 transaction on his side
transaction
AcceptorCurr
encyConv ersionRequest eligible to DCC
AcceptorCurr
encyConversio
nR equest
transaction
eligible to
e
encyConv ersionRespons DCC
AcceptorCurr
ponse
versionRes
eptorC urrencyCon
Acc
Cardholder refuses AcceptorAuth
orisationReque Acquirer
DCC st
AcceptorAuth Transaction
orisationReque
st authorised
in the
esponse currency of
thorisationR
AcceptorAu the
es ponse Acceptor
thorisationR
Transaction AcceptorAu
successfully DCC Provider
authorised in Next steps follow the normal Next steps follow the normal
the currency of transaction flow transaction flow DCC
the Acceptor Provider
AcceptorCurr informed
encyConversio
nA dvice
DCC
refused by
nAdviceRe Cardholder
encyConversio
AcceptorCurr sponse
3020 Figure 79: Transaction eligible for DCC but DCC refused by the Cardholder
3021 6.7.3.6 Transaction eligible for DCC but interrupted due to an incident
AcceptorCurr
encyConversion
Request
AcceptorC
Response of urrencyCo
Agent not nversionRe
received or sponse
corrupted
Acquirer
AcceptorAuth
orisationRequ
est
AcceptorAuth
orisationReque
st
Transaction
carried out in
Transaction
currency of the
successfully
Acceptor Response
authorised in risation
AcceptorAutho
the currency of
sponse
the Acceptor thorisationRe
AcceptorAu
Next steps follow the normal Next steps follow the normal
transaction flow transaction flow
3101 14. The Agent forwards the AcceptorAuthorisationRequest message to the Acquirer in
3102 the Acceptor’s currency
3103 15. The next steps follow the normal transaction flow (i.e. Completion capture, batch
3104 capture, etc.).
3105 16. The Agent or Acquirer advises the DCC service provider with an
3106 AcceptorCurrencyConversionAdvice message that the DCC transaction did not
3107 succeed.
3108 17. The DCC service provider responses with an
3109 AcceptorCurrencyConversionAdviceResponse message about the completion of
3110 the transaction on his side.
3111
Card
AcceptorCurrenc eligible for
yConversionRequ DCC
est
AcceptorCu
rrencyConve
rsionRequest
AcceptorC
Response of DCC urrencyCo
service provider nversionRe
nse not received or sponse
ncyCo nversionRespo corrupted
Transaction AcceptorCurre
Acquirer
proceeds in the
currency of the AcceptorAuthori
Acceptor sationRequest Transaction
AcceptorAuthori authorised in
sationRequest
the currency
Transaction carried out
of the
in currency of the
nse Acceptor
Acceptor risationRespo
AcceptorAutho
Transaction nse
risationRespo
successfully Ac ceptorAutho
DCC Provider
authorised in
the currency of Next steps follow the normal Next steps follow the normal DCC
the Acceptor transaction flow transaction flow Provider
AcceptorCu informed
rrencyConve that
rsionAdvice
currency
conversion
spons
ionAdviceRe
encyConvers e not
AcceptorCurr
provided
3115 a. TransactionDetails.TotalAmount
3116 b. TransactionDetails.Currency
3117 The Totals should be computed by Currency if the parameter TotalsPerCurrency in the
3118 AcceptorComfigurationUpdate is set to True
3120 The Aggregation service allows the acceptor to aggregate transactions when its business activity
3121 lends it to the accumulation of multiple purchases.
3122 A single payment transaction is presented for remittance to group a customer’s activity over a defined
3123 period.
3127 Depending on the application requirements the AggregationTransaction component should be present
3128 to describe the aggregated transaction and/or the detail of all the payments.
3138 In order to carry such data elements the nexo Acquirer Protocol provides a message type
3139 IndustryData1 to convey these data elements
3157 Rules:
3158 The Card Payment Invoice is conveyed in the AdditionalInformation of the TransactionDetails
3159 Since the card payment invoice must be interoperable, the Identification data element is
3160 defined by the nexo Acquirer Protocol MUG and must be set to “nexo Card Payment Invoice
3161 V1.0”.
3162 The Type data element must be present and must be set to a value defined in the following
3163 values :
3164 o “Nexo payment invoice”
3165 o Others values will be added when required
3166 Either Value or ProtectedValue must be present and contain the card payment invoice
3167 exchanged by the parties
3168 The structure of the exchanged data is defined in :
3169 o The Annex V8 for Type = “Nexo payment invoice”
3170 o Other references will be addes for other Type values
3183 The Application Protocol is independent of the Transport Protocol, and can be used without
3184 modification with various Transport Protocols, except where the interface to the Transport Services
3185 needs specific information such as the transport addresses.
3186 The Transport Protocol and the Application Protocol are also independent of the communication
3187 infrastructure used below these layers, with the exception of the quality of service of the
3188 communication which may involve tuning of some values of the configuration parameters (e.g. value of
3189 timeout).
3190 The Transport Protocol is a standard protocol allowed by the Application Protocol. Application
3191 Protocol requires the Transport Services which can be used by the Application Protocol, and specifies
3192 the way to use them.
3193 If a standard Transport Protocol used by the Application Protocol does not offer a particular Transport
3194 Service required by the Application Protocol, the Application Protocol specifies this Service through a
3195 Transport Adaptation Layer. This is for instance the case for the application message delimitation,
3196 which is a service not provided by the TCP Transport Protocol, but required for the decoding of a XML
3197 message before delivering it to the Application Layer. It could be also be used to provide a particular
3198 flow control.
Transport Services
message delimitation,
flow control...
Transport AdaptationLayer
Transport
Layer
Standard Transport Layer
3200 As far as transport services and their usage are defined, the definition in future of a new Transport
3201 Protocol compliant to the defined Transport Service, will not impact the specifications of the
3202 Application Protocol.
3203 For the current specification the only selected transport protocol is TCP (Transmission Control
3204 Protocol, specified in the RFC 793).
. .
Connection
Establishment
Data
Transfer
Connection
Release
3270 These services are usually done by transport primitives’ services through various implementations:
3271 Connection Request: to send an outgoing request in order to establish a transport connection
3272 (done by the Initiating Party).
3273 Connection Indication: for the receipt an incoming request from the Initiating Party to establish
3274 a transport connection (done by the Recipient Party).
3275 Connection Response: to send the positive or negative response to the incoming request for
3276 the transport connection establishment (done by the Recipient Party).
3277 Connection Confirmation: for the receipt an incoming response from the Recipient Party to the
3278 previous outgoing request for the transport connection establishment (done by the Initiating
3279 Party).
3280 Data Request: to send an outgoing request containing data to deliver to the other peer of a
3281 transport connection (done by the Initiating Party or the Recipient Party).
3282 Data Acknowledgment: for the receipt an incoming request informing the sender of a Data
3283 Request that the transport layer has sent the related data (done by the Initiating Party or the
3284 Recipient Party).
3285 Data Indication: for the receipt an incoming request containing data delivered by the other
3286 peer of a transport connection (done by the Initiating Party or the Recipient Party).
3287 Disconnection Request: to send an outgoing request in order to release a transport connection
3288 (done by the Initiating Party or the Recipient Party).
3289 Disconnection Indication: for the receipt an incoming request to release a transport connection
3290 (done by the Initiating Party or the Recipient Party).
connection
connect conf response
connection
confirmation
data reques
t
data
data data
ent indication
acknowledgm
data request
data
data data
indication acknowledg
ment
disconnectio
n disc req
request disconnectio
n
indication
processing of
the service
se
Message Respon
service result
3302 notifies a particular event to the Recipient Party, the response message is then an acknowledgement
3303 sent to the Initiating Party.
3304 A pair of request and response messages is identified unambiguously. If a request message is
3305 repeated with the same identifier, (e.g. in case of error, or if the response message have not been
3306 received), depending on the application protocol specification, it may be refused by the Recipient Party
3307 or generate the same response message.
Application
time-out Processing
Message response 4
TC2:
Disconnection
request
Disconnection reques
5 t
t Accept disconnection
Disconnection reques 6
3 data
data data
request (Message Request) indication
data
t Processing
Application
time-out
acknowledgmen
data data 4
data request
(Message Response)
indication
data TC2:
acknowledg
ment Disconnection
request
disconnection disc req
5 disconnection
request
indication
Accept disconnection
disc req disconnection 6
confirmation
3334 Figure 91: Single Message Pair Exchange Transport Primitives Sequence Flow
Connection resp
Message request
1
Processing request 1
2 Message response
1
TC3:
Inactivity
Message request
3 2
Processing request 2
Arms inactivity TC3 4 Message response
2
no activity
on the connection
t
Disconnection reques
data
data data
request
(Message Request 1) indication
data
t Processing request 1
acknowledgmen
data data
data request
2 (Message Response 1)
Arms inactivity TC3 indication
data
acknowledgmen
t
3 data
Desarms inactivity TC3 data data
request
(Message Request 2) indication
data
t Processing request 2
acknowledgmen
data data
data request
Arms inactivity TC3 4 (Message Response 2)
indication
data
no activity acknowledgmen
on the connection
t
3368 Figure 93: Multiple Message Pair Exchange Transport Primitives Sequence Flow
3417 Definition
3418 The transport layer is unable to establish the transport connection that the application layer has
3419 requested to open, because:
3420 The lower protocol layer has notified an “out of service” communication state as permanent or
3421 in response to the attempt to open the connection.
3422 The TC1 timer has expired, and the connection in progress is considered as broken (the
3423 connection establishment as a failure).
3424 The Recipient Party has denied the connection request.
3425 The transport layer has reached the maximum number of concurrent connections it can
3426 manage.
3431 Definition
3432 The transport layer realises that an open connection is broken. Several reasons may cause this error:
3433 The transport layer receives an unexpected disconnection request.
3434 An error occurred at a lower level while the transport layer waits for the end of a message
3435 after the receipt of the length prefix and incomplete data units.
3436 The lower level notifies the transport layer that a defect occurs (e.g. on the physical interface),
3437 and the transport connection is broken.
3438 The remote peer has not respected the state diagram of the connection management. The
3439 Initiating Party has sent data after sending the message request but before the Recipient
3440 Party has finished sending the message response. The Recipient Party sends data before the
3441 Initiating Party has finished sending the message request.
3442 The remote peer has released the transport connection.
3443 A connection deemed to be inactive when TC2 expires. The connection seems to be forgotten
3444 by the Initiating Party, and the Recipient Party closes the transport connection at the
3445 expiration of the TC2.
3450 Definition
3451 The transport layer cannot send an application message. Several reasons may cause this error:
3452 An error occurred at a lower level when the transport layer sends an application message at
3453 the request of the application layer.
3454 The connection was broken just before the sending of the message, and the application layer
3455 did not receive the disconnection notification before the request to the transport layer to send
3456 a message.
3457 The remote peer is not ready to receive data. The Recipient Party has not yet received the
3458 message request. The Initiating Party has not received the connection confirmation or has not
3459 yet received the message response.
3466 Definition
3467 The transport layer cannot receive an application message, because the prefix contains a message
3468 length above the limit of the transport layer memory.
3478 Definition
3479 The transport service layer receives a data unit for the application after a timeout has expired and
3480 before the request for a disconnection.
3481 The application layer must also handle this error.
3482 The drawing below shows such error example, when the application timeout on the message response
3483 expires.
Initiating Party Recipient Party
data data
sponse) request
Application timer (Messag e Re
expires data acknow
-
ledgement
disc req
disconnectio
n
indication
n
disc req disconnectio
confirmation
3493 Definition
3494 If, on the arrival of an incoming connection request,the transport service layer cannot open a new
3495 transport connection this error will be returned to the Application Layer. This could occur, for example,
3496 when the Application or Transport Layer has reached the maximum number of concurrent transport
3497 connections it can handle.
3505 Definition
3506 After the receipt of an application message header, the transport layer arms the timeout TC4 to
3507 monitor the receipt of the complete application message.
3508 This error will be triggered if the TC4 timer expires before the end of the application message is
3509 received, and might happen:
3510 When a serious error occurs on a lower communication level or on the communication
3511 infrastructure between the 2 peers.
3512 The remote transport or application layer encounters a serious error, or is out of order.
3527 This section summarises the set of configuration parameters required by the transport service
3528 management. These parameters are configurable and may be downloaded using the EPAS TMS
3529 protocol or another proprietary means. These values depends first upon the communication
3530 infrastructure.
Name TC1
Definition Transport connection establishment timer
Owner Initiating Party of a transport connection establishment
Usage After the sending of a transport connection request, the Initiating Party arms the TC1 timer to wait
for the response from the Recipient Party. TC1 is reset on the transport connection confirmation
being received..
Specification 8.3.3 Single Message Pair Exchange
Name TC2
Definition Transport connection idle timer
Owner Recipient Party of a transport connection
Usage Keeping open transport connections which are not being used by the Initiating Party.
After the receipt of a message request or sending of a message response, the Recipient Party arms
the TC2 timer to wait for the use of this transport connection. TC2 must be disarmed when a new
message is sent across this connection.
This timer has to be long enough to not interfere with the TC3 timer
Specification 8.3.3 Single Message Pair Exchange
Name TC3
Definition Transport connection activity timer
Owner Initiating Party on a transport connection
Usage This timer is armed by the Initiating Party before the release of a transport connection, to wait for a
new message request to send. It is armed when a response message is received and disarmed
when a new request is sent. Expiry of the timer triggers a request to close the idle connection.
It avoids the management of permanent transport connections between remote peers, the
multiplexing of message exchanges, and the re-connection for every message exchange.
Specification
Name TC4
Definition Application message receipt timer
Owner Initiating Party or Recipient Party on a transport connection
Usage This timer is armed by the Initiating Party or Recipient Party at the receipt of the application
message prefix to supervise the receipt of the complete application message. It is armed at the
receipt of a message header and disarmed when the message is complete.
It allows the detection of an incomplete application message.
Specification 8.3.7.7 Incomplete Application Message
3537 States
3538 The Recipient Party may have the following states:
3539 Await Request: The Recipient Party has received a connection request, and sent the
3540 connection confirmation. The connection is established. No message pair exchange is in
3541 progress. The Recipient Party waits for the beginning of a message request, or a disconnect
3542 request.
3543 Receiving: The Recipient Party has received the beginning of a message request, which is not
3544 complete yet.
3545 Responding: The Recipient Party has received a complete message request. The transport
3546 adaptation layer waits for application layer to send the message response.
3547 Events
3548 The Recipient Party may receive the following events:
3549 CON_IND: The Recipient Party receives a connection indication from the network.
3550 DATA_IND: The Recipient Party receives data.
3551 DATA_REQ: The Recipient Party application layer wants to send data.
3552 TC2, TC4: The timer TC2 (respectively TC4) has expired.
3553 Error: There is an error situation, such as receiving a disconnection request from the network
3554 or the application layer, a message that is too big, or other errors.
3555 Diagram
CON_IND / DATA_IND [complete msg] /
Await
CON_RES, start TC2 DATA_IND, restart TC2 Responding
Request DATA_REQ /
DATA_REQ, restart TC2
TC2, DATA_IND DATA_IND,
Error / [uncomplete msg] TC2,
DISC_REQ / stop TC2, DATA_IND Error /
start TC4 [uncomplete msg] DATA_IND DISC_REQ
[complete msg]
/ DATA_IND,
start TC2
Receiving
TC4,
Error /
DISC_REQ
3558 States
3559 The Initiating Party may have the following states:
3560 Connecting: The Initiating Party has sent a connection request, and waits the positive or
3561 negative answer to that request.
3562 Connected: The Initiating Party has received a connection confirmation, positive response,
3563 and the transport connection is established. No message pair exchange is in progress. The
3564 transport adaptation layer waits for application layer to send a message request.
3565 Await Response: The Initiating Party has sent the message request, and has not received any
3566 part of the response message.
3567 Receiving: The Initiating Party has sent the message request, and has received the beginning
3568 of the response message which is not complete yet.
3569 Events
3570 The Initiating Party may receive the following events:
3571 CON_REQ: The Initiating Party application layer wants to send a connection request.
3572 CON_CNF: The Initiating Party receives a connection confirmation.
3573 DATA_REQ: The Initiating Party application layer wants to send data.
3574 DATA_IND: The Initiating Party receives data.
3575 TC1, TC4: The timer TC1 (resp. TC4) has expired.
3576 Error: There is an error situation, such as receiving a disconnection request from the network
3577 or the application layer, a message that is too big, or other errors.
3578 Diagram
DATA_REQ /
stop TC3, DATA_REQ
CON_CNF / Await
Connecting Connected
stop TC1 DATA_IND [complete msg, mult msg Response
pair] / DATA_IND, start TC3
TC1, DATA_IND, DATA_IND
TC3, Error / Error /
Error / [uncomplete msg] DISC_REQ
DISC_REQ DISC_REQ DATA_IND / start TC4
DATA_IND [uncomplete msg]
[complete msg,
mult msg pair]
/ stop TC4
DATA_IND Receiving
start TC3
DATA_IND
[complete msg, TC4,
single msg pair] Error /
/ DISC_REQ, DISC_REQ
DATA_IND