FIToFIPaymentReversalV01

pacs.007.001.01

Scope The FinancialInstitutionToFinancialInstitutionPaymentReversal message is sent by an agent to the next party in the payment chain. It is used to reverse a payment previously executed. Usage The FIToFIPaymentReversal message is exchanged between agents to reverse a FIToFICustomerDirectDebit message that has been settled. The result will be a credit on the debtor account. The FIToFIPaymentReversal message may or may not be the follow-up of a CustomerDirectDebitInitiation message. The FIToFIPaymentReversal message refers to the original FIToFICustomerDirectDebit message by means of references only or by means of references and a set of elements from the original instruction. The FIToFIPaymentReversal message can be used in domestic and cross-border scenarios.

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
%% FIToFIPaymentReversalV01 recursion level 0 with max 0
FIToFIPaymentReversalV01 *-- "1..1" GroupHeader9 : GroupHeader
FIToFIPaymentReversalV01 *-- "1..1" OriginalGroupInformation5 : OriginalGroupInformation
FIToFIPaymentReversalV01 *-- "0..1" PaymentTransactionInformation5 : 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
%% GroupHeader9 recursion level 0 with max 1
class GroupHeader9{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    Authorisation IsoMax128Text
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    GroupReversal IsoTrueFalseIndicator
    TotalReversedInterbankSettlementAmount IsoCurrencyAndAmount
    InterbankSettlementDate IsoISODate
}
GroupHeader9 *-- "1..1" SettlementInformation1 : SettlementInformation
GroupHeader9 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingAgent
GroupHeader9 *-- "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
  

GroupHeader9 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
%% OriginalGroupInformation5 recursion level 0 with max 1
class OriginalGroupInformation5{
    OriginalMessageIdentification IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
}
OriginalGroupInformation5 *-- "0..0" ReversalReasonInformation1 : ReversalReasonInformation
%% ReversalReasonInformation1 recursion level 1 with max 1
class ReversalReasonInformation1{
    AdditionalReversalReasonInformation IsoMax105Text
}
ReversalReasonInformation1 *-- "0..1" PartyIdentification8 : ReversalOriginator
ReversalReasonInformation1 *-- "0..1" IReversalReason1Choice : ReversalReason
  

OriginalGroupInformation5 members

TransactionInformation building block

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

classDiagram
   direction tb
%% PaymentTransactionInformation5 recursion level 0 with max 1
class PaymentTransactionInformation5{
    ReversalIdentification IsoMax35Text
    OriginalPaymentInformationIdentification IsoMax35Text
    OriginalInstructionIdentification IsoMax35Text
    OriginalEndToEndIdentification IsoMax35Text
    OriginalTransactionIdentification IsoMax35Text
    OriginalInterbankSettlementAmount IsoCurrencyAndAmount
    ReversedInterbankSettlementAmount IsoCurrencyAndAmount
    InterbankSettlementDate IsoISODate
    ReversedInstructedAmount IsoCurrencyAndAmount
    ExchangeRate IsoBaseOneRate
    CompensationAmount IsoCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
}
PaymentTransactionInformation5 *-- "0..0" ChargesInformation1 : ChargesInformation
PaymentTransactionInformation5 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingAgent
PaymentTransactionInformation5 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructedAgent
PaymentTransactionInformation5 *-- "0..0" ReversalReasonInformation1 : ReversalReasonInformation
PaymentTransactionInformation5 *-- "0..1" OriginalTransactionReference1 : OriginalTransactionReference
%% 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
%% ReversalReasonInformation1 recursion level 1 with max 1
class ReversalReasonInformation1{
    AdditionalReversalReasonInformation IsoMax105Text
}
ReversalReasonInformation1 *-- "0..1" PartyIdentification8 : ReversalOriginator
ReversalReasonInformation1 *-- "0..1" IReversalReason1Choice : ReversalReason
%% 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
  

