pacs.009.001.04
Scope The FinancialInstitutionCreditTransfer message is sent by a debtor financial institution to a creditor financial institution, directly or through other agents and/or a payment clearing and settlement system. It is used to move funds from a debtor account to a creditor, where both debtor and creditor are financial institutions. Usage The FinancialInstitutionCreditTransfer message is exchanged between agents and can contain one or more credit transfer instructions where debtor and creditor are both financial institutions. The FinancialInstitutionCreditTransfer message does not allow for grouping: a CreditTransferTransactionInformation block must be present for each credit transfer transaction. The FinancialInstitutionCreditTransfer 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 %% FinancialInstitutionCreditTransferV04 recursion level 0 with max 0 FinancialInstitutionCreditTransferV04 *-- "1..1" GroupHeader49 : GroupHeader FinancialInstitutionCreditTransferV04 *-- "1..1" CreditTransferTransaction8 : CreditTransferTransactionInformation FinancialInstitutionCreditTransferV04 *-- "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 %% GroupHeader49 recursion level 0 with max 1 class GroupHeader49{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime BatchBooking IsoBatchBookingIndicator NumberOfTransactions IsoMax15NumericText ControlSum IsoDecimalNumber TotalInterbankSettlementAmount IsoActiveCurrencyAndAmount InterbankSettlementDate IsoISODate } GroupHeader49 *-- "1..1" SettlementInstruction1 : SettlementInformation GroupHeader49 *-- "0..1" PaymentTypeInformation21 : PaymentTypeInformation GroupHeader49 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent GroupHeader49 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent %% SettlementInstruction1 recursion level 1 with max 1 class SettlementInstruction1{ SettlementMethod SettlementMethod1Code } SettlementInstruction1 *-- "0..1" CashAccount24 : SettlementAccount SettlementInstruction1 *-- "0..1" IClearingSystemIdentification3Choice : ClearingSystem SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingReimbursementAgent SettlementInstruction1 *-- "0..1" CashAccount24 : InstructingReimbursementAgentAccount SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedReimbursementAgent SettlementInstruction1 *-- "0..1" CashAccount24 : InstructedReimbursementAgentAccount SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : ThirdReimbursementAgent SettlementInstruction1 *-- "0..1" CashAccount24 : ThirdReimbursementAgentAccount %% PaymentTypeInformation21 recursion level 1 with max 1 class PaymentTypeInformation21{ InstructionPriority Priority2Code ClearingChannel ClearingChannel2Code } PaymentTypeInformation21 *-- "0..1" IServiceLevel8Choice : ServiceLevel PaymentTypeInformation21 *-- "0..1" ILocalInstrument2Choice : LocalInstrument PaymentTypeInformation21 *-- "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
GroupHeader49 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 |
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. | SettlementInstruction1 - Required 1..1 |
PaymentTypeInformation | Set of elements used to further specify the type of transaction. | PaymentTypeInformation21 - 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 |
CreditTransferTransactionInformation building block
Set of elements providing information specific to the individual credit transfer(s). Provide further details specific to the individual transaction(s) included in the message. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CreditTransferTransaction8 recursion level 0 with max 1 class CreditTransferTransaction8{ InterbankSettlementAmount IsoActiveCurrencyAndAmount InterbankSettlementDate IsoISODate SettlementPriority Priority3Code } CreditTransferTransaction8 *-- "1..1" PaymentIdentification3 : PaymentIdentification CreditTransferTransaction8 *-- "0..1" PaymentTypeInformation21 : PaymentTypeInformation CreditTransferTransaction8 *-- "0..1" SettlementDateTimeIndication1 : SettlementTimeIndication CreditTransferTransaction8 *-- "0..1" SettlementTimeRequest2 : SettlementTimeRequest CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : PreviousInstructingAgent CreditTransferTransaction8 *-- "0..1" CashAccount24 : PreviousInstructingAgentAccount CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent1 CreditTransferTransaction8 *-- "0..1" CashAccount24 : IntermediaryAgent1Account CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent2 CreditTransferTransaction8 *-- "0..1" CashAccount24 : IntermediaryAgent2Account CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent3 CreditTransferTransaction8 *-- "0..1" CashAccount24 : IntermediaryAgent3Account CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : UltimateDebtor CreditTransferTransaction8 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : Debtor CreditTransferTransaction8 *-- "0..1" CashAccount24 : DebtorAccount CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent CreditTransferTransaction8 *-- "0..1" CashAccount24 : DebtorAgentAccount CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent CreditTransferTransaction8 *-- "0..1" CashAccount24 : CreditorAgentAccount CreditTransferTransaction8 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : Creditor CreditTransferTransaction8 *-- "0..1" CashAccount24 : CreditorAccount CreditTransferTransaction8 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : UltimateCreditor CreditTransferTransaction8 *-- "0..0" InstructionForCreditorAgent2 : InstructionForCreditorAgent CreditTransferTransaction8 *-- "0..0" InstructionForNextAgent1 : InstructionForNextAgent CreditTransferTransaction8 *-- "0..1" RemittanceInformation2 : RemittanceInformation CreditTransferTransaction8 *-- "0..1" CreditTransferTransaction3 : UnderlyingCustomerCreditTransfer CreditTransferTransaction8 *-- "0..0" SupplementaryData1 : SupplementaryData %% PaymentIdentification3 recursion level 1 with max 1 class PaymentIdentification3{ InstructionIdentification IsoMax35Text EndToEndIdentification IsoMax35Text TransactionIdentification IsoMax35Text ClearingSystemReference IsoMax35Text } %% PaymentTypeInformation21 recursion level 1 with max 1 class PaymentTypeInformation21{ InstructionPriority Priority2Code ClearingChannel ClearingChannel2Code } PaymentTypeInformation21 *-- "0..1" IServiceLevel8Choice : ServiceLevel PaymentTypeInformation21 *-- "0..1" ILocalInstrument2Choice : LocalInstrument PaymentTypeInformation21 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose %% SettlementDateTimeIndication1 recursion level 1 with max 1 class SettlementDateTimeIndication1{ DebitDateTime IsoISODateTime CreditDateTime IsoISODateTime } %% SettlementTimeRequest2 recursion level 1 with max 1 class SettlementTimeRequest2{ CLSTime IsoISOTime TillTime IsoISOTime FromTime IsoISOTime RejectTime IsoISOTime } %% 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 %% 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 %% 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 %% 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 %% InstructionForCreditorAgent2 recursion level 1 with max 1 class InstructionForCreditorAgent2{ Code Instruction5Code InstructionInformation IsoMax140Text } %% InstructionForNextAgent1 recursion level 1 with max 1 class InstructionForNextAgent1{ Code Instruction4Code InstructionInformation IsoMax140Text } %% RemittanceInformation2 recursion level 1 with max 1 class RemittanceInformation2{ Unstructured IsoMax140Text } %% CreditTransferTransaction3 recursion level 1 with max 1 class CreditTransferTransaction3{ InstructedAmount IsoActiveOrHistoricCurrencyAndAmount } CreditTransferTransaction3 *-- "0..1" PartyIdentification43 : UltimateDebtor CreditTransferTransaction3 *-- "0..1" PartyIdentification43 : InitiatingParty CreditTransferTransaction3 *-- "1..1" PartyIdentification43 : Debtor CreditTransferTransaction3 *-- "0..1" CashAccount24 : DebtorAccount CreditTransferTransaction3 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent CreditTransferTransaction3 *-- "0..1" CashAccount24 : DebtorAgentAccount CreditTransferTransaction3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : PreviousInstructingAgent CreditTransferTransaction3 *-- "0..1" CashAccount24 : PreviousInstructingAgentAccount CreditTransferTransaction3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent1 CreditTransferTransaction3 *-- "0..1" CashAccount24 : IntermediaryAgent1Account CreditTransferTransaction3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent2 CreditTransferTransaction3 *-- "0..1" CashAccount24 : IntermediaryAgent2Account CreditTransferTransaction3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent3 CreditTransferTransaction3 *-- "0..1" CashAccount24 : IntermediaryAgent3Account CreditTransferTransaction3 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent CreditTransferTransaction3 *-- "0..1" CashAccount24 : CreditorAgentAccount CreditTransferTransaction3 *-- "1..1" PartyIdentification43 : Creditor CreditTransferTransaction3 *-- "0..1" CashAccount24 : CreditorAccount CreditTransferTransaction3 *-- "0..1" PartyIdentification43 : UltimateCreditor CreditTransferTransaction3 *-- "0..1" RemittanceInformation7 : RemittanceInformation %% SupplementaryData1 recursion level 1 with max 1 class SupplementaryData1{ PlaceAndName IsoMax350Text } SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
CreditTransferTransaction8 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. | PaymentTypeInformation21 - 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 |
SettlementTimeRequest | Provides information on the requested settlement time(s) of the payment instruction. | SettlementTimeRequest2 - Optional 0..1 |
PreviousInstructingAgent | Agent immediately prior to the instructing agent. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
PreviousInstructingAgentAccount | Unambiguous identification of the account of the previous instructing agent at its servicing agent in the payment chain. | CashAccount24 - 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 |
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’s agent and the creditor’s agent. | |
IntermediaryAgent3Account | Unambiguous identification of the account of the intermediary agent 3 at its servicing agent in the payment chain. | CashAccount24 - Optional 0..1 |
UltimateDebtor | Ultimate financial institution that owes an amount of money to the (ultimate) institutional creditor. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
Debtor | Financial institution that owes an amount of money to the (ultimate) financial institutional creditor. | BranchAndFinancialInstitutionIdentification5 - 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 - Optional 0..1 |
DebtorAgent | Financial institution servicing an account for the debtor. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
DebtorAgentAccount | Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. | CashAccount24 - Optional 0..1 |
CreditorAgent | Financial institution servicing an account for the creditor. | BranchAndFinancialInstitutionIdentification5 - Optional 0..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 |
Creditor | Financial institution that receives an amount of money from the financial institutional debtor. | BranchAndFinancialInstitutionIdentification5 - 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 |
UltimateCreditor | Ultimate financial institution to which an amount of money is due. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
InstructionForCreditorAgent | Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. | InstructionForCreditorAgent2 - Unknown 0..0 |
InstructionForNextAgent | Further information related to the processing of the payment instruction that may need to be acted upon by the next agent. | |
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. | RemittanceInformation2 - Optional 0..1 |
UnderlyingCustomerCreditTransfer | Provides information on the underlying customer credit transfer for which cover is provided. | CreditTransferTransaction3 - 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 FinancialInstitutionCreditTransferV04 implementation follows a specific implementaiton pattern. First of all, FinancialInstitutionCreditTransferV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FinancialInstitutionCreditTransferV04Document implements IOuterDocument. Because FinancialInstitutionCreditTransferV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FinancialInstitutionCreditTransferV04.
classDiagram class IOuterRecord FinancialInstitutionCreditTransferV04 --|> IOuterRecord : Implements FinancialInstitutionCreditTransferV04Document --|> IOuterDocument~FinancialInstitutionCreditTransferV04~ : Implements class IOuterDocument~FinancialInstitutionCreditTransferV04~ { FinancialInstitutionCreditTransferV04 Message }
Document wrapper for serialization
The only real purpose FinancialInstitutionCreditTransferV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pacs.009.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FinancialInstitutionCreditTransferV04.ToDocument() method. The returned FinancialInstitutionCreditTransferV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram FinancialInstitutionCreditTransferV04Document *-- FinancialInstitutionCreditTransferV04 : 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.009.001.04">
<FICdtTrf>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<CdtTrfTxInf>
<!-- CreditTransferTransactionInformation inner content -->
</CdtTrfTxInf>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</FICdtTrf>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_dv-LESGnEeKjd4jizyIDGA"
nextVersions="_fTgMORPeEeSVo-TFVwFHvA"
previousVersion="_sB-zkFkyEeGeoaLUQk__nA_-289152134"
name="FinancialInstitutionCreditTransferV04"
definition="Scope
The FinancialInstitutionCreditTransfer message is sent by a debtor financial institution to a creditor financial institution, directly or through other agents and/or a payment clearing and settlement system.
It is used to move funds from a debtor account to a creditor, where both debtor and creditor are financial institutions.
Usage
The FinancialInstitutionCreditTransfer message is exchanged between agents and can contain one or more credit transfer instructions where debtor and creditor are both financial institutions.
The FinancialInstitutionCreditTransfer message does not allow for grouping: a CreditTransferTransactionInformation block must be present for each credit transfer transaction.
The FinancialInstitutionCreditTransfer message can be used in domestic and cross-border scenarios."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="FICdtTrf"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_dv-LEyGnEeKjd4jizyIDGA"
nextVersions="_fTgMOxPeEeSVo-TFVwFHvA"
name="InstructedAgentRule"
definition="If GroupHeader/InstructedAgent is present, then CreditTransferTransactionInformation/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>/CreditTransferTransactionInformation[*]/InstructedAgent</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InstructedAgent</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_dv-LFyGnEeKjd4jizyIDGA"
nextVersions="_fTgMPRPeEeSVo-TFVwFHvA"
name="InstructingAgentRule"
definition="If GroupHeader/InstructingAgent is present, then CreditTransferTransactionInformation/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>/CreditTransferTransactionInformation[*]/InstructingAgent</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InstructingAgent</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_dv-LGyGnEeKjd4jizyIDGA"
nextVersions="_fTgMPxPeEeSVo-TFVwFHvA"
name="TotalInterbankSettlementAmountRule"
definition="If GroupHeader/TotalInterbankSettlementAmount is present, then all occurrences of CreditTransferTransactionInformation/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>/CreditTransferTransactionInformation[*]/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="_dv-LHyGnEeKjd4jizyIDGA"
nextVersions="_fTgMQRPeEeSVo-TFVwFHvA"
name="TotalInterbankSettlementAmountAndSumRule"
definition="If GroupHeader/TotalInterbankSettlementAmount is present, then it must equal the sum of all occurrences of CreditTransferTransactionInformation/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 /CreditTransferTransactionInformation/InterbankSettlementAmount</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/TotalInterbankSettlementAmount</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_dv-LIyGnEeKjd4jizyIDGA"
nextVersions="_fTgMQxPeEeSVo-TFVwFHvA"
name="GroupHeaderInterbankSettlementDateRule"
definition="If GroupHeader/InterbankSettlementDate is present, then CreditTransferTransactionInformation/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>/CreditTransferTransactionInformation[*]/InterbankSettlementDate</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/InterbankSettlementDate</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_dv-LJyGnEeKjd4jizyIDGA"
nextVersions="_fTgMRRPeEeSVo-TFVwFHvA"
name="TransactionInterbankSettlementDateRule"
definition="If GroupHeader/InterbankSettlementDate is not present, then CreditTransferTransactionInformation/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>/CreditTransferTransactionInformation[*]/InterbankSettlementDate</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/GroupHeader/InterbankSettlementDate</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_dv-LKyGnEeKjd4jizyIDGA"
nextVersions="_fTgMRxPeEeSVo-TFVwFHvA"
name="PaymentTypeInformationRule"
definition="If GroupHeader/PaymentTypeInformation is present, then CreditTransferTransactionInformation/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>/CreditTransferTransactionInformation[*]/PaymentTypeInformation</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/GroupHeader/PaymentTypeInformation</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>
" />
<constraint
xmi:id="_e7srtyHZEeKGEZlIMFwKzg"
nextVersions="_fTgMSRPeEeSVo-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="_dv-LLyGnEeKjd4jizyIDGA"
nextVersions="_fTgMSxPeEeSVo-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="_s4rLAlkyEeGeoaLUQk__nA_-650190179" />
<messageBuildingBlock
xmi:id="_dv-LMyGnEeKjd4jizyIDGA"
nextVersions="_fTgMTRPeEeSVo-TFVwFHvA"
name="CreditTransferTransactionInformation"
definition="Set of elements providing information specific to the individual credit transfer(s)."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="CdtTrfTxInf"
complexType="_d0zygSHNEeKXpaAk3g3urA" />
<messageBuildingBlock
xmi:id="_dv-LNyGnEeKjd4jizyIDGA"
nextVersions="_fTgMTxPeEeSVo-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="009"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.