pacs.004.001.12
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 (that is 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 %% PaymentReturnV12 recursion level 0 with max 0 PaymentReturnV12 *-- "1..1" GroupHeader99 : GroupHeader PaymentReturnV12 *-- "0..1" OriginalGroupHeader18 : OriginalGroupInformation PaymentReturnV12 *-- "0..1" PaymentTransaction146 : TransactionInformation PaymentReturnV12 *-- "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 %% GroupHeader99 recursion level 0 with max 1 class GroupHeader99{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime BatchBooking IsoBatchBookingIndicator NumberOfTransactions IsoMax15NumericText ControlSum IsoDecimalNumber GroupReturn IsoTrueFalseIndicator TotalReturnedInterbankSettlementAmount IsoActiveCurrencyAndAmount InterbankSettlementDate IsoISODate } GroupHeader99 *-- "0..2" IAuthorisation1Choice : Authorisation GroupHeader99 *-- "1..1" SettlementInstruction11 : SettlementInformation GroupHeader99 *-- "0..1" PaymentTypeInformation28 : PaymentTypeInformation GroupHeader99 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructingAgent GroupHeader99 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructedAgent %% IAuthorisation1Choice recursion level 1 with max 1 %% SettlementInstruction11 recursion level 1 with max 1 class SettlementInstruction11{ SettlementMethod SettlementMethod1Code } SettlementInstruction11 *-- "0..1" CashAccount40 : SettlementAccount SettlementInstruction11 *-- "0..1" IClearingSystemIdentification3Choice : ClearingSystem SettlementInstruction11 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructingReimbursementAgent SettlementInstruction11 *-- "0..1" CashAccount40 : InstructingReimbursementAgentAccount SettlementInstruction11 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructedReimbursementAgent SettlementInstruction11 *-- "0..1" CashAccount40 : InstructedReimbursementAgentAccount SettlementInstruction11 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ThirdReimbursementAgent SettlementInstruction11 *-- "0..1" CashAccount40 : ThirdReimbursementAgentAccount %% PaymentTypeInformation28 recursion level 1 with max 1 class PaymentTypeInformation28{ InstructionPriority Priority2Code ClearingChannel ClearingChannel2Code } PaymentTypeInformation28 *-- "0..0" IServiceLevel8Choice : ServiceLevel PaymentTypeInformation28 *-- "0..1" ILocalInstrument2Choice : LocalInstrument PaymentTypeInformation28 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose %% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification %% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
GroupHeader99 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. | SettlementInstruction11 - Required 1..1 |
PaymentTypeInformation | Specifies the type of the return transaction. | PaymentTypeInformation28 - Optional 0..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 %% OriginalGroupHeader18 recursion level 0 with max 1 class OriginalGroupHeader18{ OriginalMessageIdentification IsoMax35Text OriginalMessageNameIdentification IsoMax35Text OriginalCreationDateTime IsoISODateTime } OriginalGroupHeader18 *-- "0..0" PaymentReturnReason6 : ReturnReasonInformation %% PaymentReturnReason6 recursion level 1 with max 1 class PaymentReturnReason6{ AdditionalInformation IsoMax105Text } PaymentReturnReason6 *-- "0..1" PartyIdentification135 : Originator PaymentReturnReason6 *-- "0..1" IReturnReason5Choice : Reason
OriginalGroupHeader18 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. | PaymentReturnReason6 - 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 %% PaymentTransaction146 recursion level 0 with max 1 class PaymentTransaction146{ ReturnIdentification IsoMax35Text OriginalInstructionIdentification IsoMax35Text OriginalEndToEndIdentification IsoMax35Text OriginalTransactionIdentification IsoMax35Text OriginalUETR IsoUUIDv4Identifier OriginalClearingSystemReference IsoMax35Text OriginalInterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount OriginalInterbankSettlementDate IsoISODate ReturnedInterbankSettlementAmount IsoActiveCurrencyAndAmount InterbankSettlementDate IsoISODate SettlementPriority Priority3Code ReturnedInstructedAmount IsoActiveOrHistoricCurrencyAndAmount ExchangeRate IsoBaseOneRate CompensationAmount IsoActiveOrHistoricCurrencyAndAmount ChargeBearer ChargeBearerType1Code ClearingSystemReference IsoMax35Text } PaymentTransaction146 *-- "0..1" OriginalGroupInformation29 : OriginalGroupInformation PaymentTransaction146 *-- "0..1" PaymentTypeInformation28 : PaymentTypeInformation PaymentTransaction146 *-- "0..1" SettlementDateTimeIndication1 : SettlementTimeIndication PaymentTransaction146 *-- "0..1" SettlementTimeRequest2 : SettlementTimeRequest PaymentTransaction146 *-- "0..0" Charges12 : ChargesInformation PaymentTransaction146 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructingAgent PaymentTransaction146 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructedAgent PaymentTransaction146 *-- "0..1" TransactionParties10 : ReturnChain PaymentTransaction146 *-- "0..0" PaymentReturnReason6 : ReturnReasonInformation PaymentTransaction146 *-- "0..1" OriginalTransactionReference36 : OriginalTransactionReference PaymentTransaction146 *-- "0..0" SupplementaryData1 : SupplementaryData %% OriginalGroupInformation29 recursion level 1 with max 1 class OriginalGroupInformation29{ OriginalMessageIdentification IsoMax35Text OriginalMessageNameIdentification IsoMax35Text OriginalCreationDateTime IsoISODateTime } %% PaymentTypeInformation28 recursion level 1 with max 1 class PaymentTypeInformation28{ InstructionPriority Priority2Code ClearingChannel ClearingChannel2Code } PaymentTypeInformation28 *-- "0..0" IServiceLevel8Choice : ServiceLevel PaymentTypeInformation28 *-- "0..1" ILocalInstrument2Choice : LocalInstrument PaymentTypeInformation28 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose %% SettlementDateTimeIndication1 recursion level 1 with max 1 class SettlementDateTimeIndication1{ DebitDateTime IsoISODateTime CreditDateTime IsoISODateTime } %% SettlementTimeRequest2 recursion level 1 with max 1 class SettlementTimeRequest2{ CLSTime IsoISOTime TillTime IsoISOTime FromTime IsoISOTime RejectTime IsoISOTime } %% Charges12 recursion level 1 with max 1 class Charges12{ Amount IsoActiveOrHistoricCurrencyAndAmount } Charges12 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : Agent Charges12 *-- "0..1" IChargeType3Choice : Type %% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification %% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification %% TransactionParties10 recursion level 1 with max 1 TransactionParties10 *-- "0..1" IParty40Choice : UltimateDebtor TransactionParties10 *-- "1..1" IParty40Choice : Debtor TransactionParties10 *-- "0..1" CashAccount40 : DebtorAccount TransactionParties10 *-- "0..1" IParty40Choice : InitiatingParty TransactionParties10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent TransactionParties10 *-- "0..1" CashAccount40 : DebtorAgentAccount TransactionParties10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : PreviousInstructingAgent1 TransactionParties10 *-- "0..1" CashAccount40 : PreviousInstructingAgent1Account TransactionParties10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : PreviousInstructingAgent2 TransactionParties10 *-- "0..1" CashAccount40 : PreviousInstructingAgent2Account TransactionParties10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : PreviousInstructingAgent3 TransactionParties10 *-- "0..1" CashAccount40 : PreviousInstructingAgent3Account TransactionParties10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent1 TransactionParties10 *-- "0..1" CashAccount40 : IntermediaryAgent1Account TransactionParties10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent2 TransactionParties10 *-- "0..1" CashAccount40 : IntermediaryAgent2Account TransactionParties10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent3 TransactionParties10 *-- "0..1" CashAccount40 : IntermediaryAgent3Account TransactionParties10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent TransactionParties10 *-- "0..1" CashAccount40 : CreditorAgentAccount TransactionParties10 *-- "1..1" IParty40Choice : Creditor TransactionParties10 *-- "0..1" CashAccount40 : CreditorAccount TransactionParties10 *-- "0..1" IParty40Choice : UltimateCreditor %% PaymentReturnReason6 recursion level 1 with max 1 class PaymentReturnReason6{ AdditionalInformation IsoMax105Text } PaymentReturnReason6 *-- "0..1" PartyIdentification135 : Originator PaymentReturnReason6 *-- "0..1" IReturnReason5Choice : Reason %% OriginalTransactionReference36 recursion level 1 with max 1 class OriginalTransactionReference36{ InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount InterbankSettlementDate IsoISODate RequestedCollectionDate IsoISODate PaymentMethod PaymentMethod4Code } OriginalTransactionReference36 *-- "0..1" IAmountType4Choice : Amount OriginalTransactionReference36 *-- "0..1" IDateAndDateTime2Choice : RequestedExecutionDate OriginalTransactionReference36 *-- "0..1" PartyIdentification135 : CreditorSchemeIdentification OriginalTransactionReference36 *-- "0..1" SettlementInstruction11 : SettlementInformation OriginalTransactionReference36 *-- "0..1" PaymentTypeInformation27 : PaymentTypeInformation OriginalTransactionReference36 *-- "0..1" IMandateRelatedData2Choice : MandateRelatedInformation OriginalTransactionReference36 *-- "0..1" RemittanceInformation21 : RemittanceInformation OriginalTransactionReference36 *-- "0..1" IParty40Choice : UltimateDebtor OriginalTransactionReference36 *-- "0..1" IParty40Choice : Debtor OriginalTransactionReference36 *-- "0..1" CashAccount40 : DebtorAccount OriginalTransactionReference36 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent OriginalTransactionReference36 *-- "0..1" CashAccount40 : DebtorAgentAccount OriginalTransactionReference36 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent OriginalTransactionReference36 *-- "0..1" CashAccount40 : CreditorAgentAccount OriginalTransactionReference36 *-- "0..1" IParty40Choice : Creditor OriginalTransactionReference36 *-- "0..1" CashAccount40 : CreditorAccount OriginalTransactionReference36 *-- "0..1" IParty40Choice : UltimateCreditor OriginalTransactionReference36 *-- "0..1" IPurpose2Choice : Purpose OriginalTransactionReference36 *-- "0..1" CreditTransferTransaction52 : UnderlyingCustomerCreditTransfer %% SupplementaryData1 recursion level 1 with max 1 class SupplementaryData1{ PlaceAndName IsoMax350Text } SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
PaymentTransaction146 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. | OriginalGroupInformation29 - 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 |
OriginalUETR | Universally unique identifier to provide the original end-to-end reference of a payment transaction. | IsoUUIDv4Identifier - 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 moved between the instructing agent and the instructed agent, as provided in the original instruction. | IsoActiveOrHistoricCurrencyAndAmount - Optional 0..1 |
OriginalInterbankSettlementDate | 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. Usage: the OriginalInterbankSettlementDate is the interbank settlement date of the original instruction return message, and not of the return message. | IsoISODate - Optional 0..1 |
PaymentTypeInformation | Specifies the type of the return transaction. | PaymentTypeInformation28 - Optional 0..1 |
ReturnedInterbankSettlementAmount | Amount of money to be moved between the instructing agent and the instructed agent in the returned instruction. | 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 |
SettlementTimeIndication | Provides information on the occurred settlement time of the payment transaction. | SettlementDateTimeIndication1 - Optional 0..1 |
SettlementTimeRequest | Provides information on the requested settlement time of the payment instruction. | SettlementTimeRequest2 - 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. | Charges12 - Unknown 0..0 |
ClearingSystemReference | Unique reference, as assigned by the clearing system, to unambiguously identify the return instruction. | IsoMax35Text - Optional 0..1 |
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). | |
ReturnChain | Provides all parties (agents and non-agents) involved in a return transaction. | TransactionParties10 - Optional 0..1 |
ReturnReasonInformation | Provides detailed information on the return reason. | PaymentReturnReason6 - Unknown 0..0 |
OriginalTransactionReference | Key elements used to identify the original transaction that is being referred to. | OriginalTransactionReference36 - 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 PaymentReturnV12 implementation follows a specific implementaiton pattern. First of all, PaymentReturnV12 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PaymentReturnV12Document implements IOuterDocument. Because PaymentReturnV12 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PaymentReturnV12.
classDiagram class IOuterRecord PaymentReturnV12 --|> IOuterRecord : Implements PaymentReturnV12Document --|> IOuterDocument~PaymentReturnV12~ : Implements class IOuterDocument~PaymentReturnV12~ { PaymentReturnV12 Message }
Document wrapper for serialization
The only real purpose PaymentReturnV12Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pacs.004.001.12’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using PaymentReturnV12.ToDocument() method. The returned PaymentReturnV12Document value will serialize correctly according to ISO 20022 standards.
classDiagram PaymentReturnV12Document *-- PaymentReturnV12 : 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.12">
<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="_GjJr4RlVEe2Do_UtrNmb2g"
previousVersion="_jMZaEdcBEeq_l4BJLVUF2Q"
name="PaymentReturnV12"
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 (that is 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="_tk1vk_2YEeG0oal_knwJ7A"
xmlTag="PmtRtr"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_GjJr4xlVEe2Do_UtrNmb2g"
previousVersion="_jMZaE9cBEeq_l4BJLVUF2Q"
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="_GjJr5RlVEe2Do_UtrNmb2g"
previousVersion="_jMZaFdcBEeq_l4BJLVUF2Q"
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="_GjJr5xlVEe2Do_UtrNmb2g"
previousVersion="_jMZaF9cBEeq_l4BJLVUF2Q"
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="_GjJr6RlVEe2Do_UtrNmb2g"
previousVersion="_jMZaGdcBEeq_l4BJLVUF2Q"
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="_GjJr6xlVEe2Do_UtrNmb2g"
previousVersion="_jMZaG9cBEeq_l4BJLVUF2Q"
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="_GjJr7RlVEe2Do_UtrNmb2g"
previousVersion="_jMZaHdcBEeq_l4BJLVUF2Q"
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="_GjJr7xlVEe2Do_UtrNmb2g"
previousVersion="_jMZaH9cBEeq_l4BJLVUF2Q"
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="_GjJr8RlVEe2Do_UtrNmb2g"
previousVersion="_jMZaIdcBEeq_l4BJLVUF2Q"
name="NoCoverSettlementMethodRule"
definition="GroupHeader/SettlementInformation/SettlementMethod must be different from COVE (Cover) 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="_GjJr8xlVEe2Do_UtrNmb2g"
previousVersion="_jMZaI9cBEeq_l4BJLVUF2Q"
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="_GjJr9RlVEe2Do_UtrNmb2g"
previousVersion="_jMZaJdcBEeq_l4BJLVUF2Q"
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="_GjJr9xlVEe2Do_UtrNmb2g"
previousVersion="_jMZaJ9cBEeq_l4BJLVUF2Q"
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="_GjJr-RlVEe2Do_UtrNmb2g"
previousVersion="_jMZaKdcBEeq_l4BJLVUF2Q"
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="_GjJr-xlVEe2Do_UtrNmb2g"
previousVersion="_jMZaK9cBEeq_l4BJLVUF2Q"
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" />
<constraint
xmi:id="_GjJr_RlVEe2Do_UtrNmb2g"
previousVersion="_1gOzUditEeq5MfBBxQig1Q"
name="PaymentTypeInformationRule"
definition="If GroupHeader/PaymentTypeInformation is present, then TransactionInformation/PaymentTypeInformation is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/TransactionInformation[*]/PaymentTypeInformation</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/PaymentTypeInformation</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<messageBuildingBlock
xmi:id="_GjJsDRlVEe2Do_UtrNmb2g"
previousVersion="_jMZaM9cBEeq_l4BJLVUF2Q"
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="_g-JF4dcZEeqRFcf2R4bPBw" />
<messageBuildingBlock
xmi:id="_GjJsDxlVEe2Do_UtrNmb2g"
previousVersion="_jMZaNdcBEeq_l4BJLVUF2Q"
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="_Iup9rXL_EeidQ_AAdEzxQA" />
<messageBuildingBlock
xmi:id="_GjJsERlVEe2Do_UtrNmb2g"
previousVersion="_jMZaN9cBEeq_l4BJLVUF2Q"
name="TransactionInformation"
definition="Information concerning the original transactions, to which the return message refers."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="TxInf"
complexType="_OmlhwRlWEe2Do_UtrNmb2g" />
<messageBuildingBlock
xmi:id="_GjJsExlVEe2Do_UtrNmb2g"
previousVersion="_jMZaOdcBEeq_l4BJLVUF2Q"
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="12" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.