Iso20022

FinancialInstitutionDirectDebitV02

pacs.010.001.02

Scope: The FinancialInstitutionDirectDebit message is sent by an exchange or clearing house, or a financial institution, directly or through another agent, to the DebtorAgent. It is used to instruct the DebtorAgent to move funds from one or more debtor(s) account(s) to one or more creditor(s), where both debtor and creditor are financial institutions.

Usage: The FinancialInstitutionDirectDebit message is exchanged between agents and can contain one or more financial institution direct debit instruction(s) for one or more creditor(s). The FinancialInstitutionDirectDebit 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
%% FinancialInstitutionDirectDebitV02 recursion level 0 with max 0
FinancialInstitutionDirectDebitV02 *-- "1..1" GroupHeader63 : GroupHeader
FinancialInstitutionDirectDebitV02 *-- "1..1" CreditTransferTransaction9 : CreditInstruction
FinancialInstitutionDirectDebitV02 *-- "0..1" SupplementaryData1 : SupplementaryData

Now, we will zero-in one-by-one on each of these building blocks.

GroupHeader building block

Common characteristics for all individual transactions included in the message. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% GroupHeader63 recursion level 0 with max 1
class GroupHeader63{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
}
GroupHeader63 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
GroupHeader63 *-- "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

GroupHeader63 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
NumberOfTransactions Number of individual transactions contained in the message. IsoMax15NumericText - Required 1..1
ControlSum Total of all individual amounts included in the message, irrespective of currencies. IsoDecimalNumber - 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

CreditInstruction building block

Characteristics that apply to the credit side of the payment transaction(s) included in the message. Provides further details specific to the individual transaction(s) included in the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CreditTransferTransaction9 recursion level 0 with max 1
class CreditTransferTransaction9{
    CreditIdentification IsoMax35Text
    BatchBooking IsoBatchBookingIndicator
    TotalInterbankSettlementAmount IsoActiveCurrencyAndAmount
    InterbankSettlementDate IsoISODate
}
CreditTransferTransaction9 *-- "0..1" PaymentTypeInformation21 : PaymentTypeInformation
CreditTransferTransaction9 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
CreditTransferTransaction9 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
CreditTransferTransaction9 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent1
CreditTransferTransaction9 *-- "0..1" CashAccount24 : IntermediaryAgent1Account
CreditTransferTransaction9 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent2
CreditTransferTransaction9 *-- "0..1" CashAccount24 : IntermediaryAgent2Account
CreditTransferTransaction9 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent3
CreditTransferTransaction9 *-- "0..1" CashAccount24 : IntermediaryAgent3Account
CreditTransferTransaction9 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
CreditTransferTransaction9 *-- "0..1" CashAccount24 : CreditorAgentAccount
CreditTransferTransaction9 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : Creditor
CreditTransferTransaction9 *-- "0..1" CashAccount24 : CreditorAccount
CreditTransferTransaction9 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : UltimateCreditor
CreditTransferTransaction9 *-- "0..0" InstructionForCreditorAgent2 : InstructionForCreditorAgent
CreditTransferTransaction9 *-- "1..0" DirectDebitTransactionInformation15 : DirectDebitTransactionInformation
CreditTransferTransaction9 *-- "0..0" SupplementaryData1 : SupplementaryData
%% PaymentTypeInformation21 recursion level 1 with max 1
class PaymentTypeInformation21{
    InstructionPriority Priority2Code
    ClearingChannel ClearingChannel2Code
}
PaymentTypeInformation21 *-- "0..1" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation21 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation21 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% 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
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% InstructionForCreditorAgent2 recursion level 1 with max 1
class InstructionForCreditorAgent2{
    Code Instruction5Code
    InstructionInformation IsoMax140Text
}
%% DirectDebitTransactionInformation15 recursion level 1 with max 1
class DirectDebitTransactionInformation15{
    InterbankSettlementAmount IsoActiveCurrencyAndAmount
    InterbankSettlementDate IsoISODate
    SettlementPriority Priority3Code
    InstructionForDebtorAgent IsoMax210Text
}
DirectDebitTransactionInformation15 *-- "1..1" PaymentIdentification3 : PaymentIdentification
DirectDebitTransactionInformation15 *-- "0..1" PaymentTypeInformation21 : PaymentTypeInformation
DirectDebitTransactionInformation15 *-- "0..1" SettlementTimeRequest2 : SettlementTimeRequest
DirectDebitTransactionInformation15 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : UltimateDebtor
DirectDebitTransactionInformation15 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : Debtor
DirectDebitTransactionInformation15 *-- "0..1" CashAccount24 : DebtorAccount
DirectDebitTransactionInformation15 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
DirectDebitTransactionInformation15 *-- "0..1" CashAccount24 : DebtorAgentAccount
DirectDebitTransactionInformation15 *-- "0..1" RemittanceInformation2 : RemittanceInformation
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

CreditTransferTransaction9 members

