pain.001.001.02
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:
- One or more instances of a credit transfer initiation;
- Payment transactions that result in book transfers at the debtor agent or payments to another financial institution;
- Payment transactions that result in an electronic cash transfer to the creditor account or in the emission of a cheque. The message can be used in a direct or a relay scenario:
- In a direct scenario, the message is sent directly to the debtor agent. The debtor agent is the account servicer of the debtor.
- 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. 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. The CustomerCreditTransferInitiation message can be used in domestic and cross-border scenarios. 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. If it is agreed to include the payment information related to the debit side only once (i.e. Grouped mode), the PaymentInformation block will be present only once. If it is agreed to repeat the payment information related to the debit side (i.e. Single mode), the PaymentInformation block must be present once per occurrence of the CreditTransferTransactionInformation block. The CustomerCreditTransferInitiation message also allows for a Mixed mode where the PaymentInformation block can be repeated and each PaymentInformation block can contain one or several CreditTransferTransactionInformation block(s). Single When grouping is set to Single, information for each individual instruction is included separately. This means the PaymentInformation block is repeated, and present for each occurrence of the CreditTransferTransactionInformation block. Grouped When grouping is set to Grouped, the PaymentInformation block will be present once and the CreditTransferTransactionInformation block will be repeated. Mixed When grouping is set to Mixed, the PaymentInformation block may be present once or may be repeated. Each sequence of the PaymentInformation block may contain one or several CreditTransferTransactionInformation block(s).
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 %% CustomerCreditTransferInitiationV02 recursion level 0 with max 0 CustomerCreditTransferInitiationV02 *-- "1..1" GroupHeader1 : GroupHeader CustomerCreditTransferInitiationV02 *-- "1..1" PaymentInstructionInformation1 : PaymentInformation
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Set of characteristics shared by all individual transactions included in the message. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification
classDiagram direction tb %% GroupHeader1 recursion level 0 with max 1 class GroupHeader1{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime Authorisation IsoMax128Text BatchBooking IsoBatchBookingIndicator NumberOfTransactions IsoMax15NumericText ControlSum IsoDecimalNumber Grouping Grouping1Code } GroupHeader1 *-- "1..1" PartyIdentification8 : InitiatingParty GroupHeader1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : ForwardingAgent %% PartyIdentification8 recursion level 1 with max 1 class PartyIdentification8{ Name IsoMax70Text CountryOfResidence CountryCode } PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress PartyIdentification8 *-- "0..1" IParty2Choice : Identification %% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification
GroupHeader1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageIdentification | Point to point reference assigned by the instructing party and sent to the next party in the chain to unambiguously identify the message. | |
CreationDateTime | Date and time at which a (group of) payment instruction(s) was created by the instructing party. | IsoISODateTime - Required 1..1 |
Authorisation | User identification or any user key that allows to check if the initiating party is allowed to initiate transactions from the account specified in the initiation. | |
BatchBooking | Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions in the message is requested. | IsoBatchBookingIndicator - Optional 0..1 |
NumberOfTransactions | Number of individual transactions contained in the message. | IsoMax15NumericText - Required 1..1 |
ControlSum | Total of all individual amounts included in the message, irrespective of currencies. | IsoDecimalNumber - Optional 0..1 |
Grouping | Indicates whether common accounting information in the transaction is included once for all transactions or repeated for each single transaction. | Grouping1Code - Required 1..1 |
InitiatingParty | Party initiating the payment. In the payment context, this can either be the debtor (in a credit transfer), the creditor (in a direct debit), or the party that initiates the payment on behalf of the debtor or creditor. | PartyIdentification8 - Required 1..1 |
ForwardingAgent | Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution. | BranchAndFinancialInstitutionIdentification3 - Optional 0..1 |
PaymentInformation building block
Set of characteristics that applies to the debit side of the payment transactions included in the credit transfer initiation. Set of characteristics that apply to the debit side of the payment transactions included in the credit transfer transaction initiation. For comparison, see the ISO20022 official specification
classDiagram direction tb %% PaymentInstructionInformation1 recursion level 0 with max 1 class PaymentInstructionInformation1{ PaymentInformationIdentification IsoMax35Text PaymentMethod PaymentMethod3Code RequestedExecutionDate IsoISODate PoolingAdjustmentDate IsoISODate ChargeBearer ChargeBearerType1Code } PaymentInstructionInformation1 *-- "0..1" PaymentTypeInformation1 : PaymentTypeInformation PaymentInstructionInformation1 *-- "1..1" PartyIdentification8 : Debtor PaymentInstructionInformation1 *-- "1..1" CashAccount7 : DebtorAccount PaymentInstructionInformation1 *-- "1..1" BranchAndFinancialInstitutionIdentification3 : DebtorAgent PaymentInstructionInformation1 *-- "0..1" CashAccount7 : DebtorAgentAccount PaymentInstructionInformation1 *-- "0..1" PartyIdentification8 : UltimateDebtor PaymentInstructionInformation1 *-- "0..1" CashAccount7 : ChargesAccount PaymentInstructionInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : ChargesAccountAgent PaymentInstructionInformation1 *-- "1..0" CreditTransferTransactionInformation1 : CreditTransferTransactionInformation %% PaymentTypeInformation1 recursion level 1 with max 1 class PaymentTypeInformation1{ InstructionPriority Priority2Code ClearingChannel ClearingChannel2Code CategoryPurpose PaymentCategoryPurpose1Code } PaymentTypeInformation1 *-- "0..1" IServiceLevel2Choice : ServiceLevel PaymentTypeInformation1 *-- "0..1" ILocalInstrument1Choice : LocalInstrument %% PartyIdentification8 recursion level 1 with max 1 class PartyIdentification8{ Name IsoMax70Text CountryOfResidence CountryCode } PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress PartyIdentification8 *-- "0..1" IParty2Choice : Identification %% CashAccount7 recursion level 1 with max 1 class CashAccount7{ Currency CurrencyCode Name IsoMax70Text } CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification CashAccount7 *-- "0..1" CashAccountType2 : Type %% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification %% CashAccount7 recursion level 1 with max 1 class CashAccount7{ Currency CurrencyCode Name IsoMax70Text } CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification CashAccount7 *-- "0..1" CashAccountType2 : Type %% PartyIdentification8 recursion level 1 with max 1 class PartyIdentification8{ Name IsoMax70Text CountryOfResidence CountryCode } PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress PartyIdentification8 *-- "0..1" IParty2Choice : Identification %% CashAccount7 recursion level 1 with max 1 class CashAccount7{ Currency CurrencyCode Name IsoMax70Text } CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification CashAccount7 *-- "0..1" CashAccountType2 : Type %% BranchAndFinancialInstitutionIdentification3 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification3 *-- "1..1" IFinancialInstitutionIdentification5Choice : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification3 *-- "0..1" BranchData : BranchIdentification %% CreditTransferTransactionInformation1 recursion level 1 with max 1 class CreditTransferTransactionInformation1{ ChargeBearer ChargeBearerType1Code InstructionForDebtorAgent IsoMax140Text } CreditTransferTransactionInformation1 *-- "1..1" PaymentIdentification1 : PaymentIdentification CreditTransferTransactionInformation1 *-- "0..1" PaymentTypeInformation1 : PaymentTypeInformation CreditTransferTransactionInformation1 *-- "1..1" IAmountType2Choice : Amount CreditTransferTransactionInformation1 *-- "0..1" ExchangeRateInformation1 : ExchangeRateInformation CreditTransferTransactionInformation1 *-- "0..1" Cheque5 : ChequeInstruction CreditTransferTransactionInformation1 *-- "0..1" PartyIdentification8 : UltimateDebtor CreditTransferTransactionInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : IntermediaryAgent1 CreditTransferTransactionInformation1 *-- "0..1" CashAccount7 : IntermediaryAgent1Account CreditTransferTransactionInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : IntermediaryAgent2 CreditTransferTransactionInformation1 *-- "0..1" CashAccount7 : IntermediaryAgent2Account CreditTransferTransactionInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : IntermediaryAgent3 CreditTransferTransactionInformation1 *-- "0..1" CashAccount7 : IntermediaryAgent3Account CreditTransferTransactionInformation1 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : CreditorAgent CreditTransferTransactionInformation1 *-- "0..1" CashAccount7 : CreditorAgentAccount CreditTransferTransactionInformation1 *-- "0..1" PartyIdentification8 : Creditor CreditTransferTransactionInformation1 *-- "0..1" CashAccount7 : CreditorAccount CreditTransferTransactionInformation1 *-- "0..1" PartyIdentification8 : UltimateCreditor CreditTransferTransactionInformation1 *-- "0..0" InstructionForCreditorAgent1 : InstructionForCreditorAgent CreditTransferTransactionInformation1 *-- "0..1" IPurpose1Choice : Purpose CreditTransferTransactionInformation1 *-- "0..10" RegulatoryReporting2 : RegulatoryReporting CreditTransferTransactionInformation1 *-- "0..1" TaxInformation2 : Tax CreditTransferTransactionInformation1 *-- "0..10" RemittanceLocation1 : RelatedRemittanceInformation CreditTransferTransactionInformation1 *-- "0..1" RemittanceInformation1 : RemittanceInformation
PaymentInstructionInformation1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PaymentInformationIdentification | Reference assigned by a sending party to unambiguously identify the payment information block within the message. | IsoMax35Text - Optional 0..1 |
PaymentMethod | Specifies the means of payment that will be used to move the amount of money. | PaymentMethod3Code - Required 1..1 |
PaymentTypeInformation | Set of elements used to further specify the type of transaction. | PaymentTypeInformation1 - Optional 0..1 |
RequestedExecutionDate | Date at which the initiating party requests the clearing agent to process the payment. 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. | PartyIdentification8 - 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. | CashAccount7 - Required 1..1 |
DebtorAgent | Financial institution servicing an account for the debtor. | BranchAndFinancialInstitutionIdentification3 - Required 1..1 |
DebtorAgentAccount | Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. | CashAccount7 - Optional 0..1 |
UltimateDebtor | Ultimate party that owes an amount of money to the (ultimate) creditor. | PartyIdentification8 - Optional 0..1 |
ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction. | ChargeBearerType1Code - Optional 0..1 |
ChargesAccount | Account used to process charges associated with a transaction. | |
ChargesAccountAgent | Agent that services a charges account. | |
CreditTransferTransactionInformation | Set of elements providing information specific to the individual transaction(s) included in the message. | CreditTransferTransactionInformation1 - Unknown 1..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the CustomerCreditTransferInitiationV02 implementation follows a specific implementaiton pattern. First of all, CustomerCreditTransferInitiationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CustomerCreditTransferInitiationV02Document implements IOuterDocument. Because CustomerCreditTransferInitiationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CustomerCreditTransferInitiationV02.
classDiagram class IOuterRecord CustomerCreditTransferInitiationV02 --|> IOuterRecord : Implements CustomerCreditTransferInitiationV02Document --|> IOuterDocument~CustomerCreditTransferInitiationV02~ : Implements class IOuterDocument~CustomerCreditTransferInitiationV02~ { CustomerCreditTransferInitiationV02 Message }
Document wrapper for serialization
The only real purpose CustomerCreditTransferInitiationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.001.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CustomerCreditTransferInitiationV02.ToDocument() method. The returned CustomerCreditTransferInitiationV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram CustomerCreditTransferInitiationV02Document *-- CustomerCreditTransferInitiationV02 : 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.02">
<pain.001.001.02>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<PmtInf>
<!-- PaymentInformation inner content -->
</PmtInf>
</pain.001.001.02>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_GWb0ldEvEd-BzquC8wXy7w_1535349168"
nextVersions="_GWk-idEvEd-BzquC8wXy7w_-923555762"
name="CustomerCreditTransferInitiationV02"
definition="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:
- One or more instances of a credit transfer initiation;
- Payment transactions that result in book transfers at the debtor agent or payments to another financial institution;
- Payment transactions that result in an electronic cash transfer to the creditor account or in the emission of a cheque.
The message can be used in a direct or a relay scenario:
- In a direct scenario, the message is sent directly to the debtor agent. The debtor agent is the account servicer of the debtor.
- 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.
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.
The CustomerCreditTransferInitiation message can be used in domestic and cross-border scenarios.
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.
If it is agreed to include the payment information related to the debit side only once (i.e. Grouped mode), the PaymentInformation block will be present only once.
If it is agreed to repeat the payment information related to the debit side (i.e. Single mode), the PaymentInformation block must be present once per occurrence of the CreditTransferTransactionInformation block.
The CustomerCreditTransferInitiation message also allows for a Mixed mode where the PaymentInformation block can be repeated and each PaymentInformation block can contain one or several CreditTransferTransactionInformation block(s).
Single
When grouping is set to Single, information for each individual instruction is included separately. This means the
PaymentInformation block is repeated, and present for each occurrence of the CreditTransferTransactionInformation block.
Grouped
When grouping is set to Grouped, the PaymentInformation block will be present once and the CreditTransferTransactionInformation block will be repeated.
Mixed
When grouping is set to Mixed, the PaymentInformation block may be present once or may be repeated. Each sequence
of the PaymentInformation block may contain one or several CreditTransferTransactionInformation block(s)."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlName="pain.001.001.02"
xmlTag="pain.001.001.02"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_GWb0mNEvEd-BzquC8wXy7w_1536269348"
name="Grouping1Rule"
definition="If GroupHeader/Grouping is present and equals GRPD, then one and only one occurrence of PaymentInformation must be present."
registrationStatus="Provisionally Registered" />
<constraint
xmi:id="_GWb0m9EvEd-BzquC8wXy7w_1536269373"
name="Grouping2Rule"
definition="If GroupHeader/Grouping is present and equals SNGL, then each occurrence of PaymentInformation must contain one and only one occurrence of PaymentInformation/CreditTransferTransactionInformation."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_GWb0ltEvEd-BzquC8wXy7w_1535349187"
name="GroupHeader"
definition="Set of characteristics shared by all individual transactions included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_PvMh4tp-Ed-ak6NoX_4Aeg_-279444335" />
<messageBuildingBlock
xmi:id="_GWb0l9EvEd-BzquC8wXy7w_1536269287"
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="_PhfdE9p-Ed-ak6NoX_4Aeg_-259128313" />
<messageDefinitionIdentifier
businessArea="pain"
messageFunctionality="001"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.