Iso20022

FIToFICustomerDirectDebitV04

pacs.003.001.04

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
%% FIToFICustomerDirectDebitV04 recursion level 0 with max 0
FIToFICustomerDirectDebitV04 *-- "1..1" GroupHeader50 : GroupHeader
FIToFICustomerDirectDebitV04 *-- "1..1" DirectDebitTransactionInformation14 : DirectDebitTransactionInformation
FIToFICustomerDirectDebitV04 *-- "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 message. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% GroupHeader50 recursion level 0 with max 1
class GroupHeader50{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    TotalInterbankSettlementAmount IsoActiveCurrencyAndAmount
    InterbankSettlementDate IsoISODate
}
GroupHeader50 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader50 *-- "1..1" SettlementInstruction2 : SettlementInformation
GroupHeader50 *-- "0..1" PaymentTypeInformation25 : PaymentTypeInformation
GroupHeader50 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
GroupHeader50 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% SettlementInstruction2 recursion level 1 with max 1
class SettlementInstruction2{
    SettlementMethod SettlementMethod2Code
}
SettlementInstruction2 *-- "0..1" CashAccount24 : SettlementAccount
SettlementInstruction2 *-- "0..1" IClearingSystemIdentification3Choice : ClearingSystem
%% PaymentTypeInformation25 recursion level 1 with max 1
class PaymentTypeInformation25{
    InstructionPriority Priority2Code
    ClearingChannel ClearingChannel2Code
    SequenceType SequenceType3Code
}
PaymentTypeInformation25 *-- "0..1" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation25 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation25 *-- "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

GroupHeader50 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
Authorisation User identification or any user key to be used to check whether the initiating party is allowed to initiate transactions from the account specified in the message.
BatchBooking Identifies whether a single entry per individual 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.
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
TotalInterbankSettlementAmount Total 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
SettlementInformation Specifies the details on how the settlement of the transaction(s) between the instructing agent and the instructed agent is completed. SettlementInstruction2 - Required 1..1
PaymentTypeInformation Set of elements used to further specify the type of transaction. PaymentTypeInformation25 - 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

DirectDebitTransactionInformation building block

