pain.007.001.03
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
%% CustomerPaymentReversalV03 recursion level 0 with max 0
CustomerPaymentReversalV03 *-- "1..1" GroupHeader56 : GroupHeader
CustomerPaymentReversalV03 *-- "1..1" OriginalGroupHeader3 : OriginalGroupInformation
CustomerPaymentReversalV03 *-- "0..1" OriginalPaymentInstruction2 : OriginalPaymentInformationAndReversal
CustomerPaymentReversalV03 *-- "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
%% GroupHeader56 recursion level 0 with max 1
class GroupHeader56{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
NumberOfTransactions IsoMax15NumericText
ControlSum IsoDecimalNumber
GroupReversal IsoTrueFalseIndicator
}
GroupHeader56 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader56 *-- "0..1" PartyIdentification43 : InitiatingParty
GroupHeader56 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : ForwardingAgent
GroupHeader56 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
GroupHeader56 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
Name IsoMax140Text
CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
GroupHeader56 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. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
| DebtorAgent | Financial institution servicing an account for the debtor. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
| CreditorAgent | Financial institution servicing an account for the creditor. | BranchAndFinancialInstitutionIdentification5 - 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
%% OriginalGroupHeader3 recursion level 0 with max 1
class OriginalGroupHeader3{
OriginalMessageIdentification IsoMax35Text
OriginalMessageNameIdentification IsoMax35Text
OriginalCreationDateTime IsoISODateTime
}
OriginalGroupHeader3 *-- "0..0" PaymentReversalReason7 : ReversalReasonInformation
%% PaymentReversalReason7 recursion level 1 with max 1
class PaymentReversalReason7{
AdditionalInformation IsoMax105Text
}
PaymentReversalReason7 *-- "0..1" PartyIdentification43 : Originator
PaymentReversalReason7 *-- "0..1" IReversalReason4Choice : Reason
OriginalGroupHeader3 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. | PaymentReversalReason7 - Unknown 0..0 |
OriginalPaymentInformationAndReversal building block
Information concerning the original payment information, to which the reversal message refers. Provides details on the original transactions, to which the status report message refers. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% OriginalPaymentInstruction2 recursion level 0 with max 1
class OriginalPaymentInstruction2{
ReversalPaymentInformationIdentification IsoMax35Text
OriginalPaymentInformationIdentification IsoMax35Text
OriginalNumberOfTransactions IsoMax15NumericText
OriginalControlSum IsoDecimalNumber
BatchBooking IsoBatchBookingIndicator
PaymentInformationReversal IsoTrueFalseIndicator
}
OriginalPaymentInstruction2 *-- "0..0" PaymentReversalReason7 : ReversalReasonInformation
OriginalPaymentInstruction2 *-- "0..0" PaymentTransaction35 : TransactionInformation
%% PaymentReversalReason7 recursion level 1 with max 1
class PaymentReversalReason7{
AdditionalInformation IsoMax105Text
}
PaymentReversalReason7 *-- "0..1" PartyIdentification43 : Originator
PaymentReversalReason7 *-- "0..1" IReversalReason4Choice : Reason
%% PaymentTransaction35 recursion level 1 with max 1
class PaymentTransaction35{
ReversalIdentification IsoMax35Text
OriginalInstructionIdentification IsoMax35Text
OriginalEndToEndIdentification IsoMax35Text
OriginalInstructedAmount IsoActiveOrHistoricCurrencyAndAmount
ReversedInstructedAmount IsoActiveOrHistoricCurrencyAndAmount
ChargeBearer ChargeBearerType1Code
}
PaymentTransaction35 *-- "0..0" PaymentReversalReason7 : ReversalReasonInformation
PaymentTransaction35 *-- "0..1" OriginalTransactionReference16 : OriginalTransactionReference
OriginalPaymentInstruction2 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. | PaymentReversalReason7 - Unknown 0..0 |
| TransactionInformation | Provides information on the original transactions to which the reversal message refers. | PaymentTransaction35 - 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 CustomerPaymentReversalV03 implementation follows a specific implementaiton pattern. First of all, CustomerPaymentReversalV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CustomerPaymentReversalV03Document implements IOuterDocument. Because CustomerPaymentReversalV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CustomerPaymentReversalV03.
classDiagram
class IOuterRecord
CustomerPaymentReversalV03 --|> IOuterRecord : Implements
CustomerPaymentReversalV03Document --|> IOuterDocument~CustomerPaymentReversalV03~ : Implements
class IOuterDocument~CustomerPaymentReversalV03~ {
CustomerPaymentReversalV03 Message
}
Document wrapper for serialization
The only real purpose CustomerPaymentReversalV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.007.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CustomerPaymentReversalV03.ToDocument() method. The returned CustomerPaymentReversalV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CustomerPaymentReversalV03Document *-- CustomerPaymentReversalV03 : 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.03">
<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="_r4JiIFkyEeGeoaLUQk__nA_2146216592"
nextVersions="_Z15XoSGmEeKjd4jizyIDGA"
previousVersion="_GXLbgtEvEd-BzquC8wXy7w_66905835"
name="CustomerPaymentReversalV03"
definition="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."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="CstmrPmtRvsl"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_r4vYAVkyEeGeoaLUQk__nA_1089140150"
name="GroupReversalAndPaymentInformationNotPresentRule"
definition="If GroupHeader/GroupReversal is true, then OriginalPaymentInformationAndReversal 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>/OriginalPaymentInformationAndReversal[*]</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/GroupReversal</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/GroupReversal</leftOperand><rightOperand>true</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_r5C6AFkyEeGeoaLUQk__nA_92067797"
name="GroupReversalAndReasonRule"
definition="If GroupHeader/GroupReversal is true, then OriginalGroupInformation/ReversalReasonInformation/ReversalReason must 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/ReversalReasonInformation[*]/Reason</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/GroupReversal</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/GroupReversal</leftOperand><rightOperand>true</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_r5fl8FkyEeGeoaLUQk__nA_-905004556"
name="GroupReversalAndNumberOfTransactionsRule"
definition="If GroupHeader/GroupReversal is false, then 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="Absence"><leftOperand>/OriginalPaymentInformationAndReversal[*]</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/GroupReversal</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/GroupReversal</leftOperand><rightOperand>true</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_r5ov4FkyEeGeoaLUQk__nA_-1902076909"
name="GroupReversalAndPaymentInformationPresentRule"
definition="If GroupHeader/GroupReversal is false, then at least one occurrence of OriginalPaymentInformationAndReversal 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>/OriginalPaymentInformationAndReversal[1]</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/GroupReversal</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/GroupReversal</leftOperand><rightOperand>false</rightOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<messageBuildingBlock
xmi:id="_r4cdEFkyEeGeoaLUQk__nA_-1211682440"
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="_s8i-Y1kyEeGeoaLUQk__nA_845535139" />
<messageBuildingBlock
xmi:id="_r4cdEVkyEeGeoaLUQk__nA_725542733"
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="_sinbcFkyEeGeoaLUQk__nA_1576775271" />
<messageBuildingBlock
xmi:id="_r4mOEFkyEeGeoaLUQk__nA_2086212503"
name="OriginalPaymentInformationAndReversal"
definition="Information concerning the original payment information, to which the reversal message refers."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="OrgnlPmtInfAndRvsl"
complexType="_sixMdFkyEeGeoaLUQk__nA_524273766" />
<messageBuildingBlock
xmi:id="_r4vYAFkyEeGeoaLUQk__nA_-898833965"
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="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.