Iso20022

CustomerDirectDebitInitiationV10

pain.008.001.10

Scope The CustomerDirectDebitInitiation message is sent by the initiating party to the forwarding agent or creditor agent. It is used to request single or bulk collection(s) of funds from one or various debtor’s account(s) for a creditor. Usage The CustomerDirectDebitInitiation message can contain one or more direct debit instructions. The message can be used in a direct or a relay scenario:

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
%% CustomerDirectDebitInitiationV10 recursion level 0 with max 0
CustomerDirectDebitInitiationV10 *-- "1..1" GroupHeader83 : GroupHeader
CustomerDirectDebitInitiationV10 *-- "1..1" PaymentInstruction39 : PaymentInformation
CustomerDirectDebitInitiationV10 *-- "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
%% GroupHeader83 recursion level 0 with max 1
class GroupHeader83{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
}
GroupHeader83 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader83 *-- "1..1" PartyIdentification135 : InitiatingParty
GroupHeader83 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ForwardingAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification

GroupHeader83 members

Member name Description Data Type / Multiplicity
MessageIdentification Point to point reference, assigned by the instructing party and sent to the next party in the chain, to unambiguously identify the message.
CreationDateTime Date and time at which the message was created. IsoISODateTime - Required 1..1
Authorisation User identification or any user key that allows to check if the initiating party is allowed to initiate transactions from the account specified in the initiation.
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
InitiatingParty Party that initiates the payment.
ForwardingAgent Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution. BranchAndFinancialInstitutionIdentification6 - Optional 0..1

PaymentInformation building block

