Iso20022

CustomerDirectDebitInitiationV02

pain.008.001.02

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
%% CustomerDirectDebitInitiationV02 recursion level 0 with max 0
CustomerDirectDebitInitiationV02 *-- "1..1" GroupHeader39 : GroupHeader
CustomerDirectDebitInitiationV02 *-- "1..1" PaymentInstructionInformation4 : 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
%% GroupHeader39 recursion level 0 with max 1
class GroupHeader39{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
}
GroupHeader39 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader39 *-- "1..1" PartyIdentification32 : InitiatingParty
GroupHeader39 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : ForwardingAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% PartyIdentification32 recursion level 1 with max 1
class PartyIdentification32{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification32 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification32 *-- "0..1" IParty6Choice : Identification
PartyIdentification32 *-- "0..1" ContactDetails2 : ContactDetails
%% BranchAndFinancialInstitutionIdentification4 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification4 *-- "1..1" FinancialInstitutionIdentification7 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification4 *-- "0..1" BranchData2 : BranchIdentification

GroupHeader39 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.
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. BranchAndFinancialInstitutionIdentification4 - 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 initiation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PaymentInstructionInformation4 recursion level 0 with max 1
class PaymentInstructionInformation4{
    PaymentInformationIdentification IsoMax35Text
    PaymentMethod PaymentMethod2Code
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    RequestedCollectionDate IsoISODate
    ChargeBearer ChargeBearerType1Code
}
PaymentInstructionInformation4 *-- "0..1" PaymentTypeInformation20 : PaymentTypeInformation
PaymentInstructionInformation4 *-- "1..1" PartyIdentification32 : Creditor
PaymentInstructionInformation4 *-- "1..1" CashAccount16 : CreditorAccount
PaymentInstructionInformation4 *-- "1..1" BranchAndFinancialInstitutionIdentification4 : CreditorAgent
PaymentInstructionInformation4 *-- "0..1" CashAccount16 : CreditorAgentAccount
PaymentInstructionInformation4 *-- "0..1" PartyIdentification32 : UltimateCreditor
PaymentInstructionInformation4 *-- "0..1" CashAccount16 : ChargesAccount
PaymentInstructionInformation4 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : ChargesAccountAgent
PaymentInstructionInformation4 *-- "0..1" PartyIdentification32 : CreditorSchemeIdentification
PaymentInstructionInformation4 *-- "1..0" DirectDebitTransactionInformation9 : DirectDebitTransactionInformation
%% PaymentTypeInformation20 recursion level 1 with max 1
class PaymentTypeInformation20{
    InstructionPriority Priority2Code
    SequenceType SequenceType1Code
}
PaymentTypeInformation20 *-- "0..1" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation20 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation20 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% PartyIdentification32 recursion level 1 with max 1
class PartyIdentification32{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification32 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification32 *-- "0..1" IParty6Choice : Identification
PartyIdentification32 *-- "0..1" ContactDetails2 : ContactDetails
%% CashAccount16 recursion level 1 with max 1
class CashAccount16{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount16 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount16 *-- "0..1" CashAccountType2 : Type
%% BranchAndFinancialInstitutionIdentification4 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification4 *-- "1..1" FinancialInstitutionIdentification7 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification4 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount16 recursion level 1 with max 1
class CashAccount16{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount16 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount16 *-- "0..1" CashAccountType2 : Type
%% PartyIdentification32 recursion level 1 with max 1
class PartyIdentification32{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification32 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification32 *-- "0..1" IParty6Choice : Identification
PartyIdentification32 *-- "0..1" ContactDetails2 : ContactDetails
%% CashAccount16 recursion level 1 with max 1
class CashAccount16{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount16 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount16 *-- "0..1" CashAccountType2 : Type
%% BranchAndFinancialInstitutionIdentification4 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification4 *-- "1..1" FinancialInstitutionIdentification7 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification4 *-- "0..1" BranchData2 : BranchIdentification
%% PartyIdentification32 recursion level 1 with max 1
class PartyIdentification32{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification32 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification32 *-- "0..1" IParty6Choice : Identification
PartyIdentification32 *-- "0..1" ContactDetails2 : ContactDetails
%% DirectDebitTransactionInformation9 recursion level 1 with max 1
class DirectDebitTransactionInformation9{
    InstructedAmount IsoActiveOrHistoricCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
    InstructionForCreditorAgent IsoMax140Text
}
DirectDebitTransactionInformation9 *-- "1..1" PaymentIdentification1 : PaymentIdentification
DirectDebitTransactionInformation9 *-- "0..1" PaymentTypeInformation20 : PaymentTypeInformation
DirectDebitTransactionInformation9 *-- "0..1" DirectDebitTransaction6 : DirectDebitTransaction
DirectDebitTransactionInformation9 *-- "0..1" PartyIdentification32 : UltimateCreditor
DirectDebitTransactionInformation9 *-- "1..1" BranchAndFinancialInstitutionIdentification4 : DebtorAgent
DirectDebitTransactionInformation9 *-- "0..1" CashAccount16 : DebtorAgentAccount
DirectDebitTransactionInformation9 *-- "1..1" PartyIdentification32 : Debtor
DirectDebitTransactionInformation9 *-- "1..1" CashAccount16 : DebtorAccount
DirectDebitTransactionInformation9 *-- "0..1" PartyIdentification32 : UltimateDebtor
DirectDebitTransactionInformation9 *-- "0..1" IPurpose2Choice : Purpose
DirectDebitTransactionInformation9 *-- "0..10" RegulatoryReporting3 : RegulatoryReporting
DirectDebitTransactionInformation9 *-- "0..1" TaxInformation3 : Tax
DirectDebitTransactionInformation9 *-- "0..10" RemittanceLocation2 : RelatedRemittanceInformation
DirectDebitTransactionInformation9 *-- "0..1" RemittanceInformation5 : RemittanceInformation

PaymentInstructionInformation4 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
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. PaymentTypeInformation20 - 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. PartyIdentification32 - 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. CashAccount16 - Required 1..1
CreditorAgent Financial institution servicing an account for the creditor. BranchAndFinancialInstitutionIdentification4 - Required 1..1
CreditorAgentAccount Unambiguous identification of the account of the creditor agent at its servicing agent in the payment chain. CashAccount16 - Optional 0..1
UltimateCreditor Ultimate party to which an amount of money is due. PartyIdentification32 - 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. PartyIdentification32 - Optional 0..1
DirectDebitTransactionInformation Set of elements used to provide information on the individual transaction(s) included in the message. DirectDebitTransactionInformation9 - Unknown 1..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CustomerDirectDebitInitiationV02 --|> IOuterRecord : Implements
    CustomerDirectDebitInitiationV02Document --|> IOuterDocument~CustomerDirectDebitInitiationV02~ : Implements
    class IOuterDocument~CustomerDirectDebitInitiationV02~ {
        CustomerDirectDebitInitiationV02 Message
     }

Document wrapper for serialization

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

classDiagram
    CustomerDirectDebitInitiationV02Document *-- CustomerDirectDebitInitiationV02 : 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.02">
    <CstmrDrctDbtInitn>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <PmtInf>
            <!-- PaymentInformation inner content -->
        </PmtInf>
    </CstmrDrctDbtInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_GW35ftEvEd-BzquC8wXy7w_2046495786"
  nextVersions="_r29PUFkyEeGeoaLUQk__nA_-589797426"
  previousVersion="_GWuvhdEvEd-BzquC8wXy7w_143996786"
  name="CustomerDirectDebitInitiationV02"
  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="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CstmrDrctDbtInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_GW35f9EvEd-BzquC8wXy7w_2046495818"
    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="_P9NIsdp-Ed-ak6NoX_4Aeg_1208493683" />
  <messageBuildingBlock
    xmi:id="_GW35gNEvEd-BzquC8wXy7w_2046495879"
    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="_PkUHqtp-Ed-ak6NoX_4Aeg_1196042811" />
  <messageDefinitionIdentifier
    businessArea="pain"
    messageFunctionality="008"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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