PaymentReturnV01

pacs.004.001.01

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 an Advice of Credit/Debit message and/or Statement message. 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
%% PaymentReturnV01 recursion level 0 with max 0
PaymentReturnV01 *-- "1..1" GroupHeader6 : GroupHeader
PaymentReturnV01 *-- "0..1" OriginalGroupInformation2 : OriginalGroupInformation
PaymentReturnV01 *-- "0..1" PaymentTransactionInformation2 : TransactionInformation
  

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
%% GroupHeader6 recursion level 0 with max 1
class GroupHeader6{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    Authorisation IsoMax128Text
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    GroupReturn IsoTrueFalseIndicator
    TotalReturnedInterbankSettlementAmount IsoCurrencyAndAmount
    InterbankSettlementDate IsoISODate
}
GroupHeader6 *-- "1..1" SettlementInformation1 : SettlementInformation
GroupHeader6 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingAgent
GroupHeader6 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructedAgent
%% SettlementInformation1 recursion level 1 with max 1
class SettlementInformation1{
    SettlementMethod SettlementMethod1Code
}
SettlementInformation1 *-- "0..1" CashAccount7 : SettlementAccount
SettlementInformation1 *-- "0..1" IClearingSystemIdentification1Choice : ClearingSystem
SettlementInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingReimbursementAgent
SettlementInformation1 *-- "0..1" CashAccount7 : InstructingReimbursementAgentAccount
SettlementInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructedReimbursementAgent
SettlementInformation1 *-- "0..1" CashAccount7 : InstructedReimbursementAgentAccount
SettlementInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : ThirdReimbursementAgent
SettlementInformation1 *-- "0..1" CashAccount7 : ThirdReimbursementAgentAccount
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
  

GroupHeader6 members

OriginalGroupInformation building block

Information concerning the original group of transactions, to which the message refers. Unique and unambiguous identifier of the group of transactions as assigned by the original instructing party. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% OriginalGroupInformation2 recursion level 0 with max 1
class OriginalGroupInformation2{
    OriginalMessageIdentification IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
}
OriginalGroupInformation2 *-- "0..0" ReturnReasonInformation1 : ReturnReasonInformation
%% ReturnReasonInformation1 recursion level 1 with max 1
class ReturnReasonInformation1{
    AdditionalReturnReasonInformation IsoMax105Text
}
ReturnReasonInformation1 *-- "0..1" PartyIdentification8 : ReturnOriginator
ReturnReasonInformation1 *-- "0..1" IReturnReason1Choice : ReturnReason
  

OriginalGroupInformation2 members

TransactionInformation building block

