AccountSwitchCancelExistingPaymentV02

acmt.029.001.02

The AccountSwitchCancelExistingPayment message is sent by the new account servicer to the previous account servicer to identify which payment arrangements are to be cancelled on the account owner’s account and when they are to be cancelled. This message is used during a partial switch of the account and may be sent multiple times to allow for the account parties to transfer different payment arrangements at different times during the switch.

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
%% AccountSwitchCancelExistingPaymentV02 recursion level 0 with max 0
AccountSwitchCancelExistingPaymentV02 *-- "1..1" MessageIdentification1 : MessageIdentification
AccountSwitchCancelExistingPaymentV02 *-- "1..1" AccountSwitchDetails1 : AccountSwitchDetails
AccountSwitchCancelExistingPaymentV02 *-- "1..1" CashAccount39 : OldAccount
AccountSwitchCancelExistingPaymentV02 *-- "0..1" PaymentInstruction28 : PaymentInstruction
AccountSwitchCancelExistingPaymentV02 *-- "0..1" DirectDebitInstructionDetails2 : DirectDebitInstruction
AccountSwitchCancelExistingPaymentV02 *-- "0..1" SupplementaryData1 : SupplementaryData
  

Now, we will zero-in one-by-one on each of these building blocks.

MessageIdentification building block

Unique identification for the message. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 members

AccountSwitchDetails building block

Contains information about the details of the account switch. Details of the account switch, including its status and any response codes. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AccountSwitchDetails1 recursion level 0 with max 1
class AccountSwitchDetails1{
    UniqueReferenceNumber IsoMax35Text
    RoutingUniqueReferenceNumber IsoMax35Text
    SwitchReceivedDateTime IsoISODateTime
    SwitchDate IsoISODate
    SwitchType SwitchType1Code
    SwitchStatus SwitchStatus1Code
    BalanceTransferWindow BalanceTransferWindow1Code
}
AccountSwitchDetails1 *-- "0..0" ResponseDetails1 : Response
%% ResponseDetails1 recursion level 1 with max 1
class ResponseDetails1{
    ResponseCode IsoMax35Text
    AdditionalDetails IsoMax350Text
}
  

AccountSwitchDetails1 members

OldAccount building block

