Iso20022

CustomerDirectDebitInitiationV01

pain.008.001.01

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
%% CustomerDirectDebitInitiationV01 recursion level 0 with max 0
CustomerDirectDebitInitiationV01 *-- "1..1" GroupHeader1 : GroupHeader
CustomerDirectDebitInitiationV01 *-- "1..1" PaymentInstructionInformation2 : PaymentInformation

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
%% GroupHeader1 recursion level 0 with max 1
class GroupHeader1{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    Authorisation IsoMax128Text
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    Grouping Grouping1Code
}
GroupHeader1 *-- "1..1" PartyIdentification8 : InitiatingParty
GroupHeader1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : ForwardingAgent
%% 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

GroupHeader1 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 a (group of) payment instruction(s) was created by the instructing party. 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.
BatchBooking Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions in the message is requested. IsoBatchBookingIndicator - Optional 0..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
Grouping Indicates whether common accounting information in the transaction is included once for all transactions or repeated for each single transaction. Grouping1Code - Required 1..1
InitiatingParty Party initiating the payment. In the payment context, this can either be the debtor (in a credit transfer), the creditor (in a direct debit), or the party that initiates the payment on behalf of the debtor or creditor. PartyIdentification8 - Required 1..1
ForwardingAgent Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution. BranchAndFinancialInstitutionIdentification3 - 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. Set of characteristics that apply to the credit side of the payment transactions included in the direct debit transaction initiation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PaymentInstructionInformation2 recursion level 0 with max 1
class PaymentInstructionInformation2{
    PaymentInformationIdentification IsoMax35Text
    PaymentMethod PaymentMethod2Code
    RequestedCollectionDate IsoISODate
    ChargeBearer ChargeBearerType1Code
}
PaymentInstructionInformation2 *-- "0..1" PaymentTypeInformation2 : PaymentTypeInformation
PaymentInstructionInformation2 *-- "1..1" PartyIdentification8 : Creditor
PaymentInstructionInformation2 *-- "1..1" CashAccount7 : CreditorAccount
PaymentInstructionInformation2 *-- "1..1" BranchAndFinancialInstitutionIdentification3 : CreditorAgent
PaymentInstructionInformation2 *-- "0..1" CashAccount7 : CreditorAgentAccount
PaymentInstructionInformation2 *-- "0..1" PartyIdentification8 : UltimateCreditor
PaymentInstructionInformation2 *-- "0..1" CashAccount7 : ChargesAccount
PaymentInstructionInformation2 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : ChargesAccountAgent
PaymentInstructionInformation2 *-- "1..0" DirectDebitTransactionInformation1 : DirectDebitTransactionInformation
%% PaymentTypeInformation2 recursion level 1 with max 1
class PaymentTypeInformation2{
    InstructionPriority Priority2Code
    ClearingChannel ClearingChannel2Code
    SequenceType SequenceType1Code
    CategoryPurpose PaymentCategoryPurpose1Code
}
PaymentTypeInformation2 *-- "0..1" IServiceLevel3Choice : ServiceLevel
PaymentTypeInformation2 *-- "0..1" ILocalInstrument1Choice : LocalInstrument
%% 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
%% 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
%% DirectDebitTransactionInformation1 recursion level 1 with max 1
class DirectDebitTransactionInformation1{
    InstructedAmount IsoCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
    InstructionForCreditorAgent IsoMax140Text
}
DirectDebitTransactionInformation1 *-- "1..1" PaymentIdentification1 : PaymentIdentification
DirectDebitTransactionInformation1 *-- "0..1" PaymentTypeInformation2 : PaymentTypeInformation
DirectDebitTransactionInformation1 *-- "0..1" DirectDebitTransaction1 : DirectDebitTransaction
DirectDebitTransactionInformation1 *-- "0..1" PartyIdentification8 : UltimateCreditor
DirectDebitTransactionInformation1 *-- "1..1" BranchAndFinancialInstitutionIdentification3 : DebtorAgent
DirectDebitTransactionInformation1 *-- "0..1" CashAccount7 : DebtorAgentAccount
DirectDebitTransactionInformation1 *-- "1..1" PartyIdentification8 : Debtor
DirectDebitTransactionInformation1 *-- "1..1" CashAccount7 : DebtorAccount
DirectDebitTransactionInformation1 *-- "0..1" PartyIdentification8 : UltimateDebtor
DirectDebitTransactionInformation1 *-- "0..1" IPurpose1Choice : Purpose
DirectDebitTransactionInformation1 *-- "0..10" RegulatoryReporting2 : RegulatoryReporting
DirectDebitTransactionInformation1 *-- "0..1" TaxInformation2 : Tax
DirectDebitTransactionInformation1 *-- "0..10" RemittanceLocation1 : RelatedRemittanceInformation
DirectDebitTransactionInformation1 *-- "0..1" RemittanceInformation1 : RemittanceInformation