Information concerning the original transactions, to which the return message refers. Reference and status information concerning the original transactions, included in the original instruction, to which the return message applies. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PaymentTransactionInformation2 recursion level 0 with max 1
class PaymentTransactionInformation2{
    ReturnIdentification IsoMax35Text
    OriginalInstructionIdentification IsoMax35Text
    OriginalEndToEndIdentification IsoMax35Text
    OriginalTransactionIdentification IsoMax35Text
    OriginalInterbankSettlementAmount IsoCurrencyAndAmount
    ReturnedInterbankSettlementAmount IsoCurrencyAndAmount
    InterbankSettlementDate IsoISODate
    ReturnedInstructedAmount IsoCurrencyAndAmount
    ExchangeRate IsoBaseOneRate
    CompensationAmount IsoCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
}
PaymentTransactionInformation2 *-- "0..1" OriginalGroupInformation3 : OriginalGroupInformation
PaymentTransactionInformation2 *-- "0..0" ChargesInformation1 : ChargesInformation
PaymentTransactionInformation2 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingAgent
PaymentTransactionInformation2 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructedAgent
PaymentTransactionInformation2 *-- "0..0" ReturnReasonInformation1 : ReturnReasonInformation
PaymentTransactionInformation2 *-- "0..1" OriginalTransactionReference1 : OriginalTransactionReference
%% OriginalGroupInformation3 recursion level 1 with max 1
class OriginalGroupInformation3{
    OriginalMessageIdentification IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
}
%% ChargesInformation1 recursion level 1 with max 1
class ChargesInformation1{
    ChargesAmount IsoCurrencyAndAmount
}
ChargesInformation1 *-- "1..1" BranchAndFinancialInstitutionIdentification3 : ChargesParty
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% ReturnReasonInformation1 recursion level 1 with max 1
class ReturnReasonInformation1{
    AdditionalReturnReasonInformation IsoMax105Text
}
ReturnReasonInformation1 *-- "0..1" PartyIdentification8 : ReturnOriginator
ReturnReasonInformation1 *-- "0..1" IReturnReason1Choice : ReturnReason
%% OriginalTransactionReference1 recursion level 1 with max 1
class OriginalTransactionReference1{
    InterbankSettlementAmount IsoCurrencyAndAmount
    InterbankSettlementDate IsoISODate
    RequestedExecutionDate IsoISODate
    RequestedCollectionDate IsoISODate
    PaymentMethod PaymentMethod4Code
}
OriginalTransactionReference1 *-- "0..1" IAmountType2Choice : Amount
OriginalTransactionReference1 *-- "0..1" PartyIdentification8 : CreditorSchemeIdentification
OriginalTransactionReference1 *-- "0..1" SettlementInformation3 : SettlementInformation
OriginalTransactionReference1 *-- "0..1" PaymentTypeInformation6 : PaymentTypeInformation
OriginalTransactionReference1 *-- "0..1" MandateRelatedInformation1 : MandateRelatedInformation
OriginalTransactionReference1 *-- "0..1" RemittanceInformation1 : RemittanceInformation
OriginalTransactionReference1 *-- "0..1" PartyIdentification8 : UltimateDebtor
OriginalTransactionReference1 *-- "0..1" PartyIdentification8 : Debtor
OriginalTransactionReference1 *-- "0..1" CashAccount7 : DebtorAccount
OriginalTransactionReference1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : DebtorAgent
OriginalTransactionReference1 *-- "0..1" CashAccount7 : DebtorAgentAccount
OriginalTransactionReference1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : CreditorAgent
OriginalTransactionReference1 *-- "0..1" CashAccount7 : CreditorAgentAccount
OriginalTransactionReference1 *-- "0..1" PartyIdentification8 : Creditor
OriginalTransactionReference1 *-- "0..1" CashAccount7 : CreditorAccount
OriginalTransactionReference1 *-- "0..1" PartyIdentification8 : UltimateCreditor
  

PaymentTransactionInformation2 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the PaymentReturnV01 implementation follows a specific implementaiton pattern. First of all, PaymentReturnV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PaymentReturnV01Document implements IOuterDocument. Because PaymentReturnV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PaymentReturnV01.

classDiagram
    class IOuterRecord
    PaymentReturnV01 --|> IOuterRecord : Implements
    PaymentReturnV01Document --|> IOuterDocument~PaymentReturnV01~ : Implements
    class IOuterDocument~PaymentReturnV01~ {
        PaymentReturnV01 Message
     }
  

Document wrapper for serialization