Details of the old account. Provides the details to identify an account. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CashAccount39 recursion level 0 with max 1
class CashAccount39{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount39 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount39 *-- "0..1" ICashAccountType2Choice : Type
CashAccount39 *-- "0..1" ProxyAccountIdentification1 : Proxy
CashAccount39 *-- "0..1" PartyIdentification135 : Owner
CashAccount39 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : Servicer
%% IAccountIdentification4Choice recursion level 1 with max 1
%% ICashAccountType2Choice recursion level 1 with max 1
%% ProxyAccountIdentification1 recursion level 1 with max 1
class ProxyAccountIdentification1{
    Identification IsoMax2048Text
}
ProxyAccountIdentification1 *-- "0..1" IProxyAccountType1Choice : Type
%% 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
  

CashAccount39 members

PaymentInstruction building block

Details of a debit payment arrangement associated with the old account. The payment may be a standing order, a bill payment arrangement or a future dated payment. 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
%% PaymentInstruction28 recursion level 0 with max 1
class PaymentInstruction28{
    PaymentInformationIdentification IsoMax35Text
    PaymentMethod PaymentMethod3Code
    BatchBooking IsoBatchBookingIndicator
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    RequestedExecutionDate IsoISODate
    PoolingAdjustmentDate IsoISODate
    InstructionForDebtorAgent IsoMax140Text
    ChargeBearer ChargeBearerType1Code
}
PaymentInstruction28 *-- "0..1" PaymentTypeInformation26 : PaymentTypeInformation
PaymentInstruction28 *-- "1..1" PartyIdentification135 : Debtor
PaymentInstruction28 *-- "1..1" CashAccount38 : DebtorAccount
PaymentInstruction28 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
PaymentInstruction28 *-- "0..1" CashAccount38 : DebtorAgentAccount
PaymentInstruction28 *-- "0..1" PartyIdentification135 : UltimateDebtor
PaymentInstruction28 *-- "0..1" CashAccount38 : ChargesAccount
PaymentInstruction28 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ChargesAccountAgent
PaymentInstruction28 *-- "1..0" CreditTransferTransaction33 : CreditTransferTransactionInformation
%% 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
%% 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
%% CreditTransferTransaction33 recursion level 1 with max 1
class CreditTransferTransaction33{
    TaxRateMarker TaxRateMarker1Code
    Amount IsoActiveCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
}
CreditTransferTransaction33 *-- "1..1" PaymentIdentification6 : PaymentIdentification
CreditTransferTransaction33 *-- "0..1" PaymentTypeInformation26 : PaymentTypeInformation
CreditTransferTransaction33 *-- "0..1" Cheque11 : ChequeInstruction
CreditTransferTransaction33 *-- "0..1" Frequency1 : Frequency
CreditTransferTransaction33 *-- "0..1" TransferInstruction1 : TransferInstruction
CreditTransferTransaction33 *-- "0..1" PartyIdentification135 : UltimateDebtor
CreditTransferTransaction33 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent1
CreditTransferTransaction33 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent2
CreditTransferTransaction33 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent3
CreditTransferTransaction33 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent
CreditTransferTransaction33 *-- "0..1" PartyIdentification135 : Creditor
CreditTransferTransaction33 *-- "0..1" CashAccount38 : CreditorAccount
CreditTransferTransaction33 *-- "0..1" PartyIdentification135 : UltimateCreditor
CreditTransferTransaction33 *-- "0..0" InstructionForCreditorAgent1 : InstructionForCreditorAgent
CreditTransferTransaction33 *-- "0..1" IPurpose2Choice : Purpose
CreditTransferTransaction33 *-- "0..10" RegulatoryReporting3 : RegulatoryReporting
CreditTransferTransaction33 *-- "0..1" TaxInformation8 : Tax
CreditTransferTransaction33 *-- "0..10" RemittanceLocation6 : RelatedRemittanceInformation
CreditTransferTransaction33 *-- "0..1" RemittanceInformation16 : RemittanceInformation
  

PaymentInstruction28 members

DirectDebitInstruction building block

Details of a direct debit Instruction associated with the old account. Instructions, initiated by the creditor, to debit a debtor’s account in favour of the creditor. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DirectDebitInstructionDetails2 recursion level 0 with max 1
class DirectDebitInstructionDetails2{
    MandateIdentification IsoMax35Text
    AutomatedDirectDebitInstructionIndicator IsoYesNoIndicator
    DirectDebitTransferableIndicator IsoYesNoIndicator
    LastCollectionCurrencyAmount IsoActiveOrHistoricCurrencyAndAmount
    LastCollectionDate IsoISODate
}
DirectDebitInstructionDetails2 *-- "1..1" PartyIdentification135 : Creditor
DirectDebitInstructionDetails2 *-- "0..0" TransferInstruction1 : OtherDetails
%% 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
%% TransferInstruction1 recursion level 1 with max 1
class TransferInstruction1{
    TransferIndicator IsoYesNoIndicator
    Code IsoMax35Text
    Proprietary IsoMax256Text
    StartDateTime IsoISODateTime
    StartDate IsoISODate
    Description IsoMax350Text
}
  

DirectDebitInstructionDetails2 members

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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AccountSwitchCancelExistingPaymentV02 --|> IOuterRecord : Implements
    AccountSwitchCancelExistingPaymentV02Document --|> IOuterDocument~AccountSwitchCancelExistingPaymentV02~ : Implements
    class IOuterDocument~AccountSwitchCancelExistingPaymentV02~ {
        AccountSwitchCancelExistingPaymentV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AccountSwitchCancelExistingPaymentV02Document *-- AccountSwitchCancelExistingPaymentV02 : 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:acmt.029.001.02">
    <AcctSwtchCclExstgPmt>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <AcctSwtchDtls>
            <!-- AccountSwitchDetails inner content -->
        </AcctSwtchDtls>
        <OdAcct>
            <!-- OldAccount inner content -->
        </OdAcct>
        <PmtInstr>
            <!-- PaymentInstruction inner content -->
        </PmtInstr>
        <DrctDbtInstr>
            <!-- DirectDebitInstruction inner content -->
        </DrctDbtInstr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </AcctSwtchCclExstgPmt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_7HK1f242EeiU9cctagi5ow"
  nextVersions="_LvzYccP_Eemsic1bQcEtLA"
  previousVersion="_iUM-gU9GEeef4o94AcOdBA"
  name="AccountSwitchCancelExistingPaymentV02"
  definition="The AccountSwitchCancelExistingPayment message is sent by the new account servicer to the previous account servicer to identify which payment arrangements are to be cancelled on the account owner's account and when they are to be cancelled. This message is used during a partial switch of the account and may be sent multiple times to allow for the account parties to transfer different payment arrangements at different times during the switch. "
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AcctSwtchCclExstgPmt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_7HK1gW42EeiU9cctagi5ow"
    nextVersions="_LvzYc8P_Eemsic1bQcEtLA"
    previousVersion="_Hh4xYa5jEee17eDA_q0a9g"
    name="MessageIdentification"
    definition="Unique identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_7HK1g242EeiU9cctagi5ow"
    nextVersions="_LvzYdcP_Eemsic1bQcEtLA"
    previousVersion="_I0dMga5jEee17eDA_q0a9g"
    name="AccountSwitchDetails"
    definition="Contains information about the details of the account switch."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AcctSwtchDtls"
    complexType="_8m2xcQ2ZEeSNWNtJlXOAhg" />
  <messageBuildingBlock
    xmi:id="_7HK1hW42EeiU9cctagi5ow"
    nextVersions="_LvzYd8P_Eemsic1bQcEtLA"
    previousVersion="_iUM-hU9GEeef4o94AcOdBA"
    name="OldAccount"
    definition="Details of the old account."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="OdAcct"
    complexType="_8t9lYW48EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_7HK1h242EeiU9cctagi5ow"
    nextVersions="_LvzYecP_Eemsic1bQcEtLA"
    previousVersion="_hfeYAFDdEeeunetnjWUhcA"
    name="PaymentInstruction"
    definition="Details of a debit payment arrangement associated with the old account. The payment may be a standing order, a bill payment arrangement or a future dated payment."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="PmtInstr"
    complexType="_Bp2QlW49EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_7HK1iW42EeiU9cctagi5ow"
    nextVersions="_LvzYe8P_Eemsic1bQcEtLA"
    previousVersion="_YXy34Fy8Eee48PRwcRxS4A"
    name="DirectDebitInstruction"
    definition="Details of a direct debit Instruction associated with the old account."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="DrctDbtInstr"
    complexType="_H6sjw249EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_7HK1i242EeiU9cctagi5ow"
    nextVersions="_LvzYfcP_Eemsic1bQcEtLA"
    previousVersion="_iUM-i09GEeef4o94AcOdBA"
    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="acmt"
    messageFunctionality="029"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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