LiquidityDebitTransferV06

camt.051.001.06

Scope The LiquidityDebitTransfer message is sent by a member to the transaction administrator. It is used to request a transfer of funds between two accounts belonging to the same member or the same group of accounts, and being held at the transaction administrator. Usage At any time during the operating hours of the system, and to perform the appropriate liquidity management, the member can request the transaction administrator to execute the transfer of funds between two accounts that the transaction administrator maintains for the member. For instance, this may be an action resulting from a Get/Return Account pair of messages. The LiquidityDebitTransfer message can be used when the transactions to/from the member are unbalanced in value for the business day, or to unlock pending transactions at the end of day. The member can request the transfer by identifying the accounts stored at the transaction administrator:

If the accounts involved in the requested transfer are known without doubt to the transaction administrator, it is possible to indicate only the type of the account to be credited.
If, on the contrary, more clarity is desired, it is possible to identify the accounts from and to which the funds should be transferred. Note that transfers are processed only when the balance in the account to be debited is sufficient to pass the liquidity transfer instruction and remain positive. Based on the criteria received within the LiquidityDebitTransfer message, the transaction administrator will execute or reject the requested transfer. In principle, the transaction administrator may send a Receipt message as a reply to the liquidity transfer request. To verify the outcome of the request, the member may submit a GetTransaction or GetAccount message with the appropriate search criteria.

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
%% LiquidityDebitTransferV06 recursion level 0 with max 0
LiquidityDebitTransferV06 *-- "1..1" MessageHeader1 : MessageHeader
LiquidityDebitTransferV06 *-- "1..1" LiquidityDebitTransfer3 : LiquidityDebitTransfer
LiquidityDebitTransferV06 *-- "0..1" SupplementaryData1 : SupplementaryData

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

MessageHeader building block

Common business identification for the message. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification

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

MessageHeader1 members

Member name	Description	Data Type / Multiplicity
MessageIdentification	Point to point reference, as assigned by the sender, to unambiguously identify the message. Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period.	IsoMax35Text - Required 1..1
CreationDateTime	Date and time at which the message was created.	IsoISODateTime - Optional 0..1

LiquidityDebitTransfer building block

Details of the liquidity debit transfer. Provides details specific to the liquidity debit transfer, used to transfer an amount of money from the debtor to the creditor, where both are financial institutions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% LiquidityDebitTransfer3 recursion level 0 with max 1
class LiquidityDebitTransfer3{
    SettlementDate IsoISODate
}
LiquidityDebitTransfer3 *-- "0..1" PaymentIdentification8 : LiquidityTransferIdentification
LiquidityDebitTransfer3 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : Creditor
LiquidityDebitTransfer3 *-- "0..1" CashAccount40 : CreditorAccount
LiquidityDebitTransfer3 *-- "1..1" IAmount2Choice : TransferredAmount
LiquidityDebitTransfer3 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : Debtor
LiquidityDebitTransfer3 *-- "0..1" CashAccount40 : DebtorAccount
%% PaymentIdentification8 recursion level 1 with max 1
class PaymentIdentification8{
    InstructionIdentification IsoMax35Text
    EndToEndIdentification IsoMax35Text
    TransactionIdentification IsoMax35Text
    UETR IsoUUIDv4Identifier
}
%% 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
%% IAmount2Choice 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

LiquidityDebitTransfer3 members

Member name	Description	Data Type / Multiplicity
LiquidityTransferIdentification	Used to uniquely identify the liquidity transfer.	PaymentIdentification8 - Optional 0..1
Creditor	Owner of the account to be credited.	BranchAndFinancialInstitutionIdentification6 - Optional 0..1
CreditorAccount	Account to be credited as a result of a transfer of liquidity.	CashAccount40 - Optional 0..1
TransferredAmount	Amount of money that the transaction administrator transfers from one account to another.	IAmount2Choice - Required 1..1
Debtor	Owner of the account to be debited.	BranchAndFinancialInstitutionIdentification6 - Optional 0..1
DebtorAccount	Account to be debited as a result of a transfer of liquidity.	CashAccount40 - Optional 0..1
SettlementDate	Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.	IsoISODate - 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 LiquidityDebitTransferV06 implementation follows a specific implementaiton pattern. First of all, LiquidityDebitTransferV06 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, LiquidityDebitTransferV06Document implements IOuterDocument. Because LiquidityDebitTransferV06 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type LiquidityDebitTransferV06.

classDiagram
    class IOuterRecord
    LiquidityDebitTransferV06 --|> IOuterRecord : Implements
    LiquidityDebitTransferV06Document --|> IOuterDocument~LiquidityDebitTransferV06~ : Implements
    class IOuterDocument~LiquidityDebitTransferV06~ {
        LiquidityDebitTransferV06 Message
     }

Document wrapper for serialization

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

classDiagram
    LiquidityDebitTransferV06Document *-- LiquidityDebitTransferV06 : 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.051.001.06">
    <LqdtyDbtTrf>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <LqdtyDbtTrf>
            <!-- LiquidityDebitTransfer inner content -->
        </LqdtyDbtTrf>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </LqdtyDbtTrf>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ThP0Ddb6Eeq_l4BJLVUF2Q"
  previousVersion="_jwlbtxbvEeiyVv5j1vf1VQ"
  name="LiquidityDebitTransferV06"
  definition="Scope&#xD;&#xA;The LiquidityDebitTransfer message is sent by a member to the transaction administrator.&#xD;&#xA;It is used to request a transfer of funds between two accounts belonging to the same member or the same group of accounts, and being held at the transaction administrator.&#xD;&#xA;Usage&#xD;&#xA;At any time during the operating hours of the system, and to perform the appropriate liquidity management, the member can request the transaction administrator to execute the transfer of funds between two accounts that the transaction administrator maintains for the member. For instance, this may be an action resulting from a Get/Return Account pair of messages.&#xD;&#xA;The LiquidityDebitTransfer message can be used when the transactions to/from the member are unbalanced in value for the business day, or to unlock pending transactions at the end of day.&#xD;&#xA;The member can request the transfer by identifying the accounts stored at the transaction administrator:&#xD;&#xA;- If the accounts involved in the requested transfer are known without doubt to the transaction administrator, it is possible to indicate only the type of the account to be credited.&#xD;&#xA;- If, on the contrary, more clarity is desired, it is possible to identify the accounts from and to which the funds should be transferred.&#xD;&#xA;Note that transfers are processed only when the balance in the account to be debited is sufficient to pass the liquidity transfer instruction and remain positive. Based on the criteria received within the LiquidityDebitTransfer message, the transaction administrator will execute or reject the requested transfer.&#xD;&#xA;In principle, the transaction administrator may send a Receipt message as a reply to the liquidity transfer request. To verify the outcome of the request, the member may submit a GetTransaction or GetAccount message with the appropriate search criteria."
  registrationStatus="Registered"
  messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
  xmlTag="LqdtyDbtTrf"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ThP0E9b6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlbuRbvEeiyVv5j1vf1VQ"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_75DzkaMgEeCJ6YNENx4h-w_-613853819" />
  <messageBuildingBlock
    xmi:id="_ThP0Fdb6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlbuxbvEeiyVv5j1vf1VQ"
    name="LiquidityDebitTransfer"
    definition="Details of the liquidity debit transfer."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="LqdtyDbtTrf"
    complexType="_cUs1kdcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_ThP0F9b6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlbvRbvEeiyVv5j1vf1VQ"
    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="051"
    flavour="001"
    version="06" />
</messageDefinition>

ISO Building Blocks

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