The only real purpose PaymentReturnV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pacs.004.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using PaymentReturnV01.ToDocument() method. The returned PaymentReturnV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    PaymentReturnV01Document *-- PaymentReturnV01 : 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.01">
    <pacs.004.001.01>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <OrgnlGrpInf>
            <!-- OriginalGroupInformation inner content -->
        </OrgnlGrpInf>
        <TxInf>
            <!-- TransactionInformation inner content -->
        </TxInf>
    </pacs.004.001.01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_eqFbL9EuEd-BzquC8wXy7w_1826980297"
  nextVersions="_eqYWKtEuEd-BzquC8wXy7w_-993933741"
  name="PaymentReturnV01"
  definition="Scope&#xD;&#xA;The PaymentReturn message is sent by an agent to the previous agent in the payment chain to undo a payment previously settled.&#xD;&#xA;Usage&#xD;&#xA;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).&#xD;&#xA;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 an Advice of Credit/Debit message and/or Statement message.&#xD;&#xA;The PaymentReturn message can be used to return single instructions or multiple instructions from one or different files.&#xD;&#xA;The PaymentReturn message can be used in domestic and cross-border scenarios.&#xD;&#xA;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.&#xD;."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="pacs.004.001.01"
  xmlTag="pacs.004.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_eqOlE9EuEd-BzquC8wXy7w_-1758839876"
    name="GroupReturnAndTransactionInformationRule"
    definition="If GroupHeader/GroupReturn is true, then TransactionInformation is not allowed.&#xA;If GroupHeader/GroupReturn is false, then at least one occurrence of TransactionInformation must be present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqOlFtEuEd-BzquC8wXy7w_104827849"
    name="InstructedAgentRule"
    definition="If GroupHeader/InstructedAgent is present, then TransactionInformation/InstructedAgent is not allowed."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqOlGdEuEd-BzquC8wXy7w_105747923"
    name="InstructingAgentRule"
    definition="If GroupHeader/InstructingAgent is present, then TransactionInformation/InstructingAgent is not allowed."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqOlHNEuEd-BzquC8wXy7w_548116637"
    name="InterbankSettlementDateRule"
    definition="If GroupHeader/InterbankSettlementDate is present, then TransactionInformation/InterbankSettlementDate is not allowed. &#xA;If GroupHeader/InterbankSettlementDate is not present, then TransactionInformation/InterbankSettlementDate must be present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqOlH9EuEd-BzquC8wXy7w_1017480350"
    name="GroupReturnAndNumberOfTransactionsRule"
    definition="If GroupHeader/GroupReturn is false, then GroupHeader/NumberOfTransactions must equal the number of occurrences of TransactionInformation."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqYWEtEuEd-BzquC8wXy7w_1460768411"
    name="GroupReturnAndReturnReasonRule"
    definition="If GroupHeader/GroupReturn is true, then OriginalGroupInformation/ReturnReasonInformation/ReturnReason must be present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqYWFdEuEd-BzquC8wXy7w_-1086896295"
    name="TotalReturnedInterbankSettlementAmount1Rule"
    definition="If GroupHeader/TotalReturnedInterbankSettlementAmount is present, then all occurrences of TransactionInformation/ReturnedInterbankSettlementAmount must have the same currency as the currency of GroupHeader/TotalReturnedInterbankSettlementAmount. &#xA;."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqYWGNEuEd-BzquC8wXy7w_-935276613"
    name="TotalReturnedInterbankSettlementAmount2Rule"
    definition="GroupHeader/TotalReturnedInterbankSettlementAmount must equal the sum of all occurrences of TransactionInformation/ReturnedInterbankSettlementAmount when present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqYWG9EuEd-BzquC8wXy7w_1480450786"
    name="OriginalGroupInformationRule"
    definition="If OriginalGroupInformation is present, then TransactionInformation/OriginalGroupInformation is not allowed."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_eqYWHtEuEd-BzquC8wXy7w_-556389664"
    name="SettlementMethodRule"
    definition="GroupHeader/SettlementInformation/SettlementMethod/COVE is not allowed when returning direct debit transactions."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_eqOlENEuEd-BzquC8wXy7w_1567907625"
    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="_PuKAENp-Ed-ak6NoX_4Aeg_-1660287802" />
  <messageBuildingBlock
    xmi:id="_eqOlEdEuEd-BzquC8wXy7w_497715970"
    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="_PhL7Gdp-Ed-ak6NoX_4Aeg_-371975028" />
  <messageBuildingBlock
    xmi:id="_eqOlEtEuEd-BzquC8wXy7w_-1979906269"
    name="TransactionInformation"
    definition="Information concerning the original transactions, to which the return message refers."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="TxInf"
    complexType="_PsXQU9p-Ed-ak6NoX_4Aeg_-1190214356" />
  <messageDefinitionIdentifier
    businessArea="pacs"
    messageFunctionality="004"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.