Iso20022

FIToFIPaymentStatusRequestV01

pacs.028.001.01

Scope The FinancialInstitutionToFinancialInstitutionPaymentStatusRequest message is sent by the debtor agent to the creditor agent, directly or through other agents and/or a payment clearing and settlement system. It is used to request a FIToFIPaymentStatusReport message containing information on the status of a previously sent instruction. Usage The FIToFIPaymentStatusRequest message is exchanged between agents to request status information about instructions previously sent. Its usage will always be governed by a bilateral agreement between the agents. The FIToFIPaymentStatusRequest message can be used to request 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 FIToFIPaymentStatusRequest 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 FIToFIPaymentStatusRequest 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
%% FIToFIPaymentStatusRequestV01 recursion level 0 with max 0
FIToFIPaymentStatusRequestV01 *-- "1..1" GroupHeader53 : GroupHeader
FIToFIPaymentStatusRequestV01 *-- "0..1" OriginalGroupInformation27 : OriginalGroupInformation
FIToFIPaymentStatusRequestV01 *-- "0..1" PaymentTransaction73 : TransactionInformation
FIToFIPaymentStatusRequestV01 *-- "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 request 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).

OriginalGroupInformation building block

Original group information concerning the group of transactions, to which the status request 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
%% OriginalGroupInformation27 recursion level 0 with max 1
class OriginalGroupInformation27{
    OriginalMessageIdentification IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
    OriginalNumberOfTransactions IsoMax15NumericText
    OriginalControlSum IsoDecimalNumber
}

OriginalGroupInformation27 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

TransactionInformation building block

Information concerning the original transaction, to which the status request 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
%% PaymentTransaction73 recursion level 0 with max 1
class PaymentTransaction73{
    StatusRequestIdentification IsoMax35Text
    OriginalInstructionIdentification IsoMax35Text
    OriginalEndToEndIdentification IsoMax35Text
    OriginalTransactionIdentification IsoMax35Text
    AcceptanceDateTime IsoISODateTime
    ClearingSystemReference IsoMax35Text
}
PaymentTransaction73 *-- "0..1" OriginalGroupInformation3 : OriginalGroupInformation
PaymentTransaction73 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
PaymentTransaction73 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
PaymentTransaction73 *-- "0..1" OriginalTransactionReference24 : OriginalTransactionReference
PaymentTransaction73 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalGroupInformation3 recursion level 1 with max 1
class OriginalGroupInformation3{
    OriginalMessageIdentification IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
}
%% 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
%% OriginalTransactionReference24 recursion level 1 with max 1
class OriginalTransactionReference24{
    InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount
    InterbankSettlementDate IsoISODate
    RequestedCollectionDate IsoISODate
    PaymentMethod PaymentMethod4Code
}
OriginalTransactionReference24 *-- "0..1" IAmountType4Choice : Amount
OriginalTransactionReference24 *-- "0..1" IDateAndDateTimeChoice : RequestedExecutionDate
OriginalTransactionReference24 *-- "0..1" PartyIdentification43 : CreditorSchemeIdentification
OriginalTransactionReference24 *-- "0..1" SettlementInstruction4 : SettlementInformation
OriginalTransactionReference24 *-- "0..1" PaymentTypeInformation25 : PaymentTypeInformation
OriginalTransactionReference24 *-- "0..1" MandateRelatedInformation11 : MandateRelatedInformation
OriginalTransactionReference24 *-- "0..1" RemittanceInformation11 : RemittanceInformation
OriginalTransactionReference24 *-- "0..1" PartyIdentification43 : UltimateDebtor
OriginalTransactionReference24 *-- "0..1" PartyIdentification43 : Debtor
OriginalTransactionReference24 *-- "0..1" CashAccount24 : DebtorAccount
OriginalTransactionReference24 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
OriginalTransactionReference24 *-- "0..1" CashAccount24 : DebtorAgentAccount
OriginalTransactionReference24 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
OriginalTransactionReference24 *-- "0..1" CashAccount24 : CreditorAgentAccount
OriginalTransactionReference24 *-- "0..1" PartyIdentification43 : Creditor
OriginalTransactionReference24 *-- "0..1" CashAccount24 : CreditorAccount
OriginalTransactionReference24 *-- "0..1" PartyIdentification43 : UltimateCreditor
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

PaymentTransaction73 members

Member name Description Data Type / Multiplicity
StatusRequestIdentification Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the status request. Usage: The instructing party is the party sending the request message and not the party that sent the original instruction that is being reported on. IsoMax35Text - Optional 0..1
OriginalGroupInformation Point to point reference, as assigned by the original instructing party, to unambiguously identify the original message. OriginalGroupInformation3 - Optional 0..1
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
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
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). BranchAndFinancialInstitutionIdentification5 - Optional 0..1
InstructedAgent Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s). BranchAndFinancialInstitutionIdentification5 - Optional 0..1
OriginalTransactionReference Key elements used to identify the original transaction that is being referred to. OriginalTransactionReference24 - Optional 0..1
SupplementaryData Additional information that cannot be captured in the structured elements and/or any other specific block. SupplementaryData1 - 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 FIToFIPaymentStatusRequestV01 implementation follows a specific implementaiton pattern. First of all, FIToFIPaymentStatusRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FIToFIPaymentStatusRequestV01Document implements IOuterDocument. Because FIToFIPaymentStatusRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FIToFIPaymentStatusRequestV01.

