camt.106.001.01
The ChargesPaymentRequest message is sent by a financial institution to another financial institution to request the payment of charges, interest and/or other expenses which are previously unknown to the receiver.
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
%% ChargesPaymentRequestV01 recursion level 0 with max 0
ChargesPaymentRequestV01 *-- "1..1" GroupHeader102 : GroupHeader
ChargesPaymentRequestV01 *-- "1..1" ChargesRecord5 : Charges
ChargesPaymentRequestV01 *-- "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 charges records included in the message. Set of characteristics shared by all individual charges records included in the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% GroupHeader102 recursion level 0 with max 1
class GroupHeader102{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
NumberOfChargesRecords IsoMax15NumericText
ControlSum IsoDecimalNumber
TotalChargesAmount IsoActiveCurrencyAndAmount
}
GroupHeader102 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 |
| NumberOfChargesRecords | Number of individual charges record 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 |
| TotalChargesAmount | Total amount of charges claimed through this message. | IsoActiveCurrencyAndAmount - Optional 0..1 |
Charges building block
Provides information on the charges to be paid by the charge bearer(s) related to the processing of the underlying transaction. Provides further individual record details on the charges related to the payment transaction. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ChargesRecord5 recursion level 0 with max 1
class ChargesRecord5{
ChargesRecordIdentification IsoMax35Text
Amount IsoActiveCurrencyAndAmount
CreditDebitIndicator CreditDebitCode
AdditionalInformation IsoMax140Text
}
ChargesRecord5 *-- "1..0" TransactionReferences7 : UnderlyingTransaction
ChargesRecord5 *-- "0..1" IDateAndDateTime2Choice : ValueDate
ChargesRecord5 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
ChargesRecord5 *-- "0..1" CashAccount40 : DebtorAgentAccount
ChargesRecord5 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ChargesAccountAgent
ChargesRecord5 *-- "0..1" CashAccount40 : ChargesAccountAgentAccount
ChargesRecord5 *-- "0..1" IChargeType3Choice : Type
ChargesRecord5 *-- "0..1" InstructionForInstructedAgent1 : InstructionForInstructedAgent
%% TransactionReferences7 recursion level 1 with max 1
class TransactionReferences7{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
AccountServicerReference IsoMax35Text
PaymentInformationIdentification IsoMax35Text
InstructionIdentification IsoMax35Text
EndToEndIdentification IsoMax35Text
UETR IsoUUIDv4Identifier
TransactionIdentification IsoMax35Text
MandateIdentification IsoMax35Text
ChequeNumber IsoMax35Text
ClearingSystemReference IsoMax35Text
AccountOwnerTransactionIdentification IsoMax35Text
AccountServicerTransactionIdentification IsoMax35Text
MarketInfrastructureTransactionIdentification IsoMax35Text
ProcessingIdentification IsoMax35Text
}
TransactionReferences7 *-- "0..0" ProprietaryReference1 : Proprietary
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% 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
%% IChargeType3Choice recursion level 1 with max 1
%% InstructionForInstructedAgent1 recursion level 1 with max 1
class InstructionForInstructedAgent1{
Code ExternalInstructedAgentInstruction1Code
InstructionInformation IsoMax140Text
}
ChargesRecord5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ChargesRecordIdentification | Unique and unambiguous identification of the charges record for reconciliation purpose. Usage: this identification shall be used as the end-to-end identification in the resulting message for the payment of the charges, to allow for automated reconciliation. | IsoMax35Text - Optional 0..1 |
| UnderlyingTransaction | Identifies the underlying transaction(s) to which the charges apply. | TransactionReferences7 - Unknown 1..0 |
| Amount | Amount of transaction charges to be paid by the charge bearer. | IsoActiveCurrencyAndAmount - Required 1..1 |
| CreditDebitIndicator | Indicates whether the charges amount is a credit or a debit amount. | Usage: A zero amount is considered to be a credit. |
| ValueDate | Date and time at which the charges are or will be available. | IDateAndDateTime2Choice - Optional 0..1 |
| DebtorAgent | Specifies the debtor agent of the initial transaction, if different from the charges account owner. | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
| DebtorAgentAccount | Specifies the account of the debtor agent of the initial transaction, when instructing agent is different from the charges account owner. | CashAccount40 - Optional 0..1 |
| ChargesAccountAgent | Agent that services the charges account. | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
| ChargesAccountAgentAccount | Account of the agent that services the charges account. | CashAccount40 - Optional 0..1 |
| Type | Specifies the type of charge. | IChargeType3Choice - Optional 0..1 |
| InstructionForInstructedAgent | Further information related to the processing of the payment adjustment instruction that may need to be acted upon by the next agent. | InstructionForInstructedAgent1 - Optional 0..1 |
| AdditionalInformation | Further details on the cancellation request reason. | IsoMax140Text - Optional 0..1 |
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 ChargesPaymentRequestV01 implementation follows a specific implementaiton pattern. First of all, ChargesPaymentRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ChargesPaymentRequestV01Document implements IOuterDocument. Because ChargesPaymentRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ChargesPaymentRequestV01.
classDiagram
class IOuterRecord
ChargesPaymentRequestV01 --|> IOuterRecord : Implements
ChargesPaymentRequestV01Document --|> IOuterDocument~ChargesPaymentRequestV01~ : Implements
class IOuterDocument~ChargesPaymentRequestV01~ {
ChargesPaymentRequestV01 Message
}
Document wrapper for serialization
The only real purpose ChargesPaymentRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.106.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ChargesPaymentRequestV01.ToDocument() method. The returned ChargesPaymentRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ChargesPaymentRequestV01Document *-- ChargesPaymentRequestV01 : 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:camt.106.001.01">
<ChrgsPmtReq>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Chrgs>
<!-- Charges inner content -->
</Chrgs>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</ChrgsPmtReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Q2jcwKdBEeqY6dwgI6s5vg"
name="ChargesPaymentRequestV01"
definition="The ChargesPaymentRequest message is sent by a financial institution to another financial institution to request the payment of charges, interest and/or other expenses which are previously unknown to the receiver."
registrationStatus="Registered"
messageSet="_WcSv0LR_Eeq3lpO-mRtrig"
xmlTag="ChrgsPmtReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jGeDASkYEeuBrrgCSpsocg"
name="GroupHeader"
definition="Set of characteristics shared by all individual charges records included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_mjXnuSkYEeuBrrgCSpsocg" />
<messageBuildingBlock
xmi:id="_5ShVQKdBEeqY6dwgI6s5vg"
name="Charges"
definition="Provides information on the charges to be paid by the charge bearer(s) related to the processing of the underlying transaction."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Chrgs"
complexType="_n3siQbt7Eeq_cfXrH83Rcw" />
<messageBuildingBlock
xmi:id="_fu1SMbR_Eeq3lpO-mRtrig"
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="camt"
messageFunctionality="106"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.