pacs.002.001.04
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
%% FIToFIPaymentStatusReportV04 recursion level 0 with max 0
FIToFIPaymentStatusReportV04 *-- "1..1" GroupHeader53 : GroupHeader
FIToFIPaymentStatusReportV04 *-- "1..1" OriginalGroupHeader1 : OriginalGroupInformationAndStatus
FIToFIPaymentStatusReportV04 *-- "0..1" PaymentTransaction33 : TransactionInformationAndStatus
FIToFIPaymentStatusReportV04 *-- "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
%% GroupHeader53 recursion level 0 with max 1
class GroupHeader53{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
GroupHeader53 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
GroupHeader53 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
%% 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
GroupHeader53 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. Provides details on the original group, to which the message refers. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% OriginalGroupHeader1 recursion level 0 with max 1
class OriginalGroupHeader1{
OriginalMessageIdentification IsoMax35Text
OriginalMessageNameIdentification IsoMax35Text
OriginalCreationDateTime IsoISODateTime
OriginalNumberOfTransactions IsoMax15NumericText
OriginalControlSum IsoDecimalNumber
GroupStatus TransactionGroupStatus3Code
}
OriginalGroupHeader1 *-- "0..0" StatusReasonInformation9 : StatusReasonInformation
OriginalGroupHeader1 *-- "0..0" NumberOfTransactionsPerStatus3 : NumberOfTransactionsPerStatus
%% StatusReasonInformation9 recursion level 1 with max 1
class StatusReasonInformation9{
AdditionalInformation IsoMax105Text
}
StatusReasonInformation9 *-- "0..1" PartyIdentification43 : Originator
StatusReasonInformation9 *-- "0..1" IStatusReason6Choice : Reason
%% NumberOfTransactionsPerStatus3 recursion level 1 with max 1
class NumberOfTransactionsPerStatus3{
DetailedNumberOfTransactions IsoMax15NumericText
DetailedStatus TransactionIndividualStatus3Code
DetailedControlSum IsoDecimalNumber
}
OriginalGroupHeader1 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 | Provides detailed information on the status reason. | StatusReasonInformation9 - 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. Provides further details on the original transactions, to which the status report message refers. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% PaymentTransaction33 recursion level 0 with max 1
class PaymentTransaction33{
StatusIdentification IsoMax35Text
OriginalInstructionIdentification IsoMax35Text
OriginalEndToEndIdentification IsoMax35Text
OriginalTransactionIdentification IsoMax35Text
TransactionStatus TransactionIndividualStatus3Code
AcceptanceDateTime IsoISODateTime
AccountServicerReference IsoMax35Text
ClearingSystemReference IsoMax35Text
}
PaymentTransaction33 *-- "0..0" StatusReasonInformation9 : StatusReasonInformation
PaymentTransaction33 *-- "0..0" Charges2 : ChargesInformation
PaymentTransaction33 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
PaymentTransaction33 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
PaymentTransaction33 *-- "0..1" OriginalTransactionReference16 : OriginalTransactionReference
%% StatusReasonInformation9 recursion level 1 with max 1
class StatusReasonInformation9{
AdditionalInformation IsoMax105Text
}
StatusReasonInformation9 *-- "0..1" PartyIdentification43 : Originator
StatusReasonInformation9 *-- "0..1" IStatusReason6Choice : Reason
%% Charges2 recursion level 1 with max 1
class Charges2{
Amount IsoActiveOrHistoricCurrencyAndAmount
}
Charges2 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : Agent
%% 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
%% OriginalTransactionReference16 recursion level 1 with max 1
class OriginalTransactionReference16{
InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount
InterbankSettlementDate IsoISODate
RequestedCollectionDate IsoISODate
RequestedExecutionDate IsoISODate
PaymentMethod PaymentMethod4Code
}
OriginalTransactionReference16 *-- "0..1" IAmountType3Choice : Amount
OriginalTransactionReference16 *-- "0..1" PartyIdentification43 : CreditorSchemeIdentification
OriginalTransactionReference16 *-- "0..1" SettlementInstruction4 : SettlementInformation
OriginalTransactionReference16 *-- "0..1" PaymentTypeInformation25 : PaymentTypeInformation
OriginalTransactionReference16 *-- "0..1" MandateRelatedInformation8 : MandateRelatedInformation
OriginalTransactionReference16 *-- "0..1" RemittanceInformation7 : RemittanceInformation
OriginalTransactionReference16 *-- "0..1" PartyIdentification43 : UltimateDebtor
OriginalTransactionReference16 *-- "0..1" PartyIdentification43 : Debtor
OriginalTransactionReference16 *-- "0..1" CashAccount24 : DebtorAccount
OriginalTransactionReference16 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
OriginalTransactionReference16 *-- "0..1" CashAccount24 : DebtorAgentAccount
OriginalTransactionReference16 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
OriginalTransactionReference16 *-- "0..1" CashAccount24 : CreditorAgentAccount
OriginalTransactionReference16 *-- "0..1" PartyIdentification43 : Creditor
OriginalTransactionReference16 *-- "0..1" CashAccount24 : CreditorAccount
OriginalTransactionReference16 *-- "0..1" PartyIdentification43 : UltimateCreditor
PaymentTransaction33 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 | Provides detailed information on the status reason. | StatusReasonInformation9 - 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 | Key elements used to identify the original transaction that is being referred to. | OriginalTransactionReference16 - Optional 0..1 |
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 FIToFIPaymentStatusReportV04 implementation follows a specific implementaiton pattern. First of all, FIToFIPaymentStatusReportV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FIToFIPaymentStatusReportV04Document implements IOuterDocument. Because FIToFIPaymentStatusReportV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FIToFIPaymentStatusReportV04.
classDiagram
class IOuterRecord
FIToFIPaymentStatusReportV04 --|> IOuterRecord : Implements
FIToFIPaymentStatusReportV04Document --|> IOuterDocument~FIToFIPaymentStatusReportV04~ : Implements
class IOuterDocument~FIToFIPaymentStatusReportV04~ {
FIToFIPaymentStatusReportV04 Message
}
Document wrapper for serialization
The only real purpose FIToFIPaymentStatusReportV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pacs.002.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FIToFIPaymentStatusReportV04.ToDocument() method. The returned FIToFIPaymentStatusReportV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
FIToFIPaymentStatusReportV04Document *-- FIToFIPaymentStatusReportV04 : 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.04">
<FIToFIPmtStsRpt>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<OrgnlGrpInfAndSts>
<!-- OriginalGroupInformationAndStatus inner content -->
</OrgnlGrpInfAndSts>
<TxInfAndSts>
<!-- TransactionInformationAndStatus inner content -->
</TxInfAndSts>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</FIToFIPmtStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_sI_agVkyEeGeoaLUQk__nA_1151411413"
nextVersions="_FXEtkSGnEeKjd4jizyIDGA"
previousVersion="_elwU0dEuEd-BzquC8wXy7w_-718126476"
name="FIToFIPaymentStatusReportV04"
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="_sJSVcVkyEeGeoaLUQk__nA_702100841"
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="_sJbfYFkyEeGeoaLUQk__nA_-294971512"
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="_sJbfYlkyEeGeoaLUQk__nA_-1292043865"
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="_sJlQYFkyEeGeoaLUQk__nA_2005851078"
name="GroupStatusReceivedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RCVD, then TransactionInformationAndStatus/TransactionStatus 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>/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="_sI_aglkyEeGeoaLUQk__nA_-1598721749"
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="_s7WrkFkyEeGeoaLUQk__nA_-536954472" />
<messageBuildingBlock
xmi:id="_sJIkcFkyEeGeoaLUQk__nA_1813012260"
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="_sniXsFkyEeGeoaLUQk__nA_1278270511" />
<messageBuildingBlock
xmi:id="_sJIkcVkyEeGeoaLUQk__nA_1699173194"
name="TransactionInformationAndStatus"
definition="Information concerning the original transactions, to which the status report message refers."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="TxInfAndSts"
complexType="_tNiAs1kyEeGeoaLUQk__nA_-342615206" />
<messageBuildingBlock
xmi:id="_sJSVcFkyEeGeoaLUQk__nA_1609143706"
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="pacs"
messageFunctionality="002"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.