pacs.004.001.05
Scope The PaymentReturn message is sent by an agent to the previous agent in the payment chain to undo a payment previously settled. Usage The PaymentReturn message is exchanged between agents to return funds after settlement of credit transfer instructions (i.e. FIToFICustomerCreditTransfer message and FinancialInstitutionCreditTransfer message) or direct debit instructions (FIToFICustomerDirectDebit message). The PaymentReturn message should not be used between agents and non-financial institution customers. Non-financial institution customers will be informed about a debit or a credit on their account(s) through a BankToCustomerDebitCreditNotification message (’notification’) and/or BankToCustomerAccountReport/BankToCustomerStatement message (‘statement’). The PaymentReturn message can be used to return single instructions or multiple instructions from one or different files. The PaymentReturn message can be used in domestic and cross-border scenarios. The PaymentReturn message refers to the original instruction(s) by means of references only or by means of references and a set of elements from the original instruction.
Message Construction
Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification
classDiagram
direction LR
%% PaymentReturnV05 recursion level 0 with max 0
PaymentReturnV05 *-- "1..1" GroupHeader54 : GroupHeader
PaymentReturnV05 *-- "0..1" OriginalGroupHeader2 : OriginalGroupInformation
PaymentReturnV05 *-- "0..1" PaymentTransaction50 : TransactionInformation
PaymentReturnV05 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Set of characteristics shared by all individual transactions included in the message. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% GroupHeader54 recursion level 0 with max 1
class GroupHeader54{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
BatchBooking IsoBatchBookingIndicator
NumberOfTransactions IsoMax15NumericText
ControlSum IsoDecimalNumber
GroupReturn IsoTrueFalseIndicator
TotalReturnedInterbankSettlementAmount IsoActiveCurrencyAndAmount
InterbankSettlementDate IsoISODate
}
GroupHeader54 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader54 *-- "1..1" SettlementInstruction1 : SettlementInformation
GroupHeader54 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
GroupHeader54 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% SettlementInstruction1 recursion level 1 with max 1
class SettlementInstruction1{
SettlementMethod SettlementMethod1Code
}
SettlementInstruction1 *-- "0..1" CashAccount24 : SettlementAccount
SettlementInstruction1 *-- "0..1" IClearingSystemIdentification3Choice : ClearingSystem
SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingReimbursementAgent
SettlementInstruction1 *-- "0..1" CashAccount24 : InstructingReimbursementAgentAccount
SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedReimbursementAgent
SettlementInstruction1 *-- "0..1" CashAccount24 : InstructedReimbursementAgentAccount
SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : ThirdReimbursementAgent
SettlementInstruction1 *-- "0..1" CashAccount24 : ThirdReimbursementAgentAccount
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
GroupHeader54 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the instructing party and sent to the next party in the chain, to unambiguously identify the message. | Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period. |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| Authorisation | User identification or any user key to be used to check whether the initiating party is allowed to initiate transactions from the account specified in the message. | |
| BatchBooking | Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested. | Usage: Batch booking is used to request and not order a possible batch booking. |
| NumberOfTransactions | Number of individual transactions contained in the message. | IsoMax15NumericText - Required 1..1 |
| ControlSum | Total of all individual amounts included in the message, irrespective of currencies. | IsoDecimalNumber - Optional 0..1 |
| GroupReturn | Indicates whether the return applies to the whole group of transactions or to individual transactions within the original group(s). | IsoTrueFalseIndicator - Optional 0..1 |
| TotalReturnedInterbankSettlementAmount | Total amount of money moved between the instructing agent and the instructed agent in the return message. | IsoActiveCurrencyAndAmount - Optional 0..1 |
| InterbankSettlementDate | Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. | IsoISODate - Optional 0..1 |
| SettlementInformation | Specifies the details on how the settlement of the transaction(s) between the instructing agent and the instructed agent is completed. | SettlementInstruction1 - Required 1..1 |
| InstructingAgent | Agent that instructs the next party in the chain to carry out the (set of) instruction(s). | Usage: The instructing agent is the party sending the return message and not the party that sent the original instruction that is being returned. |
| InstructedAgent | Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s). | Usage: The instructed agent is the party receiving the return message and not the party that received the original instruction that is being returned. |
OriginalGroupInformation building block
Information concerning the original group of transactions, to which the message refers. Provides information on the original group, to which the message refers. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% OriginalGroupHeader2 recursion level 0 with max 1
class OriginalGroupHeader2{
OriginalMessageIdentification IsoMax35Text
OriginalMessageNameIdentification IsoMax35Text
OriginalCreationDateTime IsoISODateTime
}
OriginalGroupHeader2 *-- "0..0" PaymentReturnReason1 : ReturnReasonInformation
%% PaymentReturnReason1 recursion level 1 with max 1
class PaymentReturnReason1{
AdditionalInformation IsoMax105Text
}
PaymentReturnReason1 *-- "0..1" PartyIdentification43 : Originator
PaymentReturnReason1 *-- "0..1" IReturnReason5Choice : Reason
OriginalGroupHeader2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalMessageIdentification | Point to point reference, as assigned by the original instructing party, to unambiguously identify the original message. | IsoMax35Text - Required 1..1 |
| OriginalMessageNameIdentification | Specifies the original message name identifier to which the message refers. | IsoMax35Text - Required 1..1 |
| OriginalCreationDateTime | Date and time at which the original message was created. | IsoISODateTime - Optional 0..1 |
| ReturnReasonInformation | Provides detailed information on the return reason. | PaymentReturnReason1 - Unknown 0..0 |
TransactionInformation building block
Information concerning the original transactions, to which the return message refers. Provides further details on the reference and status on the original transactions, included in the original instruction, to which the return message applies. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% PaymentTransaction50 recursion level 0 with max 1
class PaymentTransaction50{
ReturnIdentification IsoMax35Text
OriginalInstructionIdentification IsoMax35Text
OriginalEndToEndIdentification IsoMax35Text
OriginalTransactionIdentification IsoMax35Text
OriginalClearingSystemReference IsoMax35Text
OriginalInterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount
ReturnedInterbankSettlementAmount IsoActiveCurrencyAndAmount
InterbankSettlementDate IsoISODate
SettlementPriority Priority3Code
ReturnedInstructedAmount IsoActiveOrHistoricCurrencyAndAmount
ExchangeRate IsoBaseOneRate
CompensationAmount IsoActiveOrHistoricCurrencyAndAmount
ChargeBearer ChargeBearerType1Code
}
PaymentTransaction50 *-- "0..1" OriginalGroupInformation3 : OriginalGroupInformation
PaymentTransaction50 *-- "0..0" Charges2 : ChargesInformation
PaymentTransaction50 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
PaymentTransaction50 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
PaymentTransaction50 *-- "0..0" PaymentReturnReason1 : ReturnReasonInformation
PaymentTransaction50 *-- "0..1" OriginalTransactionReference20 : OriginalTransactionReference
PaymentTransaction50 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalGroupInformation3 recursion level 1 with max 1
class OriginalGroupInformation3{
OriginalMessageIdentification IsoMax35Text
OriginalMessageNameIdentification IsoMax35Text
OriginalCreationDateTime IsoISODateTime
}
%% Charges2 recursion level 1 with max 1
class Charges2{
Amount IsoActiveOrHistoricCurrencyAndAmount
}
Charges2 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : Agent
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% PaymentReturnReason1 recursion level 1 with max 1
class PaymentReturnReason1{
AdditionalInformation IsoMax105Text
}
PaymentReturnReason1 *-- "0..1" PartyIdentification43 : Originator
PaymentReturnReason1 *-- "0..1" IReturnReason5Choice : Reason
%% OriginalTransactionReference20 recursion level 1 with max 1
class OriginalTransactionReference20{
InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount
InterbankSettlementDate IsoISODate
RequestedCollectionDate IsoISODate
RequestedExecutionDate IsoISODate
PaymentMethod PaymentMethod4Code
}
OriginalTransactionReference20 *-- "0..1" IAmountType4Choice : Amount
OriginalTransactionReference20 *-- "0..1" PartyIdentification43 : CreditorSchemeIdentification
OriginalTransactionReference20 *-- "0..1" SettlementInstruction1 : SettlementInformation
OriginalTransactionReference20 *-- "0..1" PaymentTypeInformation25 : PaymentTypeInformation
OriginalTransactionReference20 *-- "0..1" MandateRelatedInformation10 : MandateRelatedInformation
OriginalTransactionReference20 *-- "0..1" RemittanceInformation10 : RemittanceInformation
OriginalTransactionReference20 *-- "0..1" PartyIdentification43 : UltimateDebtor
OriginalTransactionReference20 *-- "0..1" PartyIdentification43 : Debtor
OriginalTransactionReference20 *-- "0..1" CashAccount24 : DebtorAccount
OriginalTransactionReference20 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
OriginalTransactionReference20 *-- "0..1" CashAccount24 : DebtorAgentAccount
OriginalTransactionReference20 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
OriginalTransactionReference20 *-- "0..1" CashAccount24 : CreditorAgentAccount
OriginalTransactionReference20 *-- "0..1" PartyIdentification43 : Creditor
OriginalTransactionReference20 *-- "0..1" CashAccount24 : CreditorAccount
OriginalTransactionReference20 *-- "0..1" PartyIdentification43 : UltimateCreditor
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
PaymentTransaction50 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ReturnIdentification | Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the returned transaction. | Usage: The instructing party is the party sending the return message and not the party that sent the original instruction that is being returned. |
| OriginalGroupInformation | Provides information on the original message. | OriginalGroupInformation3 - Optional 0..1 |
| OriginalInstructionIdentification | Unique identification, as assigned by the original instructing party for the original instructed party, to unambiguously identify the original instruction. | IsoMax35Text - Optional 0..1 |
| OriginalEndToEndIdentification | Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction. | IsoMax35Text - Optional 0..1 |
| OriginalTransactionIdentification | Unique identification, as assigned by the original first instructing agent, to unambiguously identify the transaction. | IsoMax35Text - Optional 0..1 |
| OriginalClearingSystemReference | Unique reference, as assigned by the original clearing system, to unambiguously identify the original instruction. | IsoMax35Text - Optional 0..1 |
| OriginalInterbankSettlementAmount | Amount of money, as provided in the original transaction, to be moved between the instructing agent and the instructed agent. | IsoActiveOrHistoricCurrencyAndAmount - Optional 0..1 |
| ReturnedInterbankSettlementAmount | Amount of money moved between the instructing agent and the instructed agent in the returned transaction. | IsoActiveCurrencyAndAmount - Required 1..1 |
| InterbankSettlementDate | Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. | |
| SettlementPriority | Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the settlement instruction. Usage: the SettlementPriority is the settlement priority of the return message, and not of the original instruction. | Priority3Code - Optional 0..1 |
| ReturnedInstructedAmount | Amount of money to be moved between the debtor and the creditor, before deduction of charges, in the returned transaction. Usage: This amount has to be transported unchanged through the transaction chain. | IsoActiveOrHistoricCurrencyAndAmount - Optional 0..1 |
| ExchangeRate | Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. | IsoBaseOneRate - Optional 0..1 |
| CompensationAmount | Amount of money asked or paid as compensation for the processing of the instruction. | IsoActiveOrHistoricCurrencyAndAmount - Optional 0..1 |
| ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction. | |
| ChargesInformation | Provides information on the charges to be paid by the charge bearer(s) related to the processing of the return transaction. | Charges2 - Unknown 0..0 |
| InstructingAgent | Agent that instructs the next party in the chain to carry out the (set of) instruction(s). | |
| InstructedAgent | Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s). | |
| ReturnReasonInformation | Provides detailed information on the return reason. | PaymentReturnReason1 - Unknown 0..0 |
| OriginalTransactionReference | Key elements used to identify the original transaction that is being referred to. | OriginalTransactionReference20 - Optional 0..1 |
| SupplementaryData | Additional information that cannot be captured in the structured elements and/or any other specific block. | SupplementaryData1 - Unknown 0..0 |
SupplementaryData building block
Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
| Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the PaymentReturnV05 implementation follows a specific implementaiton pattern. First of all, PaymentReturnV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PaymentReturnV05Document implements IOuterDocument. Because PaymentReturnV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PaymentReturnV05.
classDiagram
class IOuterRecord
PaymentReturnV05 --|> IOuterRecord : Implements
PaymentReturnV05Document --|> IOuterDocument~PaymentReturnV05~ : Implements
class IOuterDocument~PaymentReturnV05~ {
PaymentReturnV05 Message
}
Document wrapper for serialization
The only real purpose PaymentReturnV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pacs.004.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using PaymentReturnV05.ToDocument() method. The returned PaymentReturnV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
PaymentReturnV05Document *-- PaymentReturnV05 : Document
Sample of message format
This is an abbreviated version of what the message should look like.
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.004.001.05">
<PmtRtr>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<OrgnlGrpInf>
<!-- OriginalGroupInformation inner content -->
</OrgnlGrpInf>
<TxInf>
<!-- TransactionInformation inner content -->
</TxInf>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</PmtRtr>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_fTgMURPeEeSVo-TFVwFHvA"
nextVersions="_pmmdiTqxEeWZFYSPlduMhw"
previousVersion="_MqOLESGnEeKjd4jizyIDGA"
name="PaymentReturnV05"
definition="Scope
The PaymentReturn message is sent by an agent to the previous agent in the payment chain to undo a payment previously settled.
Usage
The PaymentReturn message is exchanged between agents to return funds after settlement of credit transfer instructions (i.e. FIToFICustomerCreditTransfer message and FinancialInstitutionCreditTransfer message) or direct debit instructions (FIToFICustomerDirectDebit message).
The PaymentReturn message should not be used between agents and non-financial institution customers. Non-financial institution customers will be informed about a debit or a credit on their account(s) through a BankToCustomerDebitCreditNotification message ('notification') and/or BankToCustomerAccountReport/BankToCustomerStatement message ('statement').
The PaymentReturn message can be used to return single instructions or multiple instructions from one or different files.
The PaymentReturn message can be used in domestic and cross-border scenarios.
The PaymentReturn message refers to the original instruction(s) by means of references only or by means of references and a set of elements from the original instruction."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="PmtRtr"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_fTgMUxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdizqxEeWZFYSPlduMhw"
previousVersion="_MqOLEyGnEeKjd4jizyIDGA"
name="InstructedAgentRule"
definition="If GroupHeader/InstructedAgent is present, then TransactionInformation/InstructedAgent is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/TransactionInformation[*]/InstructedAgent</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InstructedAgent</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMVRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdjTqxEeWZFYSPlduMhw"
previousVersion="_MqOLFyGnEeKjd4jizyIDGA"
name="InstructingAgentRule"
definition="If GroupHeader/InstructingAgent is present, then TransactionInformation/InstructingAgent is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/TransactionInformation[*]/InstructingAgent</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InstructingAgent</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMVxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdjzqxEeWZFYSPlduMhw"
previousVersion="_MqOLGyGnEeKjd4jizyIDGA"
name="GroupReturnAndNumberOfTransactionsRule"
definition="If GroupHeader/GroupReturn is false, then GroupHeader/NumberOfTransactions must equal the number of occurrences of TransactionInformation."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/NumberOfTransactions</leftOperand><rightOperand>Number Occurrences TransactionInformation</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/GroupReturn</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/GroupReturn</leftOperand><rightOperand>false</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMWRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdkTqxEeWZFYSPlduMhw"
previousVersion="_MqOLHyGnEeKjd4jizyIDGA"
name="GroupReturnAndReturnReasonRule"
definition="If GroupHeader/GroupReturn is true, then OriginalGroupInformation/ReturnReasonInformation/ReturnReason must be present."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformation/ReturnReasonInformation[*]/Reason</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/GroupReturn</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/GroupReturn</leftOperand><rightOperand>true</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformation/ReturnReasonInformation[*]/AdditionalInformation[1]</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMWxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdkzqxEeWZFYSPlduMhw"
previousVersion="_MqOLIyGnEeKjd4jizyIDGA"
name="TotalReturnedInterbankSettlementAmountRule"
definition="If GroupHeader/TotalReturnedInterbankSettlementAmount is present, then all occurrences of TransactionInformation/ReturnedInterbankSettlementAmount must have the same currency as the currency of GroupHeader/TotalReturnedInterbankSettlementAmount."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="EqualToNode"><leftOperand>/TransactionInformation[*]/ReturnedInterbankSettlementAmount/@Currency</leftOperand><rightOperand>/GroupHeader/TotalReturnedInterbankSettlementAmount/@Currency</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/TotalReturnedInterbankSettlementAmount</leftOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/TransactionInformation[1]</leftOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/TransactionInformation[*]/ReturnedInterbankSettlementAmount</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMXRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdlTqxEeWZFYSPlduMhw"
previousVersion="_MqOLJyGnEeKjd4jizyIDGA"
name="TotalReturnedInterbankSettlementAmountAndSumRule"
definition="GroupHeader/TotalReturnedInterbankSettlementAmount must equal the sum of all occurrences of TransactionInformation/ReturnedInterbankSettlementAmount when present."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/TotalReturnedInterbankSettlementAmount</leftOperand><rightOperand>sum of TransactionInformation/ReturnedInterbankSttlementAmount</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/TotalReturnedInterbankSettlementAmount</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMXxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdlzqxEeWZFYSPlduMhw"
previousVersion="_MqOLKyGnEeKjd4jizyIDGA"
name="OriginalGroupInformationRule"
definition="If OriginalGroupInformation is present, then TransactionInformation/OriginalGroupInformation is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/TransactionInformation[*]/OriginalGroupInformation</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformation</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMYRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdmTqxEeWZFYSPlduMhw"
previousVersion="_MqOLLyGnEeKjd4jizyIDGA"
name="NoCoverSettlementMethodRule"
definition="GroupHeader/SettlementInformation/SettlementMethod must be different from COVE when returning direct debit transactions."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="DifferentFromValue"><leftOperand>substring(/OriginalGroupInformation/OriginalMessageNameIdentification,1,8)</leftOperand><rightOperand>pacs.003</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/SettlementInformation</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/SettlementInformation/SettlementMethod</leftOperand><rightOperand>CoverMethod</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMYxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdmzqxEeWZFYSPlduMhw"
previousVersion="_MqOLMyGnEeKjd4jizyIDGA"
name="GroupHeaderInterbankSettlementDateRule"
definition="If GroupHeader/InterbankSettlementDate is present, then TransactionInformation/InterbankSettlementDate is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/TransactionInformation[*]/InterbankSettlementDate</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InterbankSettlementDate</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMZRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdnTqxEeWZFYSPlduMhw"
previousVersion="_MqOLNyGnEeKjd4jizyIDGA"
name="TransactionInterbankSettlementDateRule"
definition="If GroupHeader/InterbankSettlementDate is not present, then TransactionInformation/InterbankSettlementDate must be present."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/TransactionInformation[*]/InterbankSettlementDate</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/GroupHeader/InterbankSettlementDate</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMZxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdnzqxEeWZFYSPlduMhw"
previousVersion="_MqOLOyGnEeKjd4jizyIDGA"
name="GroupReturnAndTransactionInformationNotPresentRule"
definition="If GroupHeader/GroupReturn is true, then TransactionInformation is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/TransactionInformation[*]</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/GroupReturn</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/GroupReturn</leftOperand><rightOperand>true</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMaRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdoTqxEeWZFYSPlduMhw"
previousVersion="_MqOLPyGnEeKjd4jizyIDGA"
name="GroupReturnAndTransactionInformationPresentRule"
definition="If GroupHeader/GroupReturn is false, then at least one occurrence of TransactionInformation must be present."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/TransactionInformation[1]</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/GroupReturn</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/GroupReturn</leftOperand><rightOperand>false</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_fTgMaxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdozqxEeWZFYSPlduMhw"
previousVersion="_YwE28SHZEeKGEZlIMFwKzg"
name="SupplementaryDataRule"
definition="The SupplementaryData building block at message level must not be used to provide additional information about a transaction. The SupplementaryData element at transaction level should be used for that purpose."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_fTgMbRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdpTqxEeWZFYSPlduMhw"
previousVersion="_MqOLQyGnEeKjd4jizyIDGA"
name="GroupHeader"
definition="Set of characteristics shared by all individual transactions included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_s7gckVkyEeGeoaLUQk__nA_-1547025335" />
<messageBuildingBlock
xmi:id="_fTgMbxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdpzqxEeWZFYSPlduMhw"
previousVersion="_MqOLRyGnEeKjd4jizyIDGA"
name="OriginalGroupInformation"
definition="Information concerning the original group of transactions, to which the message refers."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="OrgnlGrpInf"
complexType="_sm76wFkyEeGeoaLUQk__nA_-556027435" />
<messageBuildingBlock
xmi:id="_fTgMcRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdqTqxEeWZFYSPlduMhw"
previousVersion="_MqOLTyGnEeKjd4jizyIDGA"
name="TransactionInformation"
definition="Information concerning the original transactions, to which the return message refers."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="TxInf"
complexType="_hLYzERmHEeS15voCZPa1ZA" />
<messageBuildingBlock
xmi:id="_fTgMcxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdqzqxEeWZFYSPlduMhw"
previousVersion="_MqOLVyGnEeKjd4jizyIDGA"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="pacs"
messageFunctionality="004"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.