pain.002.001.08
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. The CustomerPaymentStatusReport may also be sent to the receiver of the payment in a real time payment scenario, as both sides of the transactions must be informed of the status of the transaction (e.g. either the beneficiary is credited, or the transaction is rejected).
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 %% CustomerPaymentStatusReportV08 recursion level 0 with max 0 CustomerPaymentStatusReportV08 *-- "1..1" GroupHeader52 : GroupHeader CustomerPaymentStatusReportV08 *-- "1..1" OriginalGroupHeader7 : OriginalGroupInformationAndStatus CustomerPaymentStatusReportV08 *-- "0..1" OriginalPaymentInstruction23 : OriginalPaymentInformationAndStatus CustomerPaymentStatusReportV08 *-- "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 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 %% GroupHeader52 recursion level 0 with max 1 class GroupHeader52{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime } GroupHeader52 *-- "0..1" PartyIdentification43 : InitiatingParty GroupHeader52 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : ForwardingAgent GroupHeader52 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent GroupHeader52 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent %% 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
GroupHeader52 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. | PartyIdentification43 - 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. | 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 |
OriginalGroupInformationAndStatus building block
Original group information concerning the group of transactions, to which the status report message refers to. Provides details on the original group, to which the message refers. For comparison, see the ISO20022 official specification
classDiagram direction tb %% OriginalGroupHeader7 recursion level 0 with max 1 class OriginalGroupHeader7{ OriginalMessageIdentification IsoMax35Text OriginalMessageNameIdentification IsoMax35Text OriginalCreationDateTime IsoISODateTime OriginalNumberOfTransactions IsoMax15NumericText OriginalControlSum IsoDecimalNumber GroupStatus ExternalPaymentGroupStatus1Code } OriginalGroupHeader7 *-- "0..0" StatusReasonInformation9 : StatusReasonInformation OriginalGroupHeader7 *-- "0..0" NumberOfTransactionsPerStatus5 : NumberOfTransactionsPerStatus %% StatusReasonInformation9 recursion level 1 with max 1 class StatusReasonInformation9{ AdditionalInformation IsoMax105Text } StatusReasonInformation9 *-- "0..1" PartyIdentification43 : Originator StatusReasonInformation9 *-- "0..1" IStatusReason6Choice : Reason %% NumberOfTransactionsPerStatus5 recursion level 1 with max 1 class NumberOfTransactionsPerStatus5{ DetailedNumberOfTransactions IsoMax15NumericText DetailedStatus ExternalPaymentTransactionStatus1Code DetailedControlSum IsoDecimalNumber }
OriginalGroupHeader7 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. | ExternalPaymentGroupStatus1Code - Optional 0..1 |
StatusReasonInformation | Provides detailed information on the status reason. | StatusReasonInformation9 - Unknown 0..0 |
NumberOfTransactionsPerStatus | Detailed information on the number of transactions for each identical transaction status. | NumberOfTransactionsPerStatus5 - Unknown 0..0 |
OriginalPaymentInformationAndStatus building block
Information concerning the original payment information, to which the status report message refers. Provides details information on the original transactions, to which the status report message refers. For comparison, see the ISO20022 official specification
classDiagram direction tb %% OriginalPaymentInstruction23 recursion level 0 with max 1 class OriginalPaymentInstruction23{ OriginalPaymentInformationIdentification IsoMax35Text OriginalNumberOfTransactions IsoMax15NumericText OriginalControlSum IsoDecimalNumber PaymentInformationStatus ExternalPaymentGroupStatus1Code } OriginalPaymentInstruction23 *-- "0..0" StatusReasonInformation9 : StatusReasonInformation OriginalPaymentInstruction23 *-- "0..0" NumberOfTransactionsPerStatus5 : NumberOfTransactionsPerStatus OriginalPaymentInstruction23 *-- "0..0" PaymentTransaction82 : TransactionInformationAndStatus %% StatusReasonInformation9 recursion level 1 with max 1 class StatusReasonInformation9{ AdditionalInformation IsoMax105Text } StatusReasonInformation9 *-- "0..1" PartyIdentification43 : Originator StatusReasonInformation9 *-- "0..1" IStatusReason6Choice : Reason %% NumberOfTransactionsPerStatus5 recursion level 1 with max 1 class NumberOfTransactionsPerStatus5{ DetailedNumberOfTransactions IsoMax15NumericText DetailedStatus ExternalPaymentTransactionStatus1Code DetailedControlSum IsoDecimalNumber } %% PaymentTransaction82 recursion level 1 with max 1 class PaymentTransaction82{ StatusIdentification IsoMax35Text OriginalInstructionIdentification IsoMax35Text OriginalEndToEndIdentification IsoMax35Text TransactionStatus ExternalPaymentTransactionStatus1Code AcceptanceDateTime IsoISODateTime AccountServicerReference IsoMax35Text ClearingSystemReference IsoMax35Text } PaymentTransaction82 *-- "0..0" StatusReasonInformation9 : StatusReasonInformation PaymentTransaction82 *-- "0..0" Charges2 : ChargesInformation PaymentTransaction82 *-- "0..1" OriginalTransactionReference24 : OriginalTransactionReference PaymentTransaction82 *-- "0..0" SupplementaryData1 : SupplementaryData
OriginalPaymentInstruction23 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. | ExternalPaymentGroupStatus1Code - Optional 0..1 |
StatusReasonInformation | Provides detailed information on the status reason. | StatusReasonInformation9 - Unknown 0..0 |
NumberOfTransactionsPerStatus | Detailed information on the number of transactions for each identical transaction status. | NumberOfTransactionsPerStatus5 - Unknown 0..0 |
TransactionInformationAndStatus | Provides information on the original transactions to which the status report message refers. | PaymentTransaction82 - 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 CustomerPaymentStatusReportV08 implementation follows a specific implementaiton pattern. First of all, CustomerPaymentStatusReportV08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CustomerPaymentStatusReportV08Document implements IOuterDocument. Because CustomerPaymentStatusReportV08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CustomerPaymentStatusReportV08.
classDiagram class IOuterRecord CustomerPaymentStatusReportV08 --|> IOuterRecord : Implements CustomerPaymentStatusReportV08Document --|> IOuterDocument~CustomerPaymentStatusReportV08~ : Implements class IOuterDocument~CustomerPaymentStatusReportV08~ { CustomerPaymentStatusReportV08 Message }
Document wrapper for serialization
The only real purpose CustomerPaymentStatusReportV08Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.002.001.08’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CustomerPaymentStatusReportV08.ToDocument() method. The returned CustomerPaymentStatusReportV08Document value will serialize correctly according to ISO 20022 standards.
classDiagram CustomerPaymentStatusReportV08Document *-- CustomerPaymentStatusReportV08 : 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.08">
<CstmrPmtStsRpt>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<OrgnlGrpInfAndSts>
<!-- OriginalGroupInformationAndStatus inner content -->
</OrgnlGrpInfAndSts>
<OrgnlPmtInfAndSts>
<!-- OriginalPaymentInformationAndStatus inner content -->
</OrgnlPmtInfAndSts>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CstmrPmtStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Tx4qEWXiEeap-P22vGV91g"
nextVersions="_cwRz1bPfEeeppqgHuc69jg"
previousVersion="_akmeMTqxEeWZFYSPlduMhw"
name="CustomerPaymentStatusReportV08"
definition="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.
The CustomerPaymentStatusReport may also be sent to the receiver of the payment in a real time payment scenario, as both sides of the transactions must be informed of the status of the transaction (e.g. either the beneficiary is credited, or the transaction is rejected)."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="CstmrPmtStsRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_Tx4qE2XiEeap-P22vGV91g"
nextVersions="_cwRz17PfEeeppqgHuc69jg"
previousVersion="_akmeMzqxEeWZFYSPlduMhw"
name="GroupStatusAcceptedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to ACTC (AcceptedTechnicalValidation), ACCP (AcceptedCustomerProfile), ACSP (AcceptedSettlementInProcess), ACSC (AcceptedSettlementCompleted) or ACWC (AcceptedWithChange), then OriginalPaymentInformationAndStatus/PaymentInformationStatus must be different from RJCT (Rejected)."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="NotWithInList"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand><rightOperand>ValidationRuleRejected1Code</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>ValidationRuleStatus1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_Tx4qFWXiEeap-P22vGV91g"
nextVersions="_cwRz2bPfEeeppqgHuc69jg"
previousVersion="_akmeNTqxEeWZFYSPlduMhw"
name="GroupStatusPendingRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to PDNG (Pending), then OriginalPaymentInformationAndStatus/PaymentInformationStatus must be different from RJCT (Rejected)."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="NotWithInList"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand><rightOperand>ValidationRuleRejected1Code</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>ValidationRulePending1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_Tx4qF2XiEeap-P22vGV91g"
nextVersions="_cwRz27PfEeeppqgHuc69jg"
previousVersion="_akmeNzqxEeWZFYSPlduMhw"
name="GroupStatusRejectedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RJCT (Rejected), then OriginalPaymentInformationAndStatus/PaymentInformationStatus, if present, must be equal to RJCT (Rejected)."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand><rightOperand>ValidationRuleRejected1Code</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>ValidationRuleRejected1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_Tx4qGWXiEeap-P22vGV91g"
nextVersions="_cwRz3bPfEeeppqgHuc69jg"
previousVersion="_akmeOTqxEeWZFYSPlduMhw"
name="GroupStatusReceivedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RCVD (Received), then OriginalPaymentInformationAndStatus/PaymentInformationStatus is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>ValidationRuleReceived1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalPaymentInformationAndStatus[1]</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_Tx4qG2XiEeap-P22vGV91g"
nextVersions="_cwRz37PfEeeppqgHuc69jg"
previousVersion="_akmeOzqxEeWZFYSPlduMhw"
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="_Tx4qHWXiEeap-P22vGV91g"
nextVersions="_cwRz4bPfEeeppqgHuc69jg"
previousVersion="_akmePTqxEeWZFYSPlduMhw"
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="_s7DwoVkyEeGeoaLUQk__nA_-1533000831" />
<messageBuildingBlock
xmi:id="_Tx4qH2XiEeap-P22vGV91g"
nextVersions="_cwRz47PfEeeppqgHuc69jg"
previousVersion="_akmePzqxEeWZFYSPlduMhw"
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="_oRlBYWXiEeap-P22vGV91g" />
<messageBuildingBlock
xmi:id="_Tx4qIWXiEeap-P22vGV91g"
nextVersions="_cwRz5bPfEeeppqgHuc69jg"
previousVersion="_akmeQTqxEeWZFYSPlduMhw"
name="OriginalPaymentInformationAndStatus"
definition="Information concerning the original payment information, to which the status report message refers."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="OrgnlPmtInfAndSts"
complexType="_VWH872XlEeap-P22vGV91g" />
<messageBuildingBlock
xmi:id="_Tx4qI2XiEeap-P22vGV91g"
nextVersions="_cwRz57PfEeeppqgHuc69jg"
previousVersion="_akmeQzqxEeWZFYSPlduMhw"
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="002"
flavour="001"
version="08" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.