Iso20022

CustomerPaymentStatusReportV03

pain.002.001.03

Scope The CustomerPaymentStatusReport message is sent by an instructed agent to the previous party in the payment chain. It is used to inform this party about the positive or negative status of an instruction (either single or file). It is also used to report on a pending instruction. Usage The CustomerPaymentStatusReport message is exchanged between an agent and a non-financial institution customer to provide status information on instructions previously sent. Its usage will always be governed by a bilateral agreement between the agent and the non-financial institution customer. The CustomerPaymentStatusReport message can be used to provide information about the status (e.g. rejection, acceptance) of the initiation of a credit transfer, a direct debit, as well as on the initiation of other customer instructions. The CustomerPaymentStatusReport 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. The CustomerPaymentStatusReport 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
%% CustomerPaymentStatusReportV03 recursion level 0 with max 0
CustomerPaymentStatusReportV03 *-- "1..1" GroupHeader36 : GroupHeader
CustomerPaymentStatusReportV03 *-- "1..1" OriginalGroupInformation20 : OriginalGroupInformationAndStatus
CustomerPaymentStatusReportV03 *-- "0..1" OriginalPaymentInformation1 : OriginalPaymentInformationAndStatus

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 status report message. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% GroupHeader36 recursion level 0 with max 1
class GroupHeader36{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
GroupHeader36 *-- "0..1" PartyIdentification32 : InitiatingParty
GroupHeader36 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : ForwardingAgent
GroupHeader36 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : DebtorAgent
GroupHeader36 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : CreditorAgent
%% PartyIdentification32 recursion level 1 with max 1
class PartyIdentification32{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification32 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification32 *-- "0..1" IParty6Choice : Identification
PartyIdentification32 *-- "0..1" ContactDetails2 : ContactDetails
%% BranchAndFinancialInstitutionIdentification4 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification4 *-- "1..1" FinancialInstitutionIdentification7 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification4 *-- "0..1" BranchData2 : BranchIdentification
%% BranchAndFinancialInstitutionIdentification4 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification4 *-- "1..1" FinancialInstitutionIdentification7 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification4 *-- "0..1" BranchData2 : BranchIdentification
%% BranchAndFinancialInstitutionIdentification4 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification4 *-- "1..1" FinancialInstitutionIdentification7 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification4 *-- "0..1" BranchData2 : BranchIdentification

GroupHeader36 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
InitiatingParty Party that initiates the status message. PartyIdentification32 - Optional 0..1
ForwardingAgent Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain. BranchAndFinancialInstitutionIdentification4 - Optional 0..1
DebtorAgent Financial institution servicing an account for the debtor. BranchAndFinancialInstitutionIdentification4 - Optional 0..1
CreditorAgent Financial institution servicing an account for the creditor. BranchAndFinancialInstitutionIdentification4 - Optional 0..1

OriginalGroupInformationAndStatus building block

Original group information concerning the group of transactions, to which the status report message refers to. Set of elements used to provide information on the original group, to which the message refers. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% OriginalGroupInformation20 recursion level 0 with max 1
class OriginalGroupInformation20{
    OriginalMessageIdentification IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
    OriginalNumberOfTransactions IsoMax15NumericText
    OriginalControlSum IsoDecimalNumber
    GroupStatus TransactionGroupStatus3Code
}
OriginalGroupInformation20 *-- "0..0" StatusReasonInformation8 : StatusReasonInformation
OriginalGroupInformation20 *-- "0..0" NumberOfTransactionsPerStatus3 : NumberOfTransactionsPerStatus
%% StatusReasonInformation8 recursion level 1 with max 1
class StatusReasonInformation8{
    AdditionalInformation IsoMax105Text
}
StatusReasonInformation8 *-- "0..1" PartyIdentification32 : Originator
StatusReasonInformation8 *-- "0..1" IStatusReason6Choice : Reason
%% NumberOfTransactionsPerStatus3 recursion level 1 with max 1
class NumberOfTransactionsPerStatus3{
    DetailedNumberOfTransactions IsoMax15NumericText
    DetailedStatus TransactionIndividualStatus3Code
    DetailedControlSum IsoDecimalNumber
}

OriginalGroupInformation20 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
OriginalNumberOfTransactions Number of individual transactions contained in the original message. IsoMax15NumericText - Optional 0..1
OriginalControlSum Total of all individual amounts included in the original message, irrespective of currencies. IsoDecimalNumber - Optional 0..1
GroupStatus Specifies the status of a group of transactions. TransactionGroupStatus3Code - Optional 0..1
StatusReasonInformation Set of elements used to provide detailed information on the status reason. StatusReasonInformation8 - Unknown 0..0
NumberOfTransactionsPerStatus Detailed information on the number of transactions for each identical transaction status. NumberOfTransactionsPerStatus3 - Unknown 0..0

OriginalPaymentInformationAndStatus building block

Information concerning the original payment information, to which the status report message refers. Set of elements used to provide information on the original transactions, to which the status report message refers. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% OriginalPaymentInformation1 recursion level 0 with max 1
class OriginalPaymentInformation1{
    OriginalPaymentInformationIdentification IsoMax35Text
    OriginalNumberOfTransactions IsoMax15NumericText
    OriginalControlSum IsoDecimalNumber
    PaymentInformationStatus TransactionGroupStatus3Code
}
OriginalPaymentInformation1 *-- "0..0" StatusReasonInformation8 : StatusReasonInformation
OriginalPaymentInformation1 *-- "0..0" NumberOfTransactionsPerStatus3 : NumberOfTransactionsPerStatus
OriginalPaymentInformation1 *-- "0..0" PaymentTransactionInformation25 : TransactionInformationAndStatus
%% StatusReasonInformation8 recursion level 1 with max 1
class StatusReasonInformation8{
    AdditionalInformation IsoMax105Text
}
StatusReasonInformation8 *-- "0..1" PartyIdentification32 : Originator
StatusReasonInformation8 *-- "0..1" IStatusReason6Choice : Reason
%% NumberOfTransactionsPerStatus3 recursion level 1 with max 1
class NumberOfTransactionsPerStatus3{
    DetailedNumberOfTransactions IsoMax15NumericText
    DetailedStatus TransactionIndividualStatus3Code
    DetailedControlSum IsoDecimalNumber
}
%% PaymentTransactionInformation25 recursion level 1 with max 1
class PaymentTransactionInformation25{
    StatusIdentification IsoMax35Text
    OriginalInstructionIdentification IsoMax35Text
    OriginalEndToEndIdentification IsoMax35Text
    TransactionStatus TransactionIndividualStatus3Code
    AcceptanceDateTime IsoISODateTime
    AccountServicerReference IsoMax35Text
    ClearingSystemReference IsoMax35Text
}
PaymentTransactionInformation25 *-- "0..0" StatusReasonInformation8 : StatusReasonInformation
PaymentTransactionInformation25 *-- "0..0" ChargesInformation5 : ChargesInformation
PaymentTransactionInformation25 *-- "0..1" OriginalTransactionReference13 : OriginalTransactionReference

OriginalPaymentInformation1 members

Member name Description Data Type / Multiplicity
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
PaymentInformationStatus Specifies the status of the payment information group. TransactionGroupStatus3Code - Optional 0..1
StatusReasonInformation Set of elements used to provide detailed information on the status reason. StatusReasonInformation8 - Unknown 0..0
NumberOfTransactionsPerStatus Detailed information on the number of transactions for each identical transaction status. NumberOfTransactionsPerStatus3 - Unknown 0..0
TransactionInformationAndStatus Set of elements used to provide information on the original transactions to which the status report message refers. PaymentTransactionInformation25 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CustomerPaymentStatusReportV03 --|> IOuterRecord : Implements
    CustomerPaymentStatusReportV03Document --|> IOuterDocument~CustomerPaymentStatusReportV03~ : Implements
    class IOuterDocument~CustomerPaymentStatusReportV03~ {
        CustomerPaymentStatusReportV03 Message
     }

Document wrapper for serialization

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

classDiagram
    CustomerPaymentStatusReportV03Document *-- CustomerPaymentStatusReportV03 : 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.002.001.03">
    <CstmrPmtStsRpt>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <OrgnlGrpInfAndSts>
            <!-- OriginalGroupInformationAndStatus inner content -->
        </OrgnlGrpInfAndSts>
        <OrgnlPmtInfAndSts>
            <!-- OriginalPaymentInformationAndStatus inner content -->
        </OrgnlPmtInfAndSts>
    </CstmrPmtStsRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_GXeWaNEvEd-BzquC8wXy7w_246698582"
  nextVersions="_r6PM0FkyEeGeoaLUQk__nA_629151"
  previousVersion="_GZkBENEvEd-BzquC8wXy7w_-408419624"
  name="CustomerPaymentStatusReportV03"
  definition="Scope&#xD;&#xA;The CustomerPaymentStatusReport message is sent by an instructed agent to the previous party in the payment chain. It is used to inform this party about the positive or negative status of an instruction (either single or file). It is also used to report on a pending instruction.&#xD;&#xA;Usage&#xD;&#xA;The CustomerPaymentStatusReport message is exchanged between an agent and a non-financial institution customer to provide status information on instructions previously sent. Its usage will always be governed by a bilateral agreement between the agent and the non-financial institution customer.&#xD;&#xA;The CustomerPaymentStatusReport message can be used to provide information about the status (e.g. rejection, acceptance) of the initiation of a credit transfer, a direct debit, as well as on the initiation of other customer instructions.&#xD;&#xA;The CustomerPaymentStatusReport 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;&#xA;The CustomerPaymentStatusReport message can be used in domestic and cross-border scenarios."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CstmrPmtStsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_GXeWbNEvEd-BzquC8wXy7w_-559570615"
    name="GroupStatusAcceptedRule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to ACTC, ACCP, ACSP, ACSC or ACWC, then OriginalPaymentInformationAndStatus/PaymentInformationStatus must be different from RJCT."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;DifferentFromValue&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;Rejected&lt;/rightOperand&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;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;WithInList&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;PartialGroupStatus1Code&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_GXeWb9EvEd-BzquC8wXy7w_-559570584"
    name="GroupStatusPendingRule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to PDNG, then OriginalPaymentInformationAndStatus/PaymentInformationStatus must be different from RJCT."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;DifferentFromValue&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;Rejected&lt;/rightOperand&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;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;Pending&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_GXoHYtEvEd-BzquC8wXy7w_-559570553"
    name="GroupStatusRejectedRule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RJCT, then OriginalPaymentInformationAndStatus/PaymentInformationStatus, if present, must be equal to RJCT."
    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;NotWithInList&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;PartialGroupStatus2Code&lt;/rightOperand&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;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;Rejected&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_GXoHZdEvEd-BzquC8wXy7w_-559570552"
    name="GroupStatusReceivedRule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RCVD, then OriginalPaymentInformationAndStatus/PaymentInformationStatus 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;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&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;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;Received&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[1]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <messageBuildingBlock
    xmi:id="_GXeWadEvEd-BzquC8wXy7w_949231273"
    name="GroupHeader"
    definition="Set of characteristics shared by all individual transactions included in the status report message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_P1AO9Np-Ed-ak6NoX_4Aeg_650011444" />
  <messageBuildingBlock
    xmi:id="_GXeWatEvEd-BzquC8wXy7w_1351887944"
    name="OriginalGroupInformationAndStatus"
    definition="Original group information concerning the group of transactions, to which the status report message refers to."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="OrgnlGrpInfAndSts"
    complexType="_Pk6khNp-Ed-ak6NoX_4Aeg_1311252989" />
  <messageBuildingBlock
    xmi:id="_GXeWa9EvEd-BzquC8wXy7w_-667525122"
    name="OriginalPaymentInformationAndStatus"
    definition="Information concerning the original payment information, to which the status report message refers."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="OrgnlPmtInfAndSts"
    complexType="_PlNfeNp-Ed-ak6NoX_4Aeg_-724783751" />
  <messageDefinitionIdentifier
    businessArea="pain"
    messageFunctionality="002"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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