FIToFICustomerDirectDebitV01

pacs.003.001.01

Scope The FinancialInstitutionToFinancialInstitutionCustomerDirectDebit message is sent by the creditor agent to the debtor agent, directly or through other agents and/or a payment clearing and settlement system. It is used to collect funds from a debtor account for a creditor. Usage The FItoFICustomerDirectDebit message can contain one or more customer direct debit instructions. The FIToFICustomerDirectDebit message does not allow for grouping: the PaymentInformation block must be present once per occurrence of a DirectDebitTransactionInformation block. The FItoFICustomerDirectDebit message may or may not contain mandate related information, i.e. extracts from a mandate, such as the MandateIdentification or DateOfSignature. The FIToFICustomerDirectDebit message must not be considered as a mandate. The FItoFICustomerDirectDebit 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
%% FIToFICustomerDirectDebitV01 recursion level 0 with max 0
FIToFICustomerDirectDebitV01 *-- "1..1" GroupHeader3 : GroupHeader
FIToFICustomerDirectDebitV01 *-- "1..1" DirectDebitTransactionInformation2 : DirectDebitTransactionInformation
  

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 message. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% GroupHeader3 recursion level 0 with max 1
class GroupHeader3{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    Authorisation IsoMax128Text
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    TotalInterbankSettlementAmount IsoCurrencyAndAmount
    InterbankSettlementDate IsoISODate
}
GroupHeader3 *-- "1..1" SettlementInformation2 : SettlementInformation
GroupHeader3 *-- "0..1" PaymentTypeInformation4 : PaymentTypeInformation
GroupHeader3 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingAgent
GroupHeader3 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructedAgent
%% SettlementInformation2 recursion level 1 with max 1
class SettlementInformation2{
    SettlementMethod SettlementMethod2Code
}
SettlementInformation2 *-- "0..1" CashAccount7 : SettlementAccount
SettlementInformation2 *-- "0..1" IClearingSystemIdentification1Choice : ClearingSystem
%% PaymentTypeInformation4 recursion level 1 with max 1
class PaymentTypeInformation4{
    InstructionPriority Priority2Code
    ClearingChannel ClearingChannel2Code
    SequenceType SequenceType1Code
    CategoryPurpose PaymentCategoryPurpose1Code
}
PaymentTypeInformation4 *-- "0..1" IServiceLevel3Choice : ServiceLevel
PaymentTypeInformation4 *-- "0..1" ILocalInstrument1Choice : LocalInstrument
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
  

GroupHeader3 members

DirectDebitTransactionInformation building block

