pacs.002.001.03
Scope The FinancialInstitutionToFinancialInstitutionPaymentStatusReport 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 FIToFIPaymentStatusReport message is exchanged between agents to provide status information about instructions previously sent. Its usage will always be governed by a bilateral agreement between the agents. The FIToFIPaymentStatusReport message can be used to provide information about the status (e.g. rejection, acceptance) of a credit transfer instruction, a direct debit instruction, as well as other intra-agent instructions (for example FIToFIPaymentCancellationRequest). The FIToFIPaymentStatusReport 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 FIToFIPaymentStatusReport 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 %% FIToFIPaymentStatusReportV03 recursion level 0 with max 0 FIToFIPaymentStatusReportV03 *-- "1..1" GroupHeader37 : GroupHeader FIToFIPaymentStatusReportV03 *-- "1..1" OriginalGroupInformation20 : OriginalGroupInformationAndStatus FIToFIPaymentStatusReportV03 *-- "0..1" PaymentTransactionInformation26 : 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 %% GroupHeader37 recursion level 0 with max 1 class GroupHeader37{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime } GroupHeader37 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : InstructingAgent GroupHeader37 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : InstructedAgent %% 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
GroupHeader37 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 |
InstructingAgent | Agent that instructs the next party in the chain to carry out the (set of) instruction(s). | |
InstructedAgent | Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s). |
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 |
TransactionInformationAndStatus building block
Information concerning the original transactions, 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 %% PaymentTransactionInformation26 recursion level 0 with max 1 class PaymentTransactionInformation26{ StatusIdentification IsoMax35Text OriginalInstructionIdentification IsoMax35Text OriginalEndToEndIdentification IsoMax35Text OriginalTransactionIdentification IsoMax35Text TransactionStatus TransactionIndividualStatus3Code AcceptanceDateTime IsoISODateTime AccountServicerReference IsoMax35Text ClearingSystemReference IsoMax35Text } PaymentTransactionInformation26 *-- "0..0" StatusReasonInformation8 : StatusReasonInformation PaymentTransactionInformation26 *-- "0..0" ChargesInformation5 : ChargesInformation PaymentTransactionInformation26 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : InstructingAgent PaymentTransactionInformation26 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : InstructedAgent PaymentTransactionInformation26 *-- "0..1" OriginalTransactionReference13 : OriginalTransactionReference %% StatusReasonInformation8 recursion level 1 with max 1 class StatusReasonInformation8{ AdditionalInformation IsoMax105Text } StatusReasonInformation8 *-- "0..1" PartyIdentification32 : Originator StatusReasonInformation8 *-- "0..1" IStatusReason6Choice : Reason %% ChargesInformation5 recursion level 1 with max 1 class ChargesInformation5{ Amount IsoActiveOrHistoricCurrencyAndAmount } ChargesInformation5 *-- "1..1" BranchAndFinancialInstitutionIdentification4 : Party %% 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 %% OriginalTransactionReference13 recursion level 1 with max 1 class OriginalTransactionReference13{ InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount InterbankSettlementDate IsoISODate RequestedCollectionDate IsoISODate RequestedExecutionDate IsoISODate PaymentMethod PaymentMethod4Code } OriginalTransactionReference13 *-- "0..1" IAmountType3Choice : Amount OriginalTransactionReference13 *-- "0..1" PartyIdentification32 : CreditorSchemeIdentification OriginalTransactionReference13 *-- "0..1" SettlementInformation13 : SettlementInformation OriginalTransactionReference13 *-- "0..1" PaymentTypeInformation22 : PaymentTypeInformation OriginalTransactionReference13 *-- "0..1" MandateRelatedInformation6 : MandateRelatedInformation OriginalTransactionReference13 *-- "0..1" RemittanceInformation5 : RemittanceInformation OriginalTransactionReference13 *-- "0..1" PartyIdentification32 : UltimateDebtor OriginalTransactionReference13 *-- "0..1" PartyIdentification32 : Debtor OriginalTransactionReference13 *-- "0..1" CashAccount16 : DebtorAccount OriginalTransactionReference13 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : DebtorAgent OriginalTransactionReference13 *-- "0..1" CashAccount16 : DebtorAgentAccount OriginalTransactionReference13 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : CreditorAgent OriginalTransactionReference13 *-- "0..1" CashAccount16 : CreditorAgentAccount OriginalTransactionReference13 *-- "0..1" PartyIdentification32 : Creditor OriginalTransactionReference13 *-- "0..1" CashAccount16 : CreditorAccount OriginalTransactionReference13 *-- "0..1" PartyIdentification32 : UltimateCreditor
PaymentTransactionInformation26 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
StatusIdentification | Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the reported status. | Usage: The instructing party is the party sending the status message and not the party that sent the original instruction that is being reported on. |
OriginalInstructionIdentification | Unique identification, as assigned by the original instructing party for the original instructed party, to unambiguously identify the original instruction. | IsoMax35Text - Optional 0..1 |
OriginalEndToEndIdentification | Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction. | IsoMax35Text - Optional 0..1 |
OriginalTransactionIdentification | Unique identification, as assigned by the original first instructing agent, to unambiguously identify the transaction. | IsoMax35Text - Optional 0..1 |
TransactionStatus | Specifies the status of a transaction, in a coded form. | TransactionIndividualStatus3Code - Optional 0..1 |
StatusReasonInformation | Set of elements used to provide detailed information on the status reason. | StatusReasonInformation8 - Unknown 0..0 |
ChargesInformation | Provides information on the charges related to the processing of the rejection of the instruction. | |
AcceptanceDateTime | Point in time when the payment order from the initiating party meets the processing conditions of the account servicing agent. This means that the account servicing agent has received the payment order and has applied checks such as authorisation, availability of funds. | IsoISODateTime - Optional 0..1 |
AccountServicerReference | Unique reference, as assigned by the account servicing institution, to unambiguously identify the instruction. | IsoMax35Text - Optional 0..1 |
ClearingSystemReference | Unique reference, as assigned by a clearing system, to unambiguously identify the instruction. | IsoMax35Text - Optional 0..1 |
InstructingAgent | Agent that instructs the next party in the chain to carry out the (set of) instruction(s). | |
InstructedAgent | Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s). | |
OriginalTransactionReference | Set of key elements used to identify the original transaction that is being referred to. | OriginalTransactionReference13 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the FIToFIPaymentStatusReportV03 implementation follows a specific implementaiton pattern. First of all, FIToFIPaymentStatusReportV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FIToFIPaymentStatusReportV03Document implements IOuterDocument. Because FIToFIPaymentStatusReportV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FIToFIPaymentStatusReportV03.
classDiagram class IOuterRecord FIToFIPaymentStatusReportV03 --|> IOuterRecord : Implements FIToFIPaymentStatusReportV03Document --|> IOuterDocument~FIToFIPaymentStatusReportV03~ : Implements class IOuterDocument~FIToFIPaymentStatusReportV03~ { FIToFIPaymentStatusReportV03 Message }
Document wrapper for serialization
The only real purpose FIToFIPaymentStatusReportV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pacs.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 FIToFIPaymentStatusReportV03.ToDocument() method. The returned FIToFIPaymentStatusReportV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram FIToFIPaymentStatusReportV03Document *-- FIToFIPaymentStatusReportV03 : 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:pacs.002.001.03">
<FIToFIPmtStsRpt>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<OrgnlGrpInfAndSts>
<!-- OriginalGroupInformationAndStatus inner content -->
</OrgnlGrpInfAndSts>
<TxInfAndSts>
<!-- TransactionInformationAndStatus inner content -->
</TxInfAndSts>
</FIToFIPmtStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_elwU0dEuEd-BzquC8wXy7w_-718126476"
nextVersions="_sI_agVkyEeGeoaLUQk__nA_1151411413"
previousVersion="_esBU4dEuEd-BzquC8wXy7w_-2138292511"
name="FIToFIPaymentStatusReportV03"
definition="Scope
The FinancialInstitutionToFinancialInstitutionPaymentStatusReport 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 FIToFIPaymentStatusReport message is exchanged between agents to provide status information about instructions previously sent. Its usage will always be governed by a bilateral agreement between the agents.
The FIToFIPaymentStatusReport message can be used to provide information about the status (e.g. rejection, acceptance) of a credit transfer instruction, a direct debit instruction, as well as other intra-agent instructions (for example FIToFIPaymentCancellationRequest).
The FIToFIPaymentStatusReport 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 FIToFIPaymentStatusReport message can be used in domestic and cross-border scenarios."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="FIToFIPmtStsRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_el6FwdEuEd-BzquC8wXy7w_-717206197"
name="GroupStatusAcceptedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to ACTC, ACCP, ACSP, ACSC or ACWC, then TransactionInformationAndStatus/TransactionStatus must be different from RJCT."
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="DifferentFromValue"><leftOperand>/TransactionInformationAndStatus[*]/TransactionStatus</leftOperand><rightOperand>Rejected</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>PartialGroupStatus1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/TransactionInformationAndStatus[*]/TransactionStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_el6FxNEuEd-BzquC8wXy7w_-717205949"
name="GroupStatusPendingRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to PDNG, then TransactionInformationAndStatus/TransactionStatus must be different from RJCT."
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="DifferentFromValue"><leftOperand>/TransactionInformationAndStatus[*]/TransactionStatus</leftOperand><rightOperand>Rejected</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>Pending</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/TransactionInformationAndStatus[*]/TransactionStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_el6Fx9EuEd-BzquC8wXy7w_-717205927"
name="GroupStatusRejectedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RJCT, then TransactionInformationAndStatus/TransactionStatus, if present, must be equal to RJCT."
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="NotWithInList"><leftOperand>/TransactionInformationAndStatus[*]/TransactionStatus</leftOperand><rightOperand>PartialGroupStatus2Code</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>Rejected</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/TransactionInformationAndStatus[*]/TransactionStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_el6FytEuEd-BzquC8wXy7w_-717205917"
name="GroupStatusReceivedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RCVD, then TransactionInformationAndStatus/TransactionStatus 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>/TransactionInformationAndStatus[*]/TransactionStatus</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="EqualToValue"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>Received</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/TransactionInformationAndStatus[1]</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<messageBuildingBlock
xmi:id="_elwU0tEuEd-BzquC8wXy7w_-717206472"
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="_P03FCtp-Ed-ak6NoX_4Aeg_130586071" />
<messageBuildingBlock
xmi:id="_elwU09EuEd-BzquC8wXy7w_-717206380"
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="_el6FwNEuEd-BzquC8wXy7w_-717206288"
name="TransactionInformationAndStatus"
definition="Information concerning the original transactions, to which the status report message refers."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="TxInfAndSts"
complexType="_P5oQSdp-Ed-ak6NoX_4Aeg_-269295301" />
<messageDefinitionIdentifier
businessArea="pacs"
messageFunctionality="002"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.