Set of elements providing information specific to the individual direct debit(s). Provides further details specific to the individual direct debit transaction(s) included in the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DirectDebitTransactionInformation14 recursion level 0 with max 1
class DirectDebitTransactionInformation14{
    InterbankSettlementAmount IsoActiveCurrencyAndAmount
    InterbankSettlementDate IsoISODate
    InstructedAmount IsoActiveOrHistoricCurrencyAndAmount
    ExchangeRate IsoBaseOneRate
    ChargeBearer ChargeBearerType1Code
    RequestedCollectionDate IsoISODate
}
DirectDebitTransactionInformation14 *-- "1..1" PaymentIdentification3 : PaymentIdentification
DirectDebitTransactionInformation14 *-- "0..1" PaymentTypeInformation25 : PaymentTypeInformation
DirectDebitTransactionInformation14 *-- "0..0" Charges2 : ChargesInformation
DirectDebitTransactionInformation14 *-- "0..1" DirectDebitTransaction7 : DirectDebitTransaction
DirectDebitTransactionInformation14 *-- "1..1" PartyIdentification43 : Creditor
DirectDebitTransactionInformation14 *-- "0..1" CashAccount24 : CreditorAccount
DirectDebitTransactionInformation14 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
DirectDebitTransactionInformation14 *-- "0..1" CashAccount24 : CreditorAgentAccount
DirectDebitTransactionInformation14 *-- "0..1" PartyIdentification43 : UltimateCreditor
DirectDebitTransactionInformation14 *-- "0..1" PartyIdentification43 : InitiatingParty
DirectDebitTransactionInformation14 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
DirectDebitTransactionInformation14 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
DirectDebitTransactionInformation14 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent1
DirectDebitTransactionInformation14 *-- "0..1" CashAccount24 : IntermediaryAgent1Account
DirectDebitTransactionInformation14 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent2
DirectDebitTransactionInformation14 *-- "0..1" CashAccount24 : IntermediaryAgent2Account
DirectDebitTransactionInformation14 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent3
DirectDebitTransactionInformation14 *-- "0..1" CashAccount24 : IntermediaryAgent3Account
DirectDebitTransactionInformation14 *-- "1..1" PartyIdentification43 : Debtor
DirectDebitTransactionInformation14 *-- "1..1" CashAccount24 : DebtorAccount
DirectDebitTransactionInformation14 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
DirectDebitTransactionInformation14 *-- "0..1" CashAccount24 : DebtorAgentAccount
DirectDebitTransactionInformation14 *-- "0..1" PartyIdentification43 : UltimateDebtor
DirectDebitTransactionInformation14 *-- "0..1" IPurpose2Choice : Purpose
DirectDebitTransactionInformation14 *-- "0..10" RegulatoryReporting3 : RegulatoryReporting
DirectDebitTransactionInformation14 *-- "0..10" RemittanceLocation2 : RelatedRemittanceInformation
DirectDebitTransactionInformation14 *-- "0..1" RemittanceInformation7 : RemittanceInformation
DirectDebitTransactionInformation14 *-- "0..0" SupplementaryData1 : SupplementaryData
%% PaymentIdentification3 recursion level 1 with max 1
class PaymentIdentification3{
    InstructionIdentification IsoMax35Text
    EndToEndIdentification IsoMax35Text
    TransactionIdentification IsoMax35Text
    ClearingSystemReference IsoMax35Text
}
%% PaymentTypeInformation25 recursion level 1 with max 1
class PaymentTypeInformation25{
    InstructionPriority Priority2Code
    ClearingChannel ClearingChannel2Code
    SequenceType SequenceType3Code
}
PaymentTypeInformation25 *-- "0..1" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation25 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation25 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% Charges2 recursion level 1 with max 1
class Charges2{
    Amount IsoActiveOrHistoricCurrencyAndAmount
}
Charges2 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : Agent
%% DirectDebitTransaction7 recursion level 1 with max 1
class DirectDebitTransaction7{
    PreNotificationIdentification IsoMax35Text
    PreNotificationDate IsoISODate
}
DirectDebitTransaction7 *-- "0..1" MandateRelatedInformation8 : MandateRelatedInformation
DirectDebitTransaction7 *-- "0..1" PartyIdentification43 : CreditorSchemeIdentification
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% 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
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% 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
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% 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
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% IPurpose2Choice recursion level 1 with max 1
%% RegulatoryReporting3 recursion level 1 with max 1
class RegulatoryReporting3{
    DebitCreditReportingIndicator RegulatoryReportingType1Code
}
RegulatoryReporting3 *-- "0..1" RegulatoryAuthority2 : Authority
RegulatoryReporting3 *-- "0..0" StructuredRegulatoryReporting3 : Details
%% RemittanceLocation2 recursion level 1 with max 1
class RemittanceLocation2{
    RemittanceIdentification IsoMax35Text
    RemittanceLocationMethod RemittanceLocationMethod2Code
    RemittanceLocationElectronicAddress IsoMax2048Text
}
RemittanceLocation2 *-- "0..1" NameAndAddress10 : RemittanceLocationPostalAddress
%% RemittanceInformation7 recursion level 1 with max 1
class RemittanceInformation7{
    Unstructured IsoMax140Text
}
RemittanceInformation7 *-- "0..0" StructuredRemittanceInformation9 : Structured
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

DirectDebitTransactionInformation14 members

