Iso20022

CustomerCreditTransferInitiationV10

pain.001.001.10

Scope The CustomerCreditTransferInitiation message is sent by the initiating party to the forwarding agent or debtor agent. It is used to request movement of funds from the debtor account to a creditor. Usage The CustomerCreditTransferInitiation message can contain one or more customer credit transfer instructions. The CustomerCreditTransferInitiation message is used to exchange:

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

GroupHeader95 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.
NumberOfTransactions Number of individual transactions contained in the message. IsoMax15NumericText - Required 1..1
ControlSum Total of all individual amounts included in the message, irrespective of currencies. IsoDecimalNumber - Optional 0..1
InitiatingParty Party that initiates the payment.
ForwardingAgent Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution. BranchAndFinancialInstitutionIdentification6 - Optional 0..1
InitiationSource Source application or software used to initiate the payment. PaymentInitiationSource1 - Optional 0..1

PaymentInformation building block

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

classDiagram
   direction tb
%% PaymentInstruction34 recursion level 0 with max 1
class PaymentInstruction34{
    PaymentInformationIdentification IsoMax35Text
    PaymentMethod PaymentMethod3Code
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    PoolingAdjustmentDate IsoISODate
    InstructionForDebtorAgent IsoMax140Text
    ChargeBearer ChargeBearerType1Code
}
PaymentInstruction34 *-- "0..1" AdviceType1 : RequestedAdviceType
PaymentInstruction34 *-- "0..1" PaymentTypeInformation26 : PaymentTypeInformation
PaymentInstruction34 *-- "1..1" IDateAndDateTime2Choice : RequestedExecutionDate
PaymentInstruction34 *-- "1..1" PartyIdentification135 : Debtor
PaymentInstruction34 *-- "1..1" CashAccount38 : DebtorAccount
PaymentInstruction34 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
PaymentInstruction34 *-- "0..1" CashAccount38 : DebtorAgentAccount
PaymentInstruction34 *-- "0..1" PartyIdentification135 : UltimateDebtor
PaymentInstruction34 *-- "0..1" CashAccount38 : ChargesAccount
PaymentInstruction34 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ChargesAccountAgent
PaymentInstruction34 *-- "1..0" CreditTransferTransaction40 : CreditTransferTransactionInformation
%% AdviceType1 recursion level 1 with max 1
AdviceType1 *-- "0..1" IAdviceType1Choice : CreditAdvice
AdviceType1 *-- "0..1" IAdviceType1Choice : DebitAdvice
%% PaymentTypeInformation26 recursion level 1 with max 1
class PaymentTypeInformation26{
    InstructionPriority Priority2Code
}
PaymentTypeInformation26 *-- "0..0" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation26 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation26 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% CashAccount38 recursion level 1 with max 1
class CashAccount38{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount38 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount38 *-- "0..1" ICashAccountType2Choice : Type
CashAccount38 *-- "0..1" ProxyAccountIdentification1 : Proxy
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% CashAccount38 recursion level 1 with max 1
class CashAccount38{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount38 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount38 *-- "0..1" ICashAccountType2Choice : Type
CashAccount38 *-- "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
%% CashAccount38 recursion level 1 with max 1
class CashAccount38{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount38 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount38 *-- "0..1" ICashAccountType2Choice : Type
CashAccount38 *-- "0..1" ProxyAccountIdentification1 : Proxy
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% CreditTransferTransaction40 recursion level 1 with max 1
class CreditTransferTransaction40{
    ChargeBearer ChargeBearerType1Code
}
CreditTransferTransaction40 *-- "1..1" PaymentIdentification6 : PaymentIdentification
CreditTransferTransaction40 *-- "0..1" PaymentTypeInformation26 : PaymentTypeInformation
CreditTransferTransaction40 *-- "1..1" IAmountType4Choice : Amount
CreditTransferTransaction40 *-- "0..1" ExchangeRate1 : ExchangeRateInformation
CreditTransferTransaction40 *-- "0..1" CreditTransferMandateData1 : MandateRelatedInformation
CreditTransferTransaction40 *-- "0..1" Cheque11 : ChequeInstruction
CreditTransferTransaction40 *-- "0..1" PartyIdentification135 : UltimateDebtor
CreditTransferTransaction40 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent1
CreditTransferTransaction40 *-- "0..1" CashAccount38 : IntermediaryAgent1Account
CreditTransferTransaction40 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent2
CreditTransferTransaction40 *-- "0..1" CashAccount38 : IntermediaryAgent2Account
CreditTransferTransaction40 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent3
CreditTransferTransaction40 *-- "0..1" CashAccount38 : IntermediaryAgent3Account
CreditTransferTransaction40 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent
CreditTransferTransaction40 *-- "0..1" CashAccount38 : CreditorAgentAccount
CreditTransferTransaction40 *-- "0..1" PartyIdentification135 : Creditor
CreditTransferTransaction40 *-- "0..1" CashAccount38 : CreditorAccount
CreditTransferTransaction40 *-- "0..1" PartyIdentification135 : UltimateCreditor
CreditTransferTransaction40 *-- "0..0" InstructionForCreditorAgent3 : InstructionForCreditorAgent
CreditTransferTransaction40 *-- "0..1" InstructionForDebtorAgent1 : InstructionForDebtorAgent
CreditTransferTransaction40 *-- "0..1" IPurpose2Choice : Purpose
CreditTransferTransaction40 *-- "0..10" RegulatoryReporting3 : RegulatoryReporting
CreditTransferTransaction40 *-- "0..1" TaxInformation8 : Tax
CreditTransferTransaction40 *-- "0..10" RemittanceLocation7 : RelatedRemittanceInformation
CreditTransferTransaction40 *-- "0..1" RemittanceInformation16 : RemittanceInformation
CreditTransferTransaction40 *-- "0..0" SupplementaryData1 : SupplementaryData

PaymentInstruction34 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. PaymentMethod3Code - Required 1..1
RequestedAdviceType Type of advice details requested. AdviceType1 - Optional 0..1
BatchBooking Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested. Usage: Batch booking is used to request and not order a possible batch booking.
NumberOfTransactions Number of individual transactions contained in the payment information group. IsoMax15NumericText - Optional 0..1
ControlSum Total of all individual amounts included in the group, irrespective of currencies. IsoDecimalNumber - Optional 0..1
PaymentTypeInformation Set of elements used to further specify the type of transaction. PaymentTypeInformation26 - Optional 0..1
RequestedExecutionDate Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor’s account is to be debited. If payment by cheque, the date when the cheque must be generated by the bank.
PoolingAdjustmentDate Date used for the correction of the value date of a cash pool movement that has been posted with a different value date. IsoISODate - 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. CashAccount38 - 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. CashAccount38 - Optional 0..1
InstructionForDebtorAgent Further information related to the processing of the payment instruction, that may need to be acted upon by the debtor agent, depending on agreement between debtor and the debtor agent. Usage: when present, then the instructions for the debtor agent apply for all credit transfer transaction information occurrences, present in the payment information. IsoMax140Text - Optional 0..1
UltimateDebtor Ultimate party that owes an amount of money to the (ultimate) creditor. PartyIdentification135 - Optional 0..1
ChargeBearer Specifies which party/parties will bear the charges associated with the processing of the payment transaction. ChargeBearerType1Code - Optional 0..1
ChargesAccount Account used to process charges associated with a transaction.
ChargesAccountAgent Agent that services a charges account.
CreditTransferTransactionInformation Provides information on the individual transaction(s) included in the message. CreditTransferTransaction40 - Unknown 1..0

SupplementaryData building block

Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1

SupplementaryData1 members

Member name Description Data Type / Multiplicity
PlaceAndName Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. IsoMax350Text - Optional 0..1
Envelope Technical element wrapping the supplementary data. IsoSupplementaryDataEnvelope1 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CustomerCreditTransferInitiationV10 --|> IOuterRecord : Implements
    CustomerCreditTransferInitiationV10Document --|> IOuterDocument~CustomerCreditTransferInitiationV10~ : Implements
    class IOuterDocument~CustomerCreditTransferInitiationV10~ {
        CustomerCreditTransferInitiationV10 Message
     }

Document wrapper for serialization

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

classDiagram
    CustomerCreditTransferInitiationV10Document *-- CustomerCreditTransferInitiationV10 : 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.001.001.10">
    <CstmrCdtTrfInitn>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <PmtInf>
            <!-- PaymentInformation inner content -->
        </PmtInf>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CstmrCdtTrfInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_LwD3L8P_Eemsic1bQcEtLA"
  nextVersions="_rUXmwdcBEeq_l4BJLVUF2Q"
  previousVersion="_eYI_qW2PEei3KuUgpx7Xcw"
  name="CustomerCreditTransferInitiationV10"
  definition="Scope&#xD;&#xA;The CustomerCreditTransferInitiation message is sent by the initiating party to the forwarding agent or debtor agent. It is used to request movement of funds from the debtor account to a creditor.&#xD;&#xA;Usage&#xD;&#xA;The CustomerCreditTransferInitiation message can contain one or more customer credit transfer instructions.&#xD;&#xA;The CustomerCreditTransferInitiation message is used to exchange:&#xD;&#xA;- One or more instances of a credit transfer initiation;&#xD;&#xA;- Payment transactions that result in book transfers at the debtor agent or payments to another financial institution;&#xD;&#xA;- Payment transactions that result in an electronic cash transfer to the creditor account or in the emission of a cheque.&#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 debtor agent. The debtor agent is the account servicer of the debtor.&#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 CustomerCreditTransferInitiation message to the debtor agent.&#xD;&#xA;The message can also be used by an initiating party that has authority to send the message on behalf of the debtor. This caters for example for the scenario of a payments factory initiating all payments on behalf of a large corporate.&#xD;&#xA;The CustomerCreditTransferInitiation message can be used in domestic and cross-border scenarios.&#xD;&#xA;The CustomerCreditTransferInitiation message must not be used by the debtor agent to execute the credit transfer instruction(s). The FIToFICustomerCreditTransfer message must be used instead."
  registrationStatus="Registered"
  messageSet="_wRx2wE2rEeG_I4xRYCA_7g"
  xmlTag="CstmrCdtTrfInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_LwD3McP_Eemsic1bQcEtLA"
    nextVersions="_rUXmw9cBEeq_l4BJLVUF2Q"
    previousVersion="_eYI_q22PEei3KuUgpx7Xcw"
    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="_LwD3N8P_Eemsic1bQcEtLA"
    nextVersions="_rUXmydcBEeq_l4BJLVUF2Q"
    previousVersion="_eYI_rW2PEei3KuUgpx7Xcw"
    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="_I9mVkcQKEemsic1bQcEtLA" />
  <messageBuildingBlock
    xmi:id="_LwD3OcP_Eemsic1bQcEtLA"
    nextVersions="_rUXmy9cBEeq_l4BJLVUF2Q"
    previousVersion="_eYI_r22PEei3KuUgpx7Xcw"
    name="PaymentInformation"
    definition="Set of characteristics that applies to the debit side of the payment transactions included in the credit transfer initiation."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="PmtInf"
    complexType="_O4kqwcQAEemsic1bQcEtLA" />
  <messageBuildingBlock
    xmi:id="_LwD3O8P_Eemsic1bQcEtLA"
    nextVersions="_rUXmzdcBEeq_l4BJLVUF2Q"
    previousVersion="_eYI_sW2PEei3KuUgpx7Xcw"
    name="SupplementaryData"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="pain"
    messageFunctionality="001"
    flavour="001"
    version="10" />
</messageDefinition>

ISO Building Blocks

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