Set of elements providing information specific to the individual direct debit(s). Set of characteristics that apply to the the direct debit transaction(s). For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DirectDebitTransactionInformation2 recursion level 0 with max 1
class DirectDebitTransactionInformation2{
    InterbankSettlementAmount IsoCurrencyAndAmount
    InterbankSettlementDate IsoISODate
    InstructedAmount IsoCurrencyAndAmount
    ExchangeRate IsoBaseOneRate
    ChargeBearer ChargeBearerType1Code
    RequestedCollectionDate IsoISODate
}
DirectDebitTransactionInformation2 *-- "1..1" PaymentIdentification2 : PaymentIdentification
DirectDebitTransactionInformation2 *-- "0..1" PaymentTypeInformation4 : PaymentTypeInformation
DirectDebitTransactionInformation2 *-- "0..0" ChargesInformation1 : ChargesInformation
DirectDebitTransactionInformation2 *-- "0..1" DirectDebitTransaction1 : DirectDebitTransaction
DirectDebitTransactionInformation2 *-- "1..1" PartyIdentification8 : Creditor
DirectDebitTransactionInformation2 *-- "0..1" CashAccount7 : CreditorAccount
DirectDebitTransactionInformation2 *-- "1..1" BranchAndFinancialInstitutionIdentification3 : CreditorAgent
DirectDebitTransactionInformation2 *-- "0..1" CashAccount7 : CreditorAgentAccount
DirectDebitTransactionInformation2 *-- "0..1" PartyIdentification8 : UltimateCreditor
DirectDebitTransactionInformation2 *-- "0..1" PartyIdentification8 : InitiatingParty
DirectDebitTransactionInformation2 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructingAgent
DirectDebitTransactionInformation2 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : InstructedAgent
DirectDebitTransactionInformation2 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : IntermediaryAgent1
DirectDebitTransactionInformation2 *-- "0..1" CashAccount7 : IntermediaryAgent1Account
DirectDebitTransactionInformation2 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : IntermediaryAgent2
DirectDebitTransactionInformation2 *-- "0..1" CashAccount7 : IntermediaryAgent2Account
DirectDebitTransactionInformation2 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : IntermediaryAgent3
DirectDebitTransactionInformation2 *-- "0..1" CashAccount7 : IntermediaryAgent3Account
DirectDebitTransactionInformation2 *-- "1..1" PartyIdentification8 : Debtor
DirectDebitTransactionInformation2 *-- "1..1" CashAccount7 : DebtorAccount
DirectDebitTransactionInformation2 *-- "1..1" BranchAndFinancialInstitutionIdentification3 : DebtorAgent
DirectDebitTransactionInformation2 *-- "0..1" CashAccount7 : DebtorAgentAccount
DirectDebitTransactionInformation2 *-- "0..1" PartyIdentification8 : UltimateDebtor
DirectDebitTransactionInformation2 *-- "0..1" IPurpose1Choice : Purpose
DirectDebitTransactionInformation2 *-- "0..10" RegulatoryReporting2 : RegulatoryReporting
DirectDebitTransactionInformation2 *-- "0..10" RemittanceLocation1 : RelatedRemittanceInformation
DirectDebitTransactionInformation2 *-- "0..1" RemittanceInformation1 : RemittanceInformation
%% PaymentIdentification2 recursion level 1 with max 1
class PaymentIdentification2{
    InstructionIdentification IsoMax35Text
    EndToEndIdentification IsoMax35Text
    TransactionIdentification IsoMax35Text
}
%% PaymentTypeInformation4 recursion level 1 with max 1
class PaymentTypeInformation4{
    InstructionPriority Priority2Code
    ClearingChannel ClearingChannel2Code
    SequenceType SequenceType1Code
    CategoryPurpose PaymentCategoryPurpose1Code
}
PaymentTypeInformation4 *-- "0..1" IServiceLevel3Choice : ServiceLevel
PaymentTypeInformation4 *-- "0..1" ILocalInstrument1Choice : LocalInstrument
%% ChargesInformation1 recursion level 1 with max 1
class ChargesInformation1{
    ChargesAmount IsoCurrencyAndAmount
}
ChargesInformation1 *-- "1..1" BranchAndFinancialInstitutionIdentification3 : ChargesParty
%% DirectDebitTransaction1 recursion level 1 with max 1
class DirectDebitTransaction1{
    PreNotificationIdentification IsoMax35Text
    PreNotificationDate IsoISODate
}
DirectDebitTransaction1 *-- "0..1" MandateRelatedInformation1 : MandateRelatedInformation
DirectDebitTransaction1 *-- "0..1" PartyIdentification8 : CreditorSchemeIdentification
%% PartyIdentification8 recursion level 1 with max 1
class PartyIdentification8{
    Name IsoMax70Text
    CountryOfResidence CountryCode
}
PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress
PartyIdentification8 *-- "0..1" IParty2Choice : Identification
%% CashAccount7 recursion level 1 with max 1
class CashAccount7{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount7 *-- "0..1" CashAccountType2 : Type
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% CashAccount7 recursion level 1 with max 1
class CashAccount7{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount7 *-- "0..1" CashAccountType2 : Type
%% PartyIdentification8 recursion level 1 with max 1
class PartyIdentification8{
    Name IsoMax70Text
    CountryOfResidence CountryCode
}
PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress
PartyIdentification8 *-- "0..1" IParty2Choice : Identification
%% PartyIdentification8 recursion level 1 with max 1
class PartyIdentification8{
    Name IsoMax70Text
    CountryOfResidence CountryCode
}
PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress
PartyIdentification8 *-- "0..1" IParty2Choice : Identification
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% CashAccount7 recursion level 1 with max 1
class CashAccount7{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount7 *-- "0..1" CashAccountType2 : Type
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% CashAccount7 recursion level 1 with max 1
class CashAccount7{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount7 *-- "0..1" CashAccountType2 : Type
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% CashAccount7 recursion level 1 with max 1
class CashAccount7{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount7 *-- "0..1" CashAccountType2 : Type
%% PartyIdentification8 recursion level 1 with max 1
class PartyIdentification8{
    Name IsoMax70Text
    CountryOfResidence CountryCode
}
PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress
PartyIdentification8 *-- "0..1" IParty2Choice : Identification
%% CashAccount7 recursion level 1 with max 1
class CashAccount7{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount7 *-- "0..1" CashAccountType2 : Type
%% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
%% CashAccount7 recursion level 1 with max 1
class CashAccount7{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount7 *-- "0..1" CashAccountType2 : Type
%% PartyIdentification8 recursion level 1 with max 1
class PartyIdentification8{
    Name IsoMax70Text
    CountryOfResidence CountryCode
}
PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress
PartyIdentification8 *-- "0..1" IParty2Choice : Identification
%% IPurpose1Choice recursion level 1 with max 1
%% RegulatoryReporting2 recursion level 1 with max 1
class RegulatoryReporting2{
    DebitCreditReportingIndicator RegulatoryReportingType1Code
}
RegulatoryReporting2 *-- "0..1" RegulatoryAuthority : Authority
RegulatoryReporting2 *-- "0..1" StructuredRegulatoryReporting2 : RegulatoryDetails
%% RemittanceLocation1 recursion level 1 with max 1
class RemittanceLocation1{
    RemittanceIdentification IsoMax35Text
    RemittanceLocationMethod RemittanceLocationMethod1Code
    RemittanceLocationElectronicAddress IsoMax256Text
}
RemittanceLocation1 *-- "0..1" NameAndAddress3 : RemittanceLocationPostalAddress
%% RemittanceInformation1 recursion level 1 with max 1
class RemittanceInformation1{
    Unstructured IsoMax140Text
}
RemittanceInformation1 *-- "0..0" StructuredRemittanceInformation6 : Structured
  

DirectDebitTransactionInformation2 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the FIToFICustomerDirectDebitV01 implementation follows a specific implementaiton pattern. First of all, FIToFICustomerDirectDebitV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FIToFICustomerDirectDebitV01Document implements IOuterDocument. Because FIToFICustomerDirectDebitV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FIToFICustomerDirectDebitV01.

classDiagram
    class IOuterRecord
    FIToFICustomerDirectDebitV01 --|> IOuterRecord : Implements
    FIToFICustomerDirectDebitV01Document --|> IOuterDocument~FIToFICustomerDirectDebitV01~ : Implements
    class IOuterDocument~FIToFICustomerDirectDebitV01~ {
        FIToFICustomerDirectDebitV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    FIToFICustomerDirectDebitV01Document *-- FIToFICustomerDirectDebitV01 : 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.003.001.01">
    <pacs.003.001.01>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <DrctDbtTxInf>
            <!-- DirectDebitTransactionInformation inner content -->
        </DrctDbtTxInf>
    </pacs.003.001.01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ejE0QdEuEd-BzquC8wXy7w_677726026"
  nextVersions="_ejXvKNEuEd-BzquC8wXy7w_-725407286"
  name="FIToFICustomerDirectDebitV01"
  definition="Scope&#xD;&#xA;The FinancialInstitutionToFinancialInstitutionCustomerDirectDebit message is sent by the creditor agent to the debtor agent, directly or through other agents and/or a payment clearing and settlement system.&#xD;&#xA;It is used to collect funds from a debtor account for a creditor.&#xD;&#xA;Usage&#xD;&#xA;The FItoFICustomerDirectDebit message can contain one or more customer direct debit instructions.&#xD;&#xA;The FIToFICustomerDirectDebit message does not allow for grouping: the PaymentInformation block must be present once per occurrence of a DirectDebitTransactionInformation block.&#xD;&#xA;The FItoFICustomerDirectDebit message may or may not contain mandate related information, i.e. extracts from a mandate, such as the MandateIdentification or DateOfSignature. The FIToFICustomerDirectDebit message must not be considered as a mandate.&#xD;&#xA;The FItoFICustomerDirectDebit message can be used in domestic and cross-border scenarios.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="pacs.003.001.01"
  xmlTag="pacs.003.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_ejOlMtEuEd-BzquC8wXy7w_-892171760"
    name="InstructedAgentRule"
    definition="If GroupHeader/InstructedAgent is present, then DirectDebitTransactionInformation/InstructedAgent is not allowed."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_ejOlNdEuEd-BzquC8wXy7w_-892171483"
    name="InstructingAgentRule"
    definition="If GroupHeader/InstructingAgent is present, then DirectDebitTransactionInformation/InstructingAgent is not allowed.&#xA;&#xA;."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_ejOlONEuEd-BzquC8wXy7w_1327974563"
    name="TotalInterbankSettlementAmount1Rule"
    definition="If GroupHeader/TotalInterbankSettlementAmount is present, then all occurrences of DirectDebitTransactionInformation/InterbankSettlementAmount must have the same currency as the currency of GroupHeader/TotalInterbankSettlementAmount."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_ejOlO9EuEd-BzquC8wXy7w_1813744241"
    name="TotalInterbankSettlementAmount2Rule"
    definition="If GroupHeader/TotalInterbankSettlementAmount is present, then it must be equal to the sum of all occurrences of DirectDebitTransactionInformation/InterbankSettlementAmount."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_ejOlPtEuEd-BzquC8wXy7w_2143442585"
    name="InterbankSettlementDateRule"
    definition="If GroupHeader/InterbankSettlementDate is present, then DirectDebitTransactionInformation/InterbankSettlementDate is not allowed. &#xA;If GroupHeader/InterbankSettlementDate is not present, then DirectDebitTransactionInformation/InterbankSettlementDate must be present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_ejOlQdEuEd-BzquC8wXy7w_1042542385"
    name="PaymentTypeInformationRule"
    definition="If GroupHeader/PaymentTypeInformation is present, then DirectDebitTransactionInformation/PaymentTypeInformation is not allowed. &#xA;."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_ejOlMNEuEd-BzquC8wXy7w_-469555249"
    name="GroupHeader"
    definition="Set of characteristics shared by all individual transactions included in the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_Puv189p-Ed-ak6NoX_4Aeg_1445763661" />
  <messageBuildingBlock
    xmi:id="_ejOlMdEuEd-BzquC8wXy7w_-847540007"
    name="DirectDebitTransactionInformation"
    definition="Set of elements providing information specific to the individual direct debit(s)."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="DrctDbtTxInf"
    complexType="_PvWS4dp-Ed-ak6NoX_4Aeg_-1849559594" />
  <messageDefinitionIdentifier
    businessArea="pacs"
    messageFunctionality="003"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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