Member name Description Data Type / Multiplicity
PaymentIdentification Set of elements used to reference a payment instruction. PaymentIdentification3 - Required 1..1
PaymentTypeInformation Set of elements used to further specify the type of transaction. PaymentTypeInformation25 - Optional 0..1
InterbankSettlementAmount Amount of money moved between the instructing agent and the instructed agent. IsoActiveCurrencyAndAmount - Required 1..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
InstructedAmount Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. IsoActiveOrHistoricCurrencyAndAmount - Optional 0..1
ExchangeRate Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. IsoBaseOneRate - Optional 0..1
ChargeBearer Specifies which party/parties will bear the charges associated with the processing of the payment transaction. ChargeBearerType1Code - Required 1..1
ChargesInformation Provides information on the charges to be paid by the charge bearer(s) related to the payment transaction. Charges2 - Unknown 0..0
RequestedCollectionDate Date and time at which the creditor requests that the amount of money is to be collected from the debtor. IsoISODate - Optional 0..1
DirectDebitTransaction Provides information specific to the direct debit mandate. DirectDebitTransaction7 - Optional 0..1
Creditor Party to which an amount of money is due. PartyIdentification43 - 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
CreditorAgent Financial institution servicing an account for the creditor. BranchAndFinancialInstitutionIdentification5 - Required 1..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
UltimateCreditor Ultimate party to which an amount of money is due. PartyIdentification43 - Optional 0..1
InitiatingParty Party that initiates the payment. Usage: This can be either the creditor or a party that initiates the direct debit on behalf of the creditor.
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 agent and creditor agent.
IntermediaryAgent3Account Unambiguous identification of the account of the intermediary agent 3 at its servicing agent in the payment chain. CashAccount24 - Optional 0..1
Debtor Party that owes an amount of money to the (ultimate) creditor. PartyIdentification43 - Required 1..1
DebtorAccount Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. CashAccount24 - Required 1..1
DebtorAgent Financial institution servicing an account for the debtor. BranchAndFinancialInstitutionIdentification5 - Required 1..1
DebtorAgentAccount Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. CashAccount24 - Optional 0..1
UltimateDebtor Ultimate party that owes an amount of money to the (ultimate) creditor. PartyIdentification43 - Optional 0..1
Purpose Underlying reason for the payment transaction. Usage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.
RegulatoryReporting Information needed due to regulatory and statutory requirements. RegulatoryReporting3 - Collection 0..10
RelatedRemittanceInformation Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain. RemittanceLocation2 - Collection 0..10
RemittanceInformation Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts’ receivable system. RemittanceInformation7 - 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 FIToFICustomerDirectDebitV04 implementation follows a specific implementaiton pattern. First of all, FIToFICustomerDirectDebitV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FIToFICustomerDirectDebitV04Document implements IOuterDocument. Because FIToFICustomerDirectDebitV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FIToFICustomerDirectDebitV04.

classDiagram
    class IOuterRecord
    FIToFICustomerDirectDebitV04 --|> IOuterRecord : Implements
    FIToFICustomerDirectDebitV04Document --|> IOuterDocument~FIToFICustomerDirectDebitV04~ : Implements
    class IOuterDocument~FIToFICustomerDirectDebitV04~ {
        FIToFICustomerDirectDebitV04 Message
     }

Document wrapper for serialization

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

