camt.109.001.01
The ChequeCancellationOrStopReport message is sent by the drawee agent (on which a cheque is drawn) to the drawer agent or the agent acting on behalf of the drawer agent to indicate what actions have been taken in attempting to cancel the presentment and/or stop the payment of the cheque referred to in the message.
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
%% ChequeCancellationOrStopReportV01 recursion level 0 with max 0
ChequeCancellationOrStopReportV01 *-- "1..1" GroupHeader103 : GroupHeader
ChequeCancellationOrStopReportV01 *-- "1..1" Cheque14 : Cheque
ChequeCancellationOrStopReportV01 *-- "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 cheques included in the message. Set of characteristics shared by all individual cheques included in the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% GroupHeader103 recursion level 0 with max 1
class GroupHeader103{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
NumberOfCheques IsoMax15NumericText
ControlSum IsoDecimalNumber
}
GroupHeader103 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 |
| NumberOfCheques | Number of individual cheques 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 |
Cheque building block
Specifies the details of the cheque. Characteristics of a cheque instruction, such as cheque type or cheque number. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Cheque14 recursion level 0 with max 1
class Cheque14{
InstructionIdentification IsoMax35Text
OriginalInstructionIdentification IsoMax35Text
ChequeNumber IsoMax35Text
IssueDate IsoISODate
StaleDate IsoISODate
Amount IsoActiveCurrencyAndAmount
}
Cheque14 *-- "0..1" IDateAndDateTime2Choice : EffectiveDate
Cheque14 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : DrawerAgent
Cheque14 *-- "0..1" CashAccount40 : DrawerAgentAccount
Cheque14 *-- "0..1" PartyIdentification135 : Payee
Cheque14 *-- "0..1" CashAccount40 : PayeeAccount
Cheque14 *-- "1..1" ChequeCancellationStatus1 : ChequeCancellationOrStopStatus
%% 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
%% 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
%% ChequeCancellationStatus1 recursion level 1 with max 1
class ChequeCancellationStatus1{
Originator ChequePartyRole1Code
AdditionalInformation IsoMax140Text
}
ChequeCancellationStatus1 *-- "1..1" IChequeCancellationStatus1Choice : Status
Cheque14 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| InstructionIdentification | Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Usage: The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. | IsoMax35Text - Optional 0..1 |
| OriginalInstructionIdentification | Unique identification, as assigned by the original instructing party for the original instructed party, to unambiguously identify the original instruction. | IsoMax35Text - Optional 0..1 |
| ChequeNumber | Unique and unambiguous identifier for a cheque as assigned by the agent. | IsoMax35Text - Required 1..1 |
| IssueDate | Date when the cheque has been issued by the payer. | IsoISODate - Required 1..1 |
| StaleDate | Date after which a cheque is no longer valid. The validity period of a cheque is calculated from the issue date on the face of the cheque. The period may be indicated on the face of the cheque itself such as “Valid for 90 days” or may be determined in accordance with domestic banking practice. Not all countries will have a validity period. | IsoISODate - Optional 0..1 |
| Amount | Specifies the amount of the cheque to be paid to the payee. | IsoActiveCurrencyAndAmount - Required 1..1 |
| EffectiveDate | Date and time at which the cheque amount becomes available on the payee account. | IDateAndDateTime2Choice - Optional 0..1 |
| DrawerAgent | Specifies the agent servicing the account of the cheque payer. | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
| DrawerAgentAccount | Specifies the cash account of the drawer agent. | CashAccount40 - Optional 0..1 |
| Payee | Party that receives an amount of money as specified in the cheque. | PartyIdentification135 - Optional 0..1 |
| PayeeAccount | Specifies the cash account of the payee. | CashAccount40 - Optional 0..1 |
| ChequeCancellationOrStopStatus | Specifies the status of the cancellation or stop request. | ChequeCancellationStatus1 - Required 1..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 ChequeCancellationOrStopReportV01 implementation follows a specific implementaiton pattern. First of all, ChequeCancellationOrStopReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ChequeCancellationOrStopReportV01Document implements IOuterDocument. Because ChequeCancellationOrStopReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ChequeCancellationOrStopReportV01.
classDiagram
class IOuterRecord
ChequeCancellationOrStopReportV01 --|> IOuterRecord : Implements
ChequeCancellationOrStopReportV01Document --|> IOuterDocument~ChequeCancellationOrStopReportV01~ : Implements
class IOuterDocument~ChequeCancellationOrStopReportV01~ {
ChequeCancellationOrStopReportV01 Message
}
Document wrapper for serialization
The only real purpose ChequeCancellationOrStopReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.109.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ChequeCancellationOrStopReportV01.ToDocument() method. The returned ChequeCancellationOrStopReportV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ChequeCancellationOrStopReportV01Document *-- ChequeCancellationOrStopReportV01 : 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.109.001.01">
<ChqCxlOrStopRpt>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Chq>
<!-- Cheque inner content -->
</Chq>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</ChqCxlOrStopRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_QUITMbSJEeq3lpO-mRtrig"
name="ChequeCancellationOrStopReportV01"
definition="The ChequeCancellationOrStopReport message is sent by the drawee agent (on which a cheque is drawn) to the drawer agent or the agent acting on behalf of the drawer agent to indicate what actions have been taken in attempting to cancel the presentment and/or stop the payment of the cheque referred to in the message."
registrationStatus="Registered"
messageSet="_2sR2NLfJEeuDTOqGwU_8EQ"
xmlTag="ChqCxlOrStopRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_GewUESm6EeutWNGMV2XKIQ"
name="GroupHeader"
definition="Set of characteristics shared by all individual cheques included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_cY2s8btmEeq_cfXrH83Rcw" />
<messageBuildingBlock
xmi:id="_s-k9grtwEeq_cfXrH83Rcw"
name="Cheque"
definition="Specifies the details of the cheque."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Chq"
complexType="_cRHMkbtuEeq_cfXrH83Rcw" />
<messageBuildingBlock
xmi:id="_Vgrws7tlEeq_cfXrH83Rcw"
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="109"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.