PaymentInstructionInformation2 members

Member name Description Data Type / Multiplicity
PaymentInformationIdentification Reference assigned by a sending party to unambiguously identify the payment information block within the message. IsoMax35Text - Optional 0..1
PaymentMethod Specifies the means of payment that will be used to move the amount of money. PaymentMethod2Code - Required 1..1
PaymentTypeInformation Set of elements used to further specify the type of transaction. PaymentTypeInformation2 - Optional 0..1
RequestedCollectionDate Date at which the creditor requests the amount of money to be collected from the debtor. IsoISODate - Required 1..1
Creditor Party to which an amount of money is due. PartyIdentification8 - 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. CashAccount7 - Required 1..1
CreditorAgent Financial institution servicing an account for the creditor. BranchAndFinancialInstitutionIdentification3 - 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. CashAccount7 - Optional 0..1
UltimateCreditor Ultimate party to which an amount of money is due. PartyIdentification8 - 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.
DirectDebitTransactionInformation Set of elements providing information specific to the individual transaction(s) included in the message. DirectDebitTransactionInformation1 - Unknown 1..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CustomerDirectDebitInitiationV01 --|> IOuterRecord : Implements
    CustomerDirectDebitInitiationV01Document --|> IOuterDocument~CustomerDirectDebitInitiationV01~ : Implements
    class IOuterDocument~CustomerDirectDebitInitiationV01~ {
        CustomerDirectDebitInitiationV01 Message
     }

Document wrapper for serialization

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

classDiagram
    CustomerDirectDebitInitiationV01Document *-- CustomerDirectDebitInitiationV01 : 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.01">
    <pain.008.001.01>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <PmtInf>
            <!-- PaymentInformation inner content -->
        </PmtInf>
    </pain.008.001.01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_GWuvhdEvEd-BzquC8wXy7w_143996786"
  nextVersions="_GW35ftEvEd-BzquC8wXy7w_2046495786"
  name="CustomerDirectDebitInitiationV01"
  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.&#xD;&#xA;If it is agreed to include the payment information related to the credit side only once (i.e. Grouped mode), the PaymentInformation block will be present only once. If it is agreed to repeat the payment information related to the credit side (i.e. Single mode), the PaymentInformation block must be present once per occurrence of the DirectDebitTransactionInformation block. The CustomerDirectDebitInitiation message also allows for a Mixed mode where the PaymentInformation block can be repeated and each PaymentInformation block can contain one or several DirectDebitTransactionInformation block(s).&#xA;Single&#xA;When grouping is set to Single, information for each individual instruction is included separately. This means the&#xA;PaymentInformation block is repeated, and present for each occurrence of the Direct Debit TransactionInformation block.&#xA;Grouped&#xA;When grouping is set to Grouped, the PaymentInformation block will be present once and the Direct Debit&#xA;TransactionInformation block will be repeated.&#xA;Mixed&#xA;When grouping is set to Mixed, the PaymentInformation block may be present once or may be repeated. Each sequence&#xA;of the PaymentInformation block may contain one or several Direct Debit TransactionInformation block(s)."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="pain.008.001.01"
  xmlTag="pain.008.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_GWuviNEvEd-BzquC8wXy7w_144918387"
    name="Grouping1Rule"
    definition="If GroupHeader/Grouping is present and equals GRPD, then one and only one occurrence of PaymentInformation must be present."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_GW35ctEvEd-BzquC8wXy7w_144918483"
    name="Grouping2Rule"
    definition="If GroupHeader/Grouping is present and equals SNGL, then each occurrence of PaymentInformation must contain one and only one occurrence of PaymentInformation/DirectDebitTransactionInformation."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_GWuvhtEvEd-BzquC8wXy7w_143996882"
    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="_PvMh4tp-Ed-ak6NoX_4Aeg_-279444335" />
  <messageBuildingBlock
    xmi:id="_GWuvh9EvEd-BzquC8wXy7w_144917422"
    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="_PzX3QNp-Ed-ak6NoX_4Aeg_-727808881" />
  <messageDefinitionIdentifier
    businessArea="pain"
    messageFunctionality="008"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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