classDiagram
    FIToFICustomerDirectDebitV04Document *-- FIToFICustomerDirectDebitV04 : 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.04">
    <FIToFICstmrDrctDbt>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <DrctDbtTxInf>
            <!-- DirectDebitTransactionInformation inner content -->
        </DrctDbtTxInf>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </FIToFICstmrDrctDbt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_I2lhYSGnEeKjd4jizyIDGA"
  nextVersions="_fTgL6xPeEeSVo-TFVwFHvA"
  previousVersion="_sFjsAFkyEeGeoaLUQk__nA_-835726399"
  name="FIToFICustomerDirectDebitV04"
  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."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="FIToFICstmrDrctDbt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_I2lhYyGnEeKjd4jizyIDGA"
    nextVersions="_fTgL7RPeEeSVo-TFVwFHvA"
    name="InstructedAgentRule"
    definition="If GroupHeader/InstructedAgent is present, then DirectDebitTransactionInformation/InstructedAgent is not allowed."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule 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;/DirectDebitTransactionInformation[*]/InstructedAgent&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;/GroupHeader/InstructedAgent&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_I2lhZyGnEeKjd4jizyIDGA"
    nextVersions="_fTgL7xPeEeSVo-TFVwFHvA"
    name="InstructingAgentRule"
    definition="If GroupHeader/InstructingAgent is present, then DirectDebitTransactionInformation/InstructingAgent is not allowed."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule 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;/DirectDebitTransactionInformation[*]/InstructingAgent&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;/GroupHeader/InstructingAgent&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_I2lhayGnEeKjd4jizyIDGA"
    nextVersions="_fTgL8RPeEeSVo-TFVwFHvA"
    name="TotalInterbankSettlementAmountRule"
    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"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;EqualToNode&quot;&gt;&lt;leftOperand&gt;/DirectDebitTransactionInformation[*]/InterbankSettlementAmount/@Currency&lt;/leftOperand&gt;&lt;rightOperand&gt;/GroupHeader/TotalInterbankSettlementAmount/@Currency&lt;/rightOperand&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;/GroupHeader/TotalInterbankSettlementAmount&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_I2lhbyGnEeKjd4jizyIDGA"
    nextVersions="_fTgL8xPeEeSVo-TFVwFHvA"
    name="TotalInterbankSettlementAmountAndSumRule"
    definition="If GroupHeader/TotalInterbankSettlementAmount is present, then it must equal the sum of all occurrences of DirectDebitTransactionInformation/InterbankSettlementAmount."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/GroupHeader/TotalInterbankSettlementAmount&lt;/leftOperand&gt;&lt;rightOperand&gt;sum of /DirectDebitTransactionInformation/InterbankSettlementAmount&lt;/rightOperand&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;/GroupHeader/TotalInterbankSettlementAmount&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_I2lhcyGnEeKjd4jizyIDGA"
    nextVersions="_fTgL9RPeEeSVo-TFVwFHvA"
    name="GroupHeaderInterbankSettlementDateRule"
    definition="If GroupHeader/InterbankSettlementDate is present, then DirectDebitTransactionInformation/InterbankSettlementDate is not allowed."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule 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;/DirectDebitTransactionInformation[*]/InterbankSettlementDate&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;/GroupHeader/InterbankSettlementDate&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_I2lhdyGnEeKjd4jizyIDGA"
    nextVersions="_fTgL9xPeEeSVo-TFVwFHvA"
    name="TransactionInterbankSettlementDateRule"
    definition="If GroupHeader/InterbankSettlementDate is not present, then DirectDebitTransactionInformation/InterbankSettlementDate must be present."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule 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;/DirectDebitTransactionInformation[*]/InterbankSettlementDate&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;/GroupHeader/InterbankSettlementDate&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_I2lheyGnEeKjd4jizyIDGA"
    nextVersions="_fTgL-RPeEeSVo-TFVwFHvA"
    name="PaymentTypeInformationRule"
    definition="If GroupHeader/PaymentTypeInformation is present, then DirectDebitTransactionInformation/PaymentTypeInformation is not allowed."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule 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;/DirectDebitTransactionInformation[*]/PaymentTypeInformation&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;/GroupHeader/PaymentTypeInformation&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_YH_jPyHZEeKGEZlIMFwKzg"
    nextVersions="_fTgL-xPeEeSVo-TFVwFHvA"
    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="_I2lhfyGnEeKjd4jizyIDGA"
    nextVersions="_fTgL_RPeEeSVo-TFVwFHvA"
    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="_s53d0FkyEeGeoaLUQk__nA_1710000299" />
  <messageBuildingBlock
    xmi:id="_I2lhgyGnEeKjd4jizyIDGA"
    nextVersions="_fTgL_xPeEeSVo-TFVwFHvA"
    name="DirectDebitTransactionInformation"
    definition="Set of elements providing information specific to the individual direct debit(s)."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="DrctDbtTxInf"
    complexType="_3SU2ESHKEeK1OvoXgbVMNg" />
  <messageBuildingBlock
    xmi:id="_I2lhhyGnEeKjd4jizyIDGA"
    nextVersions="_fTgMARPeEeSVo-TFVwFHvA"
    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="003"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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