pacs.003.001.09
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 FItoFICustomerDirectDebit message may or may not contain mandate related information, that is 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
%% FIToFICustomerDirectDebitV09 recursion level 0 with max 0
FIToFICustomerDirectDebitV09 *-- "1..1" GroupHeader98 : GroupHeader
FIToFICustomerDirectDebitV09 *-- "1..1" DirectDebitTransactionInformation29 : DirectDebitTransactionInformation
FIToFICustomerDirectDebitV09 *-- "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
%% GroupHeader98 recursion level 0 with max 1
class GroupHeader98{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
BatchBooking IsoBatchBookingIndicator
NumberOfTransactions IsoMax15NumericText
ControlSum IsoDecimalNumber
TotalInterbankSettlementAmount IsoActiveCurrencyAndAmount
InterbankSettlementDate IsoISODate
}
GroupHeader98 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader98 *-- "1..1" SettlementInstruction14 : SettlementInformation
GroupHeader98 *-- "0..1" PaymentTypeInformation27 : PaymentTypeInformation
GroupHeader98 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructingAgent
GroupHeader98 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructedAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% SettlementInstruction14 recursion level 1 with max 1
class SettlementInstruction14{
SettlementMethod SettlementMethod2Code
}
SettlementInstruction14 *-- "0..1" CashAccount40 : SettlementAccount
SettlementInstruction14 *-- "0..1" IClearingSystemIdentification3Choice : ClearingSystem
%% PaymentTypeInformation27 recursion level 1 with max 1
class PaymentTypeInformation27{
InstructionPriority Priority2Code
ClearingChannel ClearingChannel2Code
SequenceType SequenceType3Code
}
PaymentTypeInformation27 *-- "0..0" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation27 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation27 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
GroupHeader98 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. | SettlementInstruction14 - Required 1..1 |
| PaymentTypeInformation | Set of elements used to further specify the type of transaction. | PaymentTypeInformation27 - Optional 0..1 |
| InstructingAgent | Agent that instructs the next party in the chain to carry out the (set of) instruction(s). | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
| InstructedAgent | Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s). | BranchAndFinancialInstitutionIdentification6 - 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
%% DirectDebitTransactionInformation29 recursion level 0 with max 1
class DirectDebitTransactionInformation29{
InterbankSettlementAmount IsoActiveCurrencyAndAmount
InterbankSettlementDate IsoISODate
SettlementPriority Priority3Code
InstructedAmount IsoActiveOrHistoricCurrencyAndAmount
ExchangeRate IsoBaseOneRate
ChargeBearer ChargeBearerType1Code
RequestedCollectionDate IsoISODate
}
DirectDebitTransactionInformation29 *-- "1..1" PaymentIdentification13 : PaymentIdentification
DirectDebitTransactionInformation29 *-- "0..1" PaymentTypeInformation27 : PaymentTypeInformation
DirectDebitTransactionInformation29 *-- "0..1" SettlementDateTimeIndication1 : SettlementTimeIndication
DirectDebitTransactionInformation29 *-- "0..0" Charges7 : ChargesInformation
DirectDebitTransactionInformation29 *-- "0..1" DirectDebitTransaction11 : DirectDebitTransaction
DirectDebitTransactionInformation29 *-- "1..1" PartyIdentification135 : Creditor
DirectDebitTransactionInformation29 *-- "0..1" CashAccount40 : CreditorAccount
DirectDebitTransactionInformation29 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent
DirectDebitTransactionInformation29 *-- "0..1" CashAccount40 : CreditorAgentAccount
DirectDebitTransactionInformation29 *-- "0..1" PartyIdentification135 : UltimateCreditor
DirectDebitTransactionInformation29 *-- "0..1" PartyIdentification135 : InitiatingParty
DirectDebitTransactionInformation29 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructingAgent
DirectDebitTransactionInformation29 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructedAgent
DirectDebitTransactionInformation29 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent1
DirectDebitTransactionInformation29 *-- "0..1" CashAccount40 : IntermediaryAgent1Account
DirectDebitTransactionInformation29 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent2
DirectDebitTransactionInformation29 *-- "0..1" CashAccount40 : IntermediaryAgent2Account
DirectDebitTransactionInformation29 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent3
DirectDebitTransactionInformation29 *-- "0..1" CashAccount40 : IntermediaryAgent3Account
DirectDebitTransactionInformation29 *-- "1..1" PartyIdentification135 : Debtor
DirectDebitTransactionInformation29 *-- "1..1" CashAccount40 : DebtorAccount
DirectDebitTransactionInformation29 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
DirectDebitTransactionInformation29 *-- "0..1" CashAccount40 : DebtorAgentAccount
DirectDebitTransactionInformation29 *-- "0..1" PartyIdentification135 : UltimateDebtor
DirectDebitTransactionInformation29 *-- "0..1" IPurpose2Choice : Purpose
DirectDebitTransactionInformation29 *-- "0..10" RegulatoryReporting3 : RegulatoryReporting
DirectDebitTransactionInformation29 *-- "0..10" RemittanceLocation7 : RelatedRemittanceInformation
DirectDebitTransactionInformation29 *-- "0..1" RemittanceInformation21 : RemittanceInformation
DirectDebitTransactionInformation29 *-- "0..0" SupplementaryData1 : SupplementaryData
%% PaymentIdentification13 recursion level 1 with max 1
class PaymentIdentification13{
InstructionIdentification IsoMax35Text
EndToEndIdentification IsoMax35Text
TransactionIdentification IsoMax35Text
UETR IsoUUIDv4Identifier
ClearingSystemReference IsoMax35Text
}
%% PaymentTypeInformation27 recursion level 1 with max 1
class PaymentTypeInformation27{
InstructionPriority Priority2Code
ClearingChannel ClearingChannel2Code
SequenceType SequenceType3Code
}
PaymentTypeInformation27 *-- "0..0" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation27 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation27 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% SettlementDateTimeIndication1 recursion level 1 with max 1
class SettlementDateTimeIndication1{
DebitDateTime IsoISODateTime
CreditDateTime IsoISODateTime
}
%% Charges7 recursion level 1 with max 1
class Charges7{
Amount IsoActiveOrHistoricCurrencyAndAmount
}
Charges7 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : Agent
%% DirectDebitTransaction11 recursion level 1 with max 1
class DirectDebitTransaction11{
PreNotificationIdentification IsoMax35Text
PreNotificationDate IsoISODate
}
DirectDebitTransaction11 *-- "0..1" MandateRelatedInformation15 : MandateRelatedInformation
DirectDebitTransaction11 *-- "0..1" PartyIdentification135 : CreditorSchemeIdentification
%% 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
%% 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
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% 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
%% 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
%% 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
%% 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
%% 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
%% RemittanceLocation7 recursion level 1 with max 1
class RemittanceLocation7{
RemittanceIdentification IsoMax35Text
}
RemittanceLocation7 *-- "0..0" RemittanceLocationData1 : RemittanceLocationDetails
%% RemittanceInformation21 recursion level 1 with max 1
class RemittanceInformation21{
Unstructured IsoMax140Text
}
RemittanceInformation21 *-- "0..0" StructuredRemittanceInformation17 : Structured
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
DirectDebitTransactionInformation29 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PaymentIdentification | Set of elements used to reference a payment instruction. | PaymentIdentification13 - Required 1..1 |
| PaymentTypeInformation | Set of elements used to further specify the type of transaction. | PaymentTypeInformation27 - 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 |
| SettlementPriority | Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the settlement instruction. | Priority3Code - Optional 0..1 |
| SettlementTimeIndication | Provides information on the occurred settlement time(s) of the payment transaction. | SettlementDateTimeIndication1 - 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. Usage: This amount has to be transported unchanged through the transaction chain. | 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. | Charges7 - 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. | DirectDebitTransaction11 - Optional 0..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 - Optional 0..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 to which a credit entry will be made as a result of the payment transaction. | CashAccount40 - Optional 0..1 |
| UltimateCreditor | Ultimate party to which an amount of money is due. | PartyIdentification135 - 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). | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
| InstructedAgent | Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s). | BranchAndFinancialInstitutionIdentification6 - 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. | CashAccount40 - 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. | CashAccount40 - 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. | CashAccount40 - Optional 0..1 |
| Debtor | Party that owes an amount of money to the (ultimate) creditor. | PartyIdentification135 - 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. | CashAccount40 - Required 1..1 |
| DebtorAgent | Financial institution servicing an account for the debtor. | BranchAndFinancialInstitutionIdentification6 - Required 1..1 |
| DebtorAgentAccount | Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. | CashAccount40 - Optional 0..1 |
| UltimateDebtor | Ultimate party that owes an amount of money to the (ultimate) creditor. | PartyIdentification135 - 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. | RemittanceLocation7 - 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. | RemittanceInformation21 - 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 FIToFICustomerDirectDebitV09 implementation follows a specific implementaiton pattern. First of all, FIToFICustomerDirectDebitV09 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FIToFICustomerDirectDebitV09Document implements IOuterDocument. Because FIToFICustomerDirectDebitV09 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FIToFICustomerDirectDebitV09.
classDiagram
class IOuterRecord
FIToFICustomerDirectDebitV09 --|> IOuterRecord : Implements
FIToFICustomerDirectDebitV09Document --|> IOuterDocument~FIToFICustomerDirectDebitV09~ : Implements
class IOuterDocument~FIToFICustomerDirectDebitV09~ {
FIToFICustomerDirectDebitV09 Message
}
Document wrapper for serialization
The only real purpose FIToFICustomerDirectDebitV09Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pacs.003.001.09’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FIToFICustomerDirectDebitV09.ToDocument() method. The returned FIToFICustomerDirectDebitV09Document value will serialize correctly according to ISO 20022 standards.
classDiagram
FIToFICustomerDirectDebitV09Document *-- FIToFICustomerDirectDebitV09 : 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.09">
<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="_jMYzIdcBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8MRlUEe2Do_UtrNmb2g"
previousVersion="_x0JYi3L4EeidQ_AAdEzxQA"
name="FIToFICustomerDirectDebitV09"
definition="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 FItoFICustomerDirectDebit message may or may not contain mandate related information, that is 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."
registrationStatus="Registered"
messageSet="_wRx2w02rEeG_I4xRYCA_7g"
xmlTag="FIToFICstmrDrctDbt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_jMYzI9cBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8MxlUEe2Do_UtrNmb2g"
previousVersion="_x0JYjXL4EeidQ_AAdEzxQA"
name="InstructedAgentRule"
definition="If GroupHeader/InstructedAgent is present, then DirectDebitTransactionInformation/InstructedAgent is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/DirectDebitTransactionInformation[*]/InstructedAgent</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InstructedAgent</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_jMYzJdcBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8NRlUEe2Do_UtrNmb2g"
previousVersion="_x0JYj3L4EeidQ_AAdEzxQA"
name="InstructingAgentRule"
definition="If GroupHeader/InstructingAgent is present, then DirectDebitTransactionInformation/InstructingAgent is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/DirectDebitTransactionInformation[*]/InstructingAgent</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InstructingAgent</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_jMYzJ9cBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8NxlUEe2Do_UtrNmb2g"
previousVersion="_x0JYkXL4EeidQ_AAdEzxQA"
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="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="EqualToNode"><leftOperand>/DirectDebitTransactionInformation[*]/InterbankSettlementAmount/@Currency</leftOperand><rightOperand>/GroupHeader/TotalInterbankSettlementAmount/@Currency</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/TotalInterbankSettlementAmount</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_jMYzKdcBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8ORlUEe2Do_UtrNmb2g"
previousVersion="_x0JYk3L4EeidQ_AAdEzxQA"
name="TotalInterbankSettlementAmountAndSumRule"
definition="If GroupHeader/TotalInterbankSettlementAmount is present, then it must equal the sum of all occurrences of DirectDebitTransactionInformation/InterbankSettlementAmount."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="EqualToValue"><leftOperand>/GroupHeader/TotalInterbankSettlementAmount</leftOperand><rightOperand>sum of /DirectDebitTransactionInformation/InterbankSettlementAmount</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/TotalInterbankSettlementAmount</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_jMYzK9cBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8OxlUEe2Do_UtrNmb2g"
previousVersion="_x0JYlXL4EeidQ_AAdEzxQA"
name="GroupHeaderInterbankSettlementDateRule"
definition="If GroupHeader/InterbankSettlementDate is present, then DirectDebitTransactionInformation/InterbankSettlementDate is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/DirectDebitTransactionInformation[*]/InterbankSettlementDate</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InterbankSettlementDate</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_jMYzLdcBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8PRlUEe2Do_UtrNmb2g"
previousVersion="_x0JYl3L4EeidQ_AAdEzxQA"
name="TransactionInterbankSettlementDateRule"
definition="If GroupHeader/InterbankSettlementDate is not present, then DirectDebitTransactionInformation/InterbankSettlementDate must be present."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/DirectDebitTransactionInformation[*]/InterbankSettlementDate</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/GroupHeader/InterbankSettlementDate</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_jMYzL9cBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8PxlUEe2Do_UtrNmb2g"
previousVersion="_x0JYmXL4EeidQ_AAdEzxQA"
name="PaymentTypeInformationRule"
definition="If GroupHeader/PaymentTypeInformation is present, then DirectDebitTransactionInformation/PaymentTypeInformation is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><ComplexRule xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/DirectDebitTransactionInformation[*]/PaymentTypeInformation</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/PaymentTypeInformation</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_jMYzMdcBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8QRlUEe2Do_UtrNmb2g"
previousVersion="_x0JYm3L4EeidQ_AAdEzxQA"
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="_jMYzN9cBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8TxlUEe2Do_UtrNmb2g"
previousVersion="_x0JYnXL4EeidQ_AAdEzxQA"
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="_g0NGwdcZEeqRFcf2R4bPBw" />
<messageBuildingBlock
xmi:id="_jMYzOdcBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8URlUEe2Do_UtrNmb2g"
previousVersion="_x0JYn3L4EeidQ_AAdEzxQA"
name="DirectDebitTransactionInformation"
definition="Set of elements providing information specific to the individual direct debit(s)."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="DrctDbtTxInf"
complexType="_fY8CodcZEeqRFcf2R4bPBw" />
<messageBuildingBlock
xmi:id="_jMYzO9cBEeq_l4BJLVUF2Q"
nextVersions="_8Pj8UxlUEe2Do_UtrNmb2g"
previousVersion="_x0JYoXL4EeidQ_AAdEzxQA"
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="09" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.