PaymentStatusReportV02

pain.002.001.02

Scope The PaymentStatusReport 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 PaymentStatusReport 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 PaymentStatusReport 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 (e.g. PaymentCancellationRequest). The PaymentStatusReport 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 PaymentStatusReport message can be used in domestic and cross-border scenarios. The PaymentStatusReport message exchanged between agents and non-financial institution customers is identified in the schema as follows: urn:iso:std:iso:20022:tech:xsd:pain.002.001.02.

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
%% PaymentStatusReportV02 recursion level 0 with max 0
PaymentStatusReportV02 *-- "1..1" GroupHeader5 : GroupHeader
PaymentStatusReportV02 *-- "1..1" OriginalGroupInformation1 : OriginalGroupInformationAndStatus
PaymentStatusReportV02 *-- "0..1" PaymentTransactionInformation1 : TransactionInformationAndStatus
  

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
%% GroupHeader5 recursion level 0 with max 1
class GroupHeader5{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
GroupHeader5 *-- "0..1" PartyIdentification8 : InitiatingParty
GroupHeader5 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : ForwardingAgent
GroupHeader5 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : DebtorAgent
GroupHeader5 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : CreditorAgent
GroupHeader5 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingAgent
GroupHeader5 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructedAgent
%% 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
%% 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
  

GroupHeader5 members

OriginalGroupInformationAndStatus building block

Original group information concerning the group of transactions, to which the status report message refers to. 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
%% OriginalGroupInformation1 recursion level 0 with max 1
class OriginalGroupInformation1{
    OriginalMessageIdentification IsoMax35Text
    NetworkFileName IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
    FileOriginator IsoMax35Text
    OriginalNumberOfTransactions IsoMax15NumericText
    OriginalControlSum IsoDecimalNumber
    GroupStatus TransactionGroupStatus1Code
}
OriginalGroupInformation1 *-- "0..0" StatusReasonInformation1 : StatusReasonInformation
OriginalGroupInformation1 *-- "0..0" NumberOfTransactionsPerStatus1 : NumberOfTransactionsPerStatus
%% StatusReasonInformation1 recursion level 1 with max 1
class StatusReasonInformation1{
    AdditionalStatusReasonInformation IsoMax105Text
}
StatusReasonInformation1 *-- "0..1" PartyIdentification8 : StatusOriginator
StatusReasonInformation1 *-- "0..1" IStatusReason1Choice : StatusReason
%% NumberOfTransactionsPerStatus1 recursion level 1 with max 1
class NumberOfTransactionsPerStatus1{
    DetailedNumberOfTransactions IsoMax15NumericText
    DetailedStatus TransactionIndividualStatus1Code
    DetailedControlSum IsoDecimalNumber
}
  

OriginalGroupInformation1 members

TransactionInformationAndStatus building block

Information concerning the original transactions, to which the status report message refers. Information concerning the original transactions, to which the status report message refers. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PaymentTransactionInformation1 recursion level 0 with max 1
class PaymentTransactionInformation1{
    StatusIdentification IsoMax35Text
    OriginalPaymentInformationIdentification IsoMax35Text
    OriginalInstructionIdentification IsoMax35Text
    OriginalEndToEndIdentification IsoMax35Text
    OriginalTransactionIdentification IsoMax35Text
    TransactionStatus TransactionIndividualStatus1Code
    AcceptanceDateTime IsoISODateTime
}
PaymentTransactionInformation1 *-- "0..0" StatusReasonInformation1 : StatusReasonInformation
PaymentTransactionInformation1 *-- "0..0" ChargesInformation1 : ChargesInformation
PaymentTransactionInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingAgent
PaymentTransactionInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructedAgent
PaymentTransactionInformation1 *-- "0..1" OriginalTransactionReference1 : OriginalTransactionReference
%% StatusReasonInformation1 recursion level 1 with max 1
class StatusReasonInformation1{
    AdditionalStatusReasonInformation IsoMax105Text
}
StatusReasonInformation1 *-- "0..1" PartyIdentification8 : StatusOriginator
StatusReasonInformation1 *-- "0..1" IStatusReason1Choice : StatusReason
%% 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
%% 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
  

PaymentTransactionInformation1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    PaymentStatusReportV02 --|> IOuterRecord : Implements
    PaymentStatusReportV02Document --|> IOuterDocument~PaymentStatusReportV02~ : Implements
    class IOuterDocument~PaymentStatusReportV02~ {
        PaymentStatusReportV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    PaymentStatusReportV02Document *-- PaymentStatusReportV02 : 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.02">
    <pain.002.001.02>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <OrgnlGrpInfAndSts>
            <!-- OriginalGroupInformationAndStatus inner content -->
        </OrgnlGrpInfAndSts>
        <TxInfAndSts>
            <!-- TransactionInformationAndStatus inner content -->
        </TxInfAndSts>
    </pain.002.001.02>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_GZkBENEvEd-BzquC8wXy7w_-408419624"
  nextVersions="_GXeWaNEvEd-BzquC8wXy7w_246698582"
  name="PaymentStatusReportV02"
  definition="Scope&#xD;&#xA;The PaymentStatusReport 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 PaymentStatusReport 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 PaymentStatusReport 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 (e.g. PaymentCancellationRequest).&#xD;&#xA;The PaymentStatusReport 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 PaymentStatusReport message can be used in domestic and cross-border scenarios.&#xD;&#xA;The PaymentStatusReport message exchanged between agents and non-financial institution customers is identified in the schema as follows: urn:iso:std:iso:20022:tech:xsd:pain.002.001.02."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="pain.002.001.02"
  xmlTag="pain.002.001.02"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_GZkBFNEvEd-BzquC8wXy7w_-407499531"
    name="GroupAndTransactionStatus1Rule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to ACTC, ACCP, ACSP or ACSC, ACCR or ACWC, then TransactionInformationAndStatus/TransactionStatus must be different from RJCT."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_GZkBF9EvEd-BzquC8wXy7w_-407499521"
    name="GroupAndTransactionStatus2Rule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to PDNG, then TransactionInformationAndStatus/TransactionStatus must be different from RJCT."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_GZkBGtEvEd-BzquC8wXy7w_-407499519"
    name="GroupAndTransactionStatus3Rule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RJCT, then TransactionInformationAndStatus/TransactionStatus must be different from ACTC, ACCP, ACSP, ACSC, ACCR, ACWC or PDNG."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_GZtLANEvEd-BzquC8wXy7w_-407499491"
    name="GroupAndTransactionStatus4Rule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RCVD, then TransactionInformationAndStatus/TransactionStatus is not allowed."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_GZtLA9EvEd-BzquC8wXy7w_-407499489"
    name="InstructedAgentRule"
    definition="GroupHeader/InstructedAgent is not allowed."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_GZtLBtEvEd-BzquC8wXy7w_-407499470"
    name="InstructingAgentRule"
    definition="GroupHeader/InstructingAgent is not allowed."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_GZkBEdEvEd-BzquC8wXy7w_-407499552"
    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="_PuTKDNp-Ed-ak6NoX_4Aeg_-727666484" />
  <messageBuildingBlock
    xmi:id="_GZkBEtEvEd-BzquC8wXy7w_-408419593"
    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="_Pg5AJ9p-Ed-ak6NoX_4Aeg_312087008" />
  <messageBuildingBlock
    xmi:id="_GZkBE9EvEd-BzquC8wXy7w_-408419562"
    name="TransactionInformationAndStatus"
    definition="Information concerning the original transactions, to which the status report message refers."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="TxInfAndSts"
    complexType="_PsqLS9p-Ed-ak6NoX_4Aeg_-1746248440" />
  <messageDefinitionIdentifier
    businessArea="pain"
    messageFunctionality="002"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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