Iso20022

CustomerPaymentReversalV11

pain.007.001.11

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
%% CustomerPaymentReversalV11 recursion level 0 with max 0
CustomerPaymentReversalV11 *-- "1..1" GroupHeader88 : GroupHeader
CustomerPaymentReversalV11 *-- "1..1" OriginalGroupHeader16 : OriginalGroupInformation
CustomerPaymentReversalV11 *-- "0..1" OriginalPaymentInstruction41 : OriginalPaymentInformationAndReversal
CustomerPaymentReversalV11 *-- "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. Provides characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% GroupHeader88 recursion level 0 with max 1
class GroupHeader88{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    GroupReversal IsoTrueFalseIndicator
}
GroupHeader88 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader88 *-- "0..1" PartyIdentification135 : InitiatingParty
GroupHeader88 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ForwardingAgent
GroupHeader88 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
GroupHeader88 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% 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
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification

GroupHeader88 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.
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
GroupReversal Indicates whether the reversal applies to the whole group of transactions or to individual transactions within the original group. IsoTrueFalseIndicator - Optional 0..1
InitiatingParty Party that initiates the reversal message. Usage: This can be either the creditor or a party that initiates the reversal of the direct debit on behalf of the creditor.
ForwardingAgent Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain. BranchAndFinancialInstitutionIdentification6 - Optional 0..1
DebtorAgent Financial institution servicing an account for the debtor. BranchAndFinancialInstitutionIdentification6 - Optional 0..1
CreditorAgent Financial institution servicing an account for the creditor. BranchAndFinancialInstitutionIdentification6 - Optional 0..1

OriginalGroupInformation building block

Information concerning the original group of transactions, to which the message refers. Provides details on the original group, to which the message refers. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% OriginalGroupHeader16 recursion level 0 with max 1
class OriginalGroupHeader16{
    OriginalMessageIdentification IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
}
OriginalGroupHeader16 *-- "0..0" PaymentReversalReason9 : ReversalReasonInformation
%% PaymentReversalReason9 recursion level 1 with max 1
class PaymentReversalReason9{
    AdditionalInformation IsoMax105Text
}
PaymentReversalReason9 *-- "0..1" PartyIdentification135 : Originator
PaymentReversalReason9 *-- "0..1" IReversalReason4Choice : Reason

OriginalGroupHeader16 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
ReversalReasonInformation Provides detailed information on the reversal reason. PaymentReversalReason9 - Unknown 0..0

OriginalPaymentInformationAndReversal building block

Information concerning the original payment information, to which the reversal message refers. Provides detailed information on the original transaction, to which the status report message refers. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% OriginalPaymentInstruction41 recursion level 0 with max 1
class OriginalPaymentInstruction41{
    ReversalPaymentInformationIdentification IsoMax35Text
    OriginalPaymentInformationIdentification IsoMax35Text
    OriginalNumberOfTransactions IsoMax15NumericText
    OriginalControlSum IsoDecimalNumber
    BatchBooking IsoBatchBookingIndicator
    PaymentInformationReversal IsoTrueFalseIndicator
}
OriginalPaymentInstruction41 *-- "0..0" PaymentReversalReason9 : ReversalReasonInformation
OriginalPaymentInstruction41 *-- "0..0" PaymentTransaction134 : TransactionInformation
%% PaymentReversalReason9 recursion level 1 with max 1
class PaymentReversalReason9{
    AdditionalInformation IsoMax105Text
}
PaymentReversalReason9 *-- "0..1" PartyIdentification135 : Originator
PaymentReversalReason9 *-- "0..1" IReversalReason4Choice : Reason
%% PaymentTransaction134 recursion level 1 with max 1
class PaymentTransaction134{
    ReversalIdentification IsoMax35Text
    OriginalInstructionIdentification IsoMax35Text
    OriginalEndToEndIdentification IsoMax35Text
    OriginalUETR IsoUUIDv4Identifier
    OriginalInstructedAmount IsoActiveOrHistoricCurrencyAndAmount
    ReversedInstructedAmount IsoActiveOrHistoricCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
}
PaymentTransaction134 *-- "0..0" PaymentReversalReason9 : ReversalReasonInformation
PaymentTransaction134 *-- "0..1" OriginalTransactionReference35 : OriginalTransactionReference
PaymentTransaction134 *-- "0..0" SupplementaryData1 : SupplementaryData

OriginalPaymentInstruction41 members

