CustomerPaymentReversalV01

pain.007.001.01

Scope The CustomerPaymentReversal message is sent by the initiating party to the next party in the payment chain. It is used to reverse a payment previously executed. Usage The CustomerPaymentReversal message is exchanged between a non-financial institution customer and an agent to reverse a CustomerDirectDebitInitiation message that has been settled. The result will be a credit on the debtor account. The CustomerPaymentReversal message refers to the original CustomerDirectDebitInitiation message by means of references only or by means of references and a set of elements from the original instruction. The CustomerPaymentReversal 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
%% CustomerPaymentReversalV01 recursion level 0 with max 0
CustomerPaymentReversalV01 *-- "1..1" GroupHeader8 : GroupHeader
CustomerPaymentReversalV01 *-- "1..1" OriginalGroupInformation5 : OriginalGroupInformation
CustomerPaymentReversalV01 *-- "0..1" PaymentTransactionInformation4 : 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
%% GroupHeader8 recursion level 0 with max 1
class GroupHeader8{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    Authorisation IsoMax128Text
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    GroupReversal IsoTrueFalseIndicator
}
GroupHeader8 *-- "0..1" PartyIdentification8 : InitiatingParty
GroupHeader8 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : ForwardingAgent
GroupHeader8 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : DebtorAgent
GroupHeader8 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : CreditorAgent
%% PartyIdentification8 recursion level 1 with max 1
class PartyIdentification8{
    Name IsoMax70Text
    CountryOfResidence CountryCode
}
PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress
PartyIdentification8 *-- "0..1" IParty2Choice : Identification
%% 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
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
  

GroupHeader8 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
%% PaymentTransactionInformation4 recursion level 0 with max 1
class PaymentTransactionInformation4{
    ReversalIdentification IsoMax35Text
    OriginalPaymentInformationIdentification IsoMax35Text
    OriginalInstructionIdentification IsoMax35Text
    OriginalEndToEndIdentification IsoMax35Text
    OriginalInstructedAmount IsoCurrencyAndAmount
    ReversedInstructedAmount IsoCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
}
PaymentTransactionInformation4 *-- "0..0" ReversalReasonInformation1 : ReversalReasonInformation
PaymentTransactionInformation4 *-- "0..1" OriginalTransactionReference1 : OriginalTransactionReference
%% 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
  

PaymentTransactionInformation4 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CustomerPaymentReversalV01 --|> IOuterRecord : Implements
    CustomerPaymentReversalV01Document --|> IOuterDocument~CustomerPaymentReversalV01~ : Implements
    class IOuterDocument~CustomerPaymentReversalV01~ {
        CustomerPaymentReversalV01 Message
     }
  

Document wrapper for serialization

The only real purpose CustomerPaymentReversalV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.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 CustomerPaymentReversalV01.ToDocument() method. The returned CustomerPaymentReversalV01Document value will serialize correctly according to ISO 20022 standards.

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

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_GXBqeNEvEd-BzquC8wXy7w_-1340182044"
  nextVersions="_GXLbgtEvEd-BzquC8wXy7w_66905835"
  name="CustomerPaymentReversalV01"
  definition="Scope&#xD;&#xA;The CustomerPaymentReversal message is sent by the initiating party to the next party in the payment chain. It is used to reverse a payment previously executed.&#xD;&#xA;Usage&#xD;&#xA;The CustomerPaymentReversal message is exchanged between a non-financial institution customer and an agent to reverse a CustomerDirectDebitInitiation message that has been settled. The result will be a credit on the debtor account.&#xD;&#xA;The CustomerPaymentReversal message refers to the original CustomerDirectDebitInitiation message by means of references only or by means of references and a set of elements from the original instruction.&#xD;&#xA;The CustomerPaymentReversal message can be used in domestic and cross-border scenarios."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="pain.007.001.01"
  xmlTag="pain.007.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_GXLbcNEvEd-BzquC8wXy7w_-1196112666"
    name="GroupReversal1Rule"
    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="_GXLbc9EvEd-BzquC8wXy7w_-1336052155"
    name="GroupReversal2Rule"
    definition="If GroupHeader/GroupReversal is true, then OriginalGroupInformation/ReversalReasonInformation/ReversalReason must present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_GXLbdtEvEd-BzquC8wXy7w_-1196112606"
    name="GroupReversal3Rule"
    definition="If GroupHeader/GroupReversal is false, then NumberOfTransactions must equal the number of occurrences of TransactionInformation."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_GXBqedEvEd-BzquC8wXy7w_1971893603"
    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="_PtjjLNp-Ed-ak6NoX_4Aeg_1192802893" />
  <messageBuildingBlock
    xmi:id="_GXBqetEvEd-BzquC8wXy7w_-1325673423"
    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="_GXBqe9EvEd-BzquC8wXy7w_-1906565683"
    name="TransactionInformation"
    definition="Information concerning the original transactions, to which the reversal message refers."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="TxInf"
    complexType="_Pr6kbtp-Ed-ak6NoX_4Aeg_2146802204" />
  <messageDefinitionIdentifier
    businessArea="pain"
    messageFunctionality="007"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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