Set of characteristics that apply to the credit side of the payment transactions included in the direct debit transaction initiation. Characteristics that apply to the credit side of the payment transactions included in the direct debit initiation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PaymentInstruction39 recursion level 0 with max 1
class PaymentInstruction39{
    PaymentInformationIdentification IsoMax35Text
    PaymentMethod PaymentMethod2Code
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    RequestedCollectionDate IsoISODate
    ChargeBearer ChargeBearerType1Code
}
PaymentInstruction39 *-- "0..1" AdviceType1 : RequestedAdviceType
PaymentInstruction39 *-- "0..1" PaymentTypeInformation29 : PaymentTypeInformation
PaymentInstruction39 *-- "1..1" PartyIdentification135 : Creditor
PaymentInstruction39 *-- "1..1" CashAccount40 : CreditorAccount
PaymentInstruction39 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent
PaymentInstruction39 *-- "0..1" CashAccount40 : CreditorAgentAccount
PaymentInstruction39 *-- "0..1" PartyIdentification135 : UltimateCreditor
PaymentInstruction39 *-- "0..1" CashAccount40 : ChargesAccount
PaymentInstruction39 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ChargesAccountAgent
PaymentInstruction39 *-- "0..1" PartyIdentification135 : CreditorSchemeIdentification
PaymentInstruction39 *-- "1..0" DirectDebitTransactionInformation28 : DirectDebitTransactionInformation
%% AdviceType1 recursion level 1 with max 1
AdviceType1 *-- "0..1" IAdviceType1Choice : CreditAdvice
AdviceType1 *-- "0..1" IAdviceType1Choice : DebitAdvice
%% PaymentTypeInformation29 recursion level 1 with max 1
class PaymentTypeInformation29{
    InstructionPriority Priority2Code
    SequenceType SequenceType3Code
}
PaymentTypeInformation29 *-- "0..0" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation29 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation29 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% CashAccount40 recursion level 1 with max 1
class CashAccount40{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount40 *-- "0..1" IAccountIdentification4Choice : Identification
CashAccount40 *-- "0..1" ICashAccountType2Choice : Type
CashAccount40 *-- "0..1" ProxyAccountIdentification1 : Proxy
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% CashAccount40 recursion level 1 with max 1
class CashAccount40{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount40 *-- "0..1" IAccountIdentification4Choice : Identification
CashAccount40 *-- "0..1" ICashAccountType2Choice : Type
CashAccount40 *-- "0..1" ProxyAccountIdentification1 : Proxy
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% CashAccount40 recursion level 1 with max 1
class CashAccount40{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount40 *-- "0..1" IAccountIdentification4Choice : Identification
CashAccount40 *-- "0..1" ICashAccountType2Choice : Type
CashAccount40 *-- "0..1" ProxyAccountIdentification1 : Proxy
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% DirectDebitTransactionInformation28 recursion level 1 with max 1
class DirectDebitTransactionInformation28{
    InstructedAmount IsoActiveOrHistoricCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
    InstructionForCreditorAgent IsoMax140Text
}
DirectDebitTransactionInformation28 *-- "1..1" PaymentIdentification6 : PaymentIdentification
DirectDebitTransactionInformation28 *-- "0..1" PaymentTypeInformation29 : PaymentTypeInformation
DirectDebitTransactionInformation28 *-- "0..1" DirectDebitTransaction11 : DirectDebitTransaction
DirectDebitTransactionInformation28 *-- "0..1" PartyIdentification135 : UltimateCreditor
DirectDebitTransactionInformation28 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
DirectDebitTransactionInformation28 *-- "0..1" CashAccount40 : DebtorAgentAccount
DirectDebitTransactionInformation28 *-- "1..1" PartyIdentification135 : Debtor
DirectDebitTransactionInformation28 *-- "1..1" CashAccount40 : DebtorAccount
DirectDebitTransactionInformation28 *-- "0..1" PartyIdentification135 : UltimateDebtor
DirectDebitTransactionInformation28 *-- "0..1" IPurpose2Choice : Purpose
DirectDebitTransactionInformation28 *-- "0..10" RegulatoryReporting3 : RegulatoryReporting
DirectDebitTransactionInformation28 *-- "0..1" TaxInformation10 : Tax
DirectDebitTransactionInformation28 *-- "0..10" RemittanceLocation7 : RelatedRemittanceInformation
DirectDebitTransactionInformation28 *-- "0..1" RemittanceInformation21 : RemittanceInformation
DirectDebitTransactionInformation28 *-- "0..0" SupplementaryData1 : SupplementaryData

PaymentInstruction39 members

Member name Description Data Type / Multiplicity
PaymentInformationIdentification Unique identification, as assigned by a sending party, to unambiguously identify the payment information group within the message. IsoMax35Text - Required 1..1
PaymentMethod Specifies the means of payment that will be used to move the amount of money. PaymentMethod2Code - Required 1..1
RequestedAdviceType Type of advice details requested. AdviceType1 - Optional 0..1
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 payment information group. IsoMax15NumericText - Optional 0..1
ControlSum Total of all individual amounts included in the group, irrespective of currencies. IsoDecimalNumber - Optional 0..1
PaymentTypeInformation Set of elements used to further specify the type of transaction. PaymentTypeInformation29 - Optional 0..1
RequestedCollectionDate Date and time at which the creditor requests that the amount of money is to be collected from the debtor. IsoISODate - Required 1..1
Creditor Party to which an amount of money is due. PartyIdentification135 - 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. CashAccount40 - Required 1..1
CreditorAgent Financial institution servicing an account for the creditor. BranchAndFinancialInstitutionIdentification6 - Required 1..1
CreditorAgentAccount Unambiguous identification of the account of the creditor agent at its servicing agent in the payment chain. CashAccount40 - Optional 0..1
UltimateCreditor Ultimate party to which an amount of money is due. PartyIdentification135 - Optional 0..1
ChargeBearer Specifies which party/parties will bear the charges associated with the processing of the payment transaction. ChargeBearerType1Code - Optional 0..1
ChargesAccount Account used to process charges associated with a transaction.
ChargesAccountAgent Agent that services a charges account.
CreditorSchemeIdentification Credit party that signs the mandate. PartyIdentification135 - Optional 0..1
DirectDebitTransactionInformation Provides information on the individual transaction(s) included in the message. DirectDebitTransactionInformation28 - Unknown 1..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 CustomerDirectDebitInitiationV10 implementation follows a specific implementaiton pattern. First of all, CustomerDirectDebitInitiationV10 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CustomerDirectDebitInitiationV10Document implements IOuterDocument. Because CustomerDirectDebitInitiationV10 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CustomerDirectDebitInitiationV10.

classDiagram
    class IOuterRecord
    CustomerDirectDebitInitiationV10 --|> IOuterRecord : Implements
    CustomerDirectDebitInitiationV10Document --|> IOuterDocument~CustomerDirectDebitInitiationV10~ : Implements
    class IOuterDocument~CustomerDirectDebitInitiationV10~ {
        CustomerDirectDebitInitiationV10 Message
     }

Document wrapper for serialization

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

classDiagram
    CustomerDirectDebitInitiationV10Document *-- CustomerDirectDebitInitiationV10 : 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:pain.008.001.10">
    <CstmrDrctDbtInitn>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <PmtInf>
            <!-- PaymentInformation inner content -->
        </PmtInf>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CstmrDrctDbtInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_rUYN0dcBEeq_l4BJLVUF2Q"
  previousVersion="_LwD3PcP_Eemsic1bQcEtLA"
  name="CustomerDirectDebitInitiationV10"
  definition="Scope&#xD;&#xA;The CustomerDirectDebitInitiation message is sent by the initiating party to the forwarding agent or creditor agent. It is used to request single or bulk collection(s) of funds from one or various debtor's account(s) for a creditor.&#xD;&#xA;Usage&#xD;&#xA;The CustomerDirectDebitInitiation message can contain one or more direct debit instructions.&#xD;&#xA;The message can be used in a direct or a relay scenario:&#xD;&#xA;- In a direct scenario, the message is sent directly to the creditor agent. The creditor agent is the account servicer of the creditor.&#xD;&#xA;- In a relay scenario, the message is sent to a forwarding agent. The forwarding agent acts as a concentrating financial institution. It will forward the CustomerDirectDebitInitiation message to the creditor agent.&#xD;&#xA;The message can also be used by an initiating party that has authority to send the message on behalf of the creditor. This caters for example for the scenario of a payments factory initiating all payments on behalf of a large corporate.&#xD;&#xA;The CustomerDirectDebitInitiation message can be used in domestic and cross-border scenarios.&#xD;&#xA;The CustomerDirectDebitInitiation may or may not contain mandate related information, i.e. extracts from a mandate, such as MandateIdentification or DateOfSignature. The CustomerDirectDebitInitiation message must not be considered as a mandate.&#xD;&#xA;The CustomerDirectDebitInitiation message must not be used by the creditor agent to execute the direct debit instruction(s). The FIToFICustomerDirectDebit message must be used instead."
  registrationStatus="Registered"
  messageSet="_ivfzI_2XEeG0oal_knwJ7A"
  xmlTag="CstmrDrctDbtInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_rUYN09cBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3P8P_Eemsic1bQcEtLA"
    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="_rUYN2dcBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3RcP_Eemsic1bQcEtLA"
    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="_M_ZMgW49EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_rUYN29cBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3R8P_Eemsic1bQcEtLA"
    name="PaymentInformation"
    definition="Set of characteristics that apply to the credit side of the payment transactions included in the direct debit transaction initiation."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="PmtInf"
    complexType="_eCraUdcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_rUYN3dcBEeq_l4BJLVUF2Q"
    previousVersion="_LwD3ScP_Eemsic1bQcEtLA"
    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="pain"
    messageFunctionality="008"
    flavour="001"
    version="10" />
</messageDefinition>

ISO Building Blocks

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