Member name Description Data Type / Multiplicity
ReversalPaymentInformationIdentification Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the reversed payment information group. Usage: The instructing party is the party sending the reversal message and not the party that sent the original instruction that is being reversed.
OriginalPaymentInformationIdentification Unique identification, as assigned by the original sending party, to unambiguously identify the original payment information group. IsoMax35Text - Required 1..1
OriginalNumberOfTransactions Number of individual transactions contained in the original payment information group. IsoMax15NumericText - Optional 0..1
OriginalControlSum Total of all individual amounts included in the original payment information group, irrespective of currencies. IsoDecimalNumber - Optional 0..1
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.
PaymentInformationReversal Indicates whether or not the reversal applies to the complete original payment information group or to individual transactions within that group. IsoTrueFalseIndicator - Optional 0..1
ReversalReasonInformation Provides detailed information on the reversal reason. PaymentReversalReason9 - Unknown 0..0
TransactionInformation Provides information on the original transactions to which the reversal message refers. PaymentTransaction134 - 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 CustomerPaymentReversalV11 implementation follows a specific implementaiton pattern. First of all, CustomerPaymentReversalV11 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CustomerPaymentReversalV11Document implements IOuterDocument. Because CustomerPaymentReversalV11 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CustomerPaymentReversalV11.

classDiagram
    class IOuterRecord
    CustomerPaymentReversalV11 --|> IOuterRecord : Implements
    CustomerPaymentReversalV11Document --|> IOuterDocument~CustomerPaymentReversalV11~ : Implements
    class IOuterDocument~CustomerPaymentReversalV11~ {
        CustomerPaymentReversalV11 Message
     }

Document wrapper for serialization

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

classDiagram
    CustomerPaymentReversalV11Document *-- CustomerPaymentReversalV11 : 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.11">
    <CstmrPmtRvsl>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <OrgnlGrpInf>
            <!-- OriginalGroupInformation inner content -->
        </OrgnlGrpInf>
        <OrgnlPmtInfAndRvsl>
            <!-- OriginalPaymentInformationAndReversal inner content -->
        </OrgnlPmtInfAndRvsl>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CstmrPmtRvsl>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_rUXm6dcBEeq_l4BJLVUF2Q"
  previousVersion="_LwD3S8P_Eemsic1bQcEtLA"
  name="CustomerPaymentReversalV11"
  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="_ivfzI_2XEeG0oal_knwJ7A"
  xmlTag="CstmrPmtRvsl"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_rUXm69cBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3TcP_Eemsic1bQcEtLA"
    name="GroupReversalAndPaymentInformationNotPresentRule"
    definition="If GroupHeader/GroupReversal is true, then OriginalPaymentInformationAndReversal is not allowed."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndReversal[*]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/GroupHeader/GroupReversal&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/GroupHeader/GroupReversal&lt;/leftOperand&gt;&lt;rightOperand&gt;true&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_rUXm7dcBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3T8P_Eemsic1bQcEtLA"
    name="GroupReversalAndReasonRule"
    definition="If GroupHeader/GroupReversal is true, then OriginalGroupInformation/ReversalReasonInformation/Reason must present."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformation/ReversalReasonInformation[*]/Reason&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/GroupHeader/GroupReversal&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/GroupHeader/GroupReversal&lt;/leftOperand&gt;&lt;rightOperand&gt;true&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_rUXm79cBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3UcP_Eemsic1bQcEtLA"
    name="GroupReversalAndNumberOfTransactionsGuideline"
    definition="If GroupHeader/GroupReversal is false and OriginalPaymentInformationAndReversal[*]/PaymentInformationReversal is false, then NumberOfTransactions must equal the number of occurrences of OriginalPaymentInformationAndReversal[*]/TransactionInformation."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_rUXm8dcBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3U8P_Eemsic1bQcEtLA"
    name="GroupReversalAndPaymentInformationPresentRule"
    definition="If GroupHeader/GroupReversal is false, then at least one occurrence of OriginalPaymentInformationAndReversal must be present."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndReversal[1]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/GroupHeader/GroupReversal&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/GroupHeader/GroupReversal&lt;/leftOperand&gt;&lt;rightOperand&gt;false&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_rUXm89cBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3VcP_Eemsic1bQcEtLA"
    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="_rUXm-9cBEeq_l4BJLVUF2Q"
    previousVersion="_LwEeN8P_Eemsic1bQcEtLA"
    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="_aHxYAW49EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_rUXm_dcBEeq_l4BJLVUF2Q"
    previousVersion="_LwEeOcP_Eemsic1bQcEtLA"
    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="_Y1X8AW49EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_rUXm_9cBEeq_l4BJLVUF2Q"
    previousVersion="_LwEeO8P_Eemsic1bQcEtLA"
    name="OriginalPaymentInformationAndReversal"
    definition="Information concerning the original payment information, to which the reversal message refers."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="OrgnlPmtInfAndRvsl"
    complexType="_b2IDMdcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_rUXnAdcBEeq_l4BJLVUF2Q"
    previousVersion="_LwEePcP_Eemsic1bQcEtLA"
    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="pain"
    messageFunctionality="007"
    flavour="001"
    version="11" />
</messageDefinition>

ISO Building Blocks

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