classDiagram
    class IOuterRecord
    FIToFIPaymentStatusRequestV01 --|> IOuterRecord : Implements
    FIToFIPaymentStatusRequestV01Document --|> IOuterDocument~FIToFIPaymentStatusRequestV01~ : Implements
    class IOuterDocument~FIToFIPaymentStatusRequestV01~ {
        FIToFIPaymentStatusRequestV01 Message
     }

Document wrapper for serialization

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

classDiagram
    FIToFIPaymentStatusRequestV01Document *-- FIToFIPaymentStatusRequestV01 : 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.028.001.01">
    <FIToFIPmtStsReq>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <OrgnlGrpInf>
            <!-- OriginalGroupInformation inner content -->
        </OrgnlGrpInf>
        <TxInf>
            <!-- TransactionInformation inner content -->
        </TxInf>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </FIToFIPmtStsReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_LoikwNsDEeWisvEo70YXSQ"
  nextVersions="_vYy3Ua9bEeel2vW9OMq7zA"
  name="FIToFIPaymentStatusRequestV01"
  definition="Scope&#xD;&#xA;The FinancialInstitutionToFinancialInstitutionPaymentStatusRequest message is sent by the debtor agent to the creditor agent, directly or through other agents and/or a payment clearing and settlement system. It is used to request a FIToFIPaymentStatusReport message containing information on the status of a previously sent instruction. &#xD;&#xA;Usage&#xD;&#xA;The FIToFIPaymentStatusRequest message is exchanged between agents to request status information about instructions previously sent. Its usage will always be governed by a bilateral agreement between the agents.&#xD;&#xA;The FIToFIPaymentStatusRequest message can be used to request 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).&#xD;&#xA;The FIToFIPaymentStatusRequest 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 FIToFIPaymentStatusRequest message can be used in domestic and cross-border scenarios.&#xD;&#xA;&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="FIToFIPmtStsReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_Mv2E0HNCEeaPjshkblZBVw"
    nextVersions="_vYy3U69bEeel2vW9OMq7zA"
    name="OriginalGroupInformationAbsenceRule"
    definition="If OriginalGroupInformation is absent, then &#xD;&#xA;TransactionInformation[*]/OriginalGroupInformation must be present."
    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;Presence&quot;&gt;&lt;leftOperand&gt;/TransactionInformation[*]/OriginalGroupInformation&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformation[*]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_JzGisHNJEeaPjshkblZBVw"
    nextVersions="_vYy3Va9bEeel2vW9OMq7zA"
    name="OriginalGroupInformationMultiplePresenceRule"
    definition="If OriginalGroupInformation is present and multiple times (Occurrence &gt; 1), then TransactionInformation[*]/OriginalGroupInformation must be present."
    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;Presence&quot;&gt;&lt;leftOperand&gt;/TransactionInformation[*]/OriginalGroupInformation&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;/OriginalGroupInformation[2]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_K-szIXNJEeaPjshkblZBVw"
    nextVersions="_vYy3V69bEeel2vW9OMq7zA"
    name="OriginalGroupInformationSinglePresenceRule"
    definition="If OriginalGroupInformationAndStatus is present and only once, then TransactionInformationAndStatus[*]/OriginalGroupInformation must be absent."
    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;Absence&quot;&gt;&lt;leftOperand&gt;/TransactionInformation[*]/OriginalGroupInformation&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;/OriginalGroupInformation[1]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformation[2]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_L_ycsXNJEeaPjshkblZBVw"
    nextVersions="_vYy3Wa9bEeel2vW9OMq7zA"
    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="_2NBB4NsDEeWisvEo70YXSQ"
    nextVersions="_vYy3W69bEeel2vW9OMq7zA"
    name="GroupHeader"
    definition="Set of characteristics shared by all individual transactions included in the status request message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_s7WrkFkyEeGeoaLUQk__nA_-536954472" />
  <messageBuildingBlock
    xmi:id="_EhgbMNsEEeWisvEo70YXSQ"
    nextVersions="_vYy3Xa9bEeel2vW9OMq7zA"
    name="OriginalGroupInformation"
    definition="Original group information concerning the group of transactions, to which the status request message refers to."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="OrgnlGrpInf"
    complexType="_6x8aIRdSEea6o_d8S96x5g" />
  <messageBuildingBlock
    xmi:id="_sHUHEG6ZEeaUkthD_kt0tA"
    nextVersions="_vYy3X69bEeel2vW9OMq7zA"
    name="TransactionInformation"
    definition="Information concerning the original transaction, to which the status request message refers."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="TxInf"
    complexType="_pdGP0Vf0Eeazw8HXZ3V4kw" />
  <messageBuildingBlock
    xmi:id="_6WwwgXNIEeaPjshkblZBVw"
    nextVersions="_vYy3Ya9bEeel2vW9OMq7zA"
    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="028"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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