Member name Description Data Type / Multiplicity
CreditIdentification Unique identification, as assigned by a sending party, to unambiguously identify the credit instruction within the message. IsoMax35Text - Required 1..1
BatchBooking Identifies whether a single entry per individual direct debit transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested. Usage: Batch booking is used to request and not order a possible batch booking. IsoBatchBookingIndicator - Optional 0..1
PaymentTypeInformation Further specifies the type of transaction. PaymentTypeInformation21 - Optional 0..1
TotalInterbankSettlementAmount Amount of money moved between the instructing agent and the instructed agent. IsoActiveCurrencyAndAmount - Optional 0..1
InterbankSettlementDate Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. IsoISODate - 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
IntermediaryAgent1 Agent between the debtor’s agent and the creditor’s agent.
IntermediaryAgent1Account Unambiguous identification of the account of the intermediary agent 1 at its servicing agent in the payment chain. CashAccount24 - Optional 0..1
IntermediaryAgent2 Agent between the debtor’s agent and the creditor’s agent.
IntermediaryAgent2Account Unambiguous identification of the account of the intermediary agent 2 at its servicing agent in the payment chain. CashAccount24 - Optional 0..1
IntermediaryAgent3 Agent between the debtor’s agent and the creditor’s agent.
IntermediaryAgent3Account Unambiguous identification of the account of the intermediary agent 3 at its servicing agent in the payment chain. CashAccount24 - Optional 0..1
CreditorAgent Financial institution servicing an account for the creditor. BranchAndFinancialInstitutionIdentification5 - Optional 0..1
CreditorAgentAccount Unambiguous identification of the account of the creditor agent at its servicing agent to which a credit entry will be made as a result of the payment transaction. CashAccount24 - Optional 0..1
Creditor Financial institution that receives an amount of money from the financial institutional debtor. BranchAndFinancialInstitutionIdentification5 - Required 1..1
CreditorAccount Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. CashAccount24 - Optional 0..1
UltimateCreditor Ultimate financial institution to which an amount of money is due. BranchAndFinancialInstitutionIdentification5 - Optional 0..1
InstructionForCreditorAgent Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. InstructionForCreditorAgent2 - Unknown 0..0
DirectDebitTransactionInformation Provides information on the individual debit transaction(s) included in the message. DirectDebitTransactionInformation15 - Unknown 1..0
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 FinancialInstitutionDirectDebitV02 implementation follows a specific implementaiton pattern. First of all, FinancialInstitutionDirectDebitV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FinancialInstitutionDirectDebitV02Document implements IOuterDocument. Because FinancialInstitutionDirectDebitV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FinancialInstitutionDirectDebitV02.

classDiagram
    class IOuterRecord
    FinancialInstitutionDirectDebitV02 --|> IOuterRecord : Implements
    FinancialInstitutionDirectDebitV02Document --|> IOuterDocument~FinancialInstitutionDirectDebitV02~ : Implements
    class IOuterDocument~FinancialInstitutionDirectDebitV02~ {
        FinancialInstitutionDirectDebitV02 Message
     }

Document wrapper for serialization

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

classDiagram
    FinancialInstitutionDirectDebitV02Document *-- FinancialInstitutionDirectDebitV02 : 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.010.001.02">
    <FIDrctDbt>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <CdtInstr>
            <!-- CreditInstruction inner content -->
        </CdtInstr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </FIDrctDbt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_CWdYcTttEeWiAsQFICzmOw"
  nextVersions="_x0JZC3L4EeidQ_AAdEzxQA"
  name="FinancialInstitutionDirectDebitV02"
  definition="Scope:&#xD;&#xA;The FinancialInstitutionDirectDebit message is sent by an exchange or clearing house, or a financial institution, directly or through another agent, to the DebtorAgent. It is used to instruct the DebtorAgent to move funds from one or more debtor(s) account(s) to one or more creditor(s), where both debtor and creditor are financial institutions.&#xD;&#xA;&#xD;&#xA;Usage:&#xD;&#xA;The FinancialInstitutionDirectDebit message is exchanged between agents and can contain one or more financial institution direct debit instruction(s) for one or more creditor(s). The FinancialInstitutionDirectDebit message can be used in domestic and cross-border scenarios.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="FIDrctDbt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_CWdYczttEeWiAsQFICzmOw"
    nextVersions="_x0JZDXL4EeidQ_AAdEzxQA"
    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="_CWdYdTttEeWiAsQFICzmOw"
    nextVersions="_x0JZD3L4EeidQ_AAdEzxQA"
    name="GroupHeader"
    definition="Common characteristics for all individual transactions included in the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_4jH0gWkkEeKAGeP1fbluEg" />
  <messageBuildingBlock
    xmi:id="_CWdYdzttEeWiAsQFICzmOw"
    nextVersions="_x0JZEXL4EeidQ_AAdEzxQA"
    name="CreditInstruction"
    definition="Characteristics that apply to the credit side of the payment transaction(s) included in the message."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="CdtInstr"
    complexType="_7h-8oGcJEeKAGeP1fbluEg" />
  <messageBuildingBlock
    xmi:id="_CWdYeTttEeWiAsQFICzmOw"
    nextVersions="_x0JZE3L4EeidQ_AAdEzxQA"
    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="010"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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