PaymentTransactionInformation5 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    FIToFIPaymentReversalV01 --|> IOuterRecord : Implements
    FIToFIPaymentReversalV01Document --|> IOuterDocument~FIToFIPaymentReversalV01~ : Implements
    class IOuterDocument~FIToFIPaymentReversalV01~ {
        FIToFIPaymentReversalV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    FIToFIPaymentReversalV01Document *-- FIToFIPaymentReversalV01 : 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.007.001.01">
    <pacs.007.001.01>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <OrgnlGrpInf>
            <!-- OriginalGroupInformation inner content -->
        </OrgnlGrpInf>
        <TxInf>
            <!-- TransactionInformation inner content -->
        </TxInf>
    </pacs.007.001.01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_elKe5dEuEd-BzquC8wXy7w_-1796587382"
  nextVersions="_eldZ2dEuEd-BzquC8wXy7w_1408457850"
  name="FIToFIPaymentReversalV01"
  definition="Scope&#xD;&#xA;The FinancialInstitutionToFinancialInstitutionPaymentReversal message is sent by an agent to the next party in the payment chain. It is used to reverse a payment previously executed.&#xD;&#xA;Usage&#xD;&#xA;The FIToFIPaymentReversal message is exchanged between agents to reverse a FIToFICustomerDirectDebit message that has been settled. The result will be a credit on the debtor account.&#xD;&#xA;The FIToFIPaymentReversal message may or may not be the follow-up of a CustomerDirectDebitInitiation message.&#xD;&#xA;The FIToFIPaymentReversal message refers to the original FIToFICustomerDirectDebit message by means of references only or by means of references and a set of elements from the original instruction.&#xD;&#xA;The FIToFIPaymentReversal message can be used in domestic and cross-border scenarios.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="pacs.007.001.01"
  xmlTag="pacs.007.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_elKe6dEuEd-BzquC8wXy7w_685678194"
    name="GroupReversalAndTransactionInformationRule"
    definition="If GroupHeader/GroupReversal is true, then TransactionInformation is not allowed.&#xA;If GroupHeader/GroupReversal is false, then at least one occurrence of TransactionInformation must be present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_elUP4tEuEd-BzquC8wXy7w_-926755231"
    name="ReversalReasonRule"
    definition="If GroupHeader/GroupReversal is true, then OriginalGroupInformation/ReversalReasonInformation/ReversalReason must present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_elUP5dEuEd-BzquC8wXy7w_-8767684"
    name="InstructedAgentRule"
    definition="If GroupHeader/InstructedAgent is present, then TransactionInformation/InstructedAgent is not allowed."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_elUP6NEuEd-BzquC8wXy7w_-8767582"
    name="InstructingAgentRule"
    definition="If GroupHeader/InstructingAgent is present, then TransactionInformation/InstructingAgent is not allowed.&#xA;&#xA;."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_elUP69EuEd-BzquC8wXy7w_514869725"
    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="_elUP7tEuEd-BzquC8wXy7w_2147353166"
    name="GroupReversalRule"
    definition="If GroupHeader/GroupReversal is false, then GroupHeader/NumberOfTransactions must equal the number of occurrences of TransactionInformation."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_elUP8dEuEd-BzquC8wXy7w_885909761"
    name="TotalReversedInterbankSettlementAmount1Rule"
    definition="If GroupHeader/TotalReversedInterbankSettlementAmount is present, then all occurrences of TransactionInformation/ReversedInterbankSettlementAmount must have the same currency as the currency of GroupHeader/TotalReversedInterbankSettlementAmount."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_elUP9NEuEd-BzquC8wXy7w_-1948541332"
    name="TotalReversedInterbankSettlementAmount2Rule"
    definition="GroupHeader/TotalReversedInterbankSettlementAmount must equal the sum of all individual TransactionInformation/ReversedInterbankSettlementAmount when present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_elUP99EuEd-BzquC8wXy7w_1783569708"
    name="SettlementMethodRule"
    definition="GroupHeader/SettlementInformation/SettlementMethod/COVE is not allowed when returning direct debit transactions."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_elKe5tEuEd-BzquC8wXy7w_421348727"
    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="_PtaZMNp-Ed-ak6NoX_4Aeg_-472629694" />
  <messageBuildingBlock
    xmi:id="_elKe59EuEd-BzquC8wXy7w_357436312"
    name="OriginalGroupInformation"
    definition="Information concerning the original group of transactions, to which the message refers."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="OrgnlGrpInf"
    complexType="_PhVsF9p-Ed-ak6NoX_4Aeg_-330079515" />
  <messageBuildingBlock
    xmi:id="_elKe6NEuEd-BzquC8wXy7w_-191011416"
    name="TransactionInformation"
    definition="Information concerning the original transactions, to which the reversal message refers."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="TxInf"
    complexType="_Prnpetp-Ed-ak6NoX_4Aeg_1832543398" />
  <messageDefinitionIdentifier
    businessArea="pacs"
    messageFunctionality="007"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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