AdditionalPaymentInformationV11

camt.028.001.11

Scope The AdditionalPaymentInformation message is sent by an account servicing institution to an account owner. This message is used to provide additional or corrected information on a payment instruction or statement entry, in order to allow reconciliation. Usage The AdditionalPaymentInformation message provides elements which are usually not reported in a statement or advice (for example full remittance information or identification of parties other than the account servicing institution and the account owner). It complements information about a payment instruction that has already been received, in the form of one or several entries of the original payment instruction. The AdditionalPaymentInformation message covers one and only one original payment instruction. If several payment instructions need further details, multiple AdditionalPaymentInformation messages must be used, one for each of the payment instructions. The AdditionalPaymentInformation message may be used as a result of two investigation processes and in a way outlined below.

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
%% AdditionalPaymentInformationV11 recursion level 0 with max 0
AdditionalPaymentInformationV11 *-- "1..1" CaseAssignment5 : Assignment
AdditionalPaymentInformationV11 *-- "0..1" Case5 : Case
AdditionalPaymentInformationV11 *-- "1..1" IUnderlyingTransaction7Choice : Underlying
AdditionalPaymentInformationV11 *-- "1..1" PaymentComplementaryInformation10 : Information
AdditionalPaymentInformationV11 *-- "0..1" SupplementaryData1 : SupplementaryData
  

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

Assignment building block

Identifies the assignment of an investigation case from an assigner to an assignee. Usage: The assigner must be the sender of this confirmation and the assignee must be the receiver. Represents the assignment of a case to a party. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CaseAssignment5 recursion level 0 with max 1
class CaseAssignment5{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
CaseAssignment5 *-- "1..1" IParty40Choice : Assigner
CaseAssignment5 *-- "1..1" IParty40Choice : Assignee
%% IParty40Choice recursion level 1 with max 1
%% IParty40Choice recursion level 1 with max 1
  

CaseAssignment5 members

Member name Description Data Type / Multiplicity
Identification Uniquely identifies the case assignment. IsoMax35Text - Required 1..1
Assigner Party who assigns the case. Usage: This is also the sender of the message.
Assignee Party to which the case is assigned. Usage: This is also the receiver of the message.
CreationDateTime Date and time at which the assignment was created. IsoISODateTime - Required 1..1

Case building block

Identifies the investigation case. Provides further details to identify an investigation case. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Case5 recursion level 0 with max 1
class Case5{
    Identification IsoMax35Text
    ReopenCaseIndication IsoYesNoIndicator
}
Case5 *-- "1..1" IParty40Choice : Creator
%% IParty40Choice recursion level 1 with max 1
  

Case5 members

Member name Description Data Type / Multiplicity
Identification Uniquely identifies the case. IsoMax35Text - Required 1..1
Creator Party that created the investigation case. IParty40Choice - Required 1..1
ReopenCaseIndication Indicates whether or not the case was previously closed and is now re-opened. IsoYesNoIndicator - Optional 0..1

Underlying building block

Identifies the underlying payment instruction. Provides details of the underlying transaction, on which the investigation is processed. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IUnderlyingTransaction7Choice recursion level 0 with max 1
  

UnderlyingTransaction7Choice members

Member name Description Data Type / Multiplicity

Information building block

Additional information to the underlying payment instruction. Provides further additional details on the underlying payment instruction that cannot be transferred in a regular statement message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PaymentComplementaryInformation10 recursion level 0 with max 1
class PaymentComplementaryInformation10{
    InstructionIdentification IsoMax35Text
    EndToEndIdentification IsoMax35Text
    TransactionIdentification IsoMax35Text
    RequestedCollectionDate IsoISODate
    InterbankSettlementDate IsoISODate
    InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
    InstructionForDebtorAgent IsoMax140Text
}
PaymentComplementaryInformation10 *-- "0..1" PaymentTypeInformation27 : PaymentTypeInformation
PaymentComplementaryInformation10 *-- "0..1" IDateAndDateTime2Choice : RequestedExecutionDate
PaymentComplementaryInformation10 *-- "0..1" IAmountType4Choice : Amount
PaymentComplementaryInformation10 *-- "0..1" PartyIdentification135 : UltimateDebtor
PaymentComplementaryInformation10 *-- "0..1" PartyIdentification135 : Debtor
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : DebtorAccount
PaymentComplementaryInformation10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : DebtorAgentAccount
PaymentComplementaryInformation10 *-- "0..1" SettlementInstruction11 : SettlementInformation
PaymentComplementaryInformation10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent1
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : IntermediaryAgent1Account
PaymentComplementaryInformation10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent2
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : IntermediaryAgent2Account
PaymentComplementaryInformation10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent3
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : IntermediaryAgent3Account
PaymentComplementaryInformation10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : CreditorAgentAccount
PaymentComplementaryInformation10 *-- "0..1" PartyIdentification135 : Creditor
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : CreditorAccount
PaymentComplementaryInformation10 *-- "0..1" PartyIdentification135 : UltimateCreditor
PaymentComplementaryInformation10 *-- "0..1" IPurpose2Choice : Purpose
PaymentComplementaryInformation10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : PreviousInstructingAgent1
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : PreviousInstructingAgent1Account
PaymentComplementaryInformation10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : PreviousInstructingAgent2
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : PreviousInstructingAgent2Account
PaymentComplementaryInformation10 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : PreviousInstructingAgent3
PaymentComplementaryInformation10 *-- "0..1" CashAccount40 : PreviousInstructingAgent3Account
PaymentComplementaryInformation10 *-- "0..0" InstructionForNextAgent1 : InstructionForNextAgent
PaymentComplementaryInformation10 *-- "0..0" InstructionForCreditorAgent3 : InstructionForCreditorAgent
PaymentComplementaryInformation10 *-- "0..10" RemittanceLocation7 : RelatedRemittanceInformation
PaymentComplementaryInformation10 *-- "0..1" RemittanceInformation21 : RemittanceInformation
%% PaymentTypeInformation27 recursion level 1 with max 1
class PaymentTypeInformation27{
    InstructionPriority Priority2Code
    ClearingChannel ClearingChannel2Code
    SequenceType SequenceType3Code
}
PaymentTypeInformation27 *-- "0..0" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation27 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation27 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% IAmountType4Choice recursion level 1 with max 1
%% 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
%% 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
%% 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
%% SettlementInstruction11 recursion level 1 with max 1
class SettlementInstruction11{
    SettlementMethod SettlementMethod1Code
}
SettlementInstruction11 *-- "0..1" CashAccount40 : SettlementAccount
SettlementInstruction11 *-- "0..1" IClearingSystemIdentification3Choice : ClearingSystem
SettlementInstruction11 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructingReimbursementAgent
SettlementInstruction11 *-- "0..1" CashAccount40 : InstructingReimbursementAgentAccount
SettlementInstruction11 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructedReimbursementAgent
SettlementInstruction11 *-- "0..1" CashAccount40 : InstructedReimbursementAgentAccount
SettlementInstruction11 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ThirdReimbursementAgent
SettlementInstruction11 *-- "0..1" CashAccount40 : ThirdReimbursementAgentAccount
%% 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
%% 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
%% 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
%% 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
%% IPurpose2Choice 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
%% 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
%% InstructionForNextAgent1 recursion level 1 with max 1
class InstructionForNextAgent1{
    Code Instruction4Code
    InstructionInformation IsoMax140Text
}
%% InstructionForCreditorAgent3 recursion level 1 with max 1
class InstructionForCreditorAgent3{
    Code ExternalCreditorAgentInstruction1Code
    InstructionInformation IsoMax140Text
}
%% RemittanceLocation7 recursion level 1 with max 1
class RemittanceLocation7{
    RemittanceIdentification IsoMax35Text
}
RemittanceLocation7 *-- "0..0" RemittanceLocationData1 : RemittanceLocationDetails
%% RemittanceInformation21 recursion level 1 with max 1
class RemittanceInformation21{
    Unstructured IsoMax140Text
}
RemittanceInformation21 *-- "0..0" StructuredRemittanceInformation17 : Structured
  

PaymentComplementaryInformation10 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.
EndToEndIdentification Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
TransactionIdentification Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level.
PaymentTypeInformation Set of elements used to further specify the type of transaction. PaymentTypeInformation27 - Optional 0..1
RequestedExecutionDate Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor’s account is to be debited. If payment by cheque, the date when the cheque must be generated by the bank.
RequestedCollectionDate Date and time at which the creditor requests that the amount of money is to be collected from the debtor. IsoISODate - Optional 0..1
InterbankSettlementDate 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
Amount Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. IAmountType4Choice - Optional 0..1
InterbankSettlementAmount Amount of money moved between the instructing agent and the instructed agent. IsoActiveOrHistoricCurrencyAndAmount - Optional 0..1
ChargeBearer Specifies which party/parties will bear the charges associated with the processing of the payment transaction. ChargeBearerType1Code - Optional 0..1
UltimateDebtor Ultimate party that owes an amount of money to the (ultimate) creditor. PartyIdentification135 - Optional 0..1
Debtor Party that owes an amount of money to the (ultimate) creditor. PartyIdentification135 - Optional 0..1
DebtorAccount Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. CashAccount40 - Optional 0..1
DebtorAgent Financial institution servicing an account for the debtor. BranchAndFinancialInstitutionIdentification6 - Optional 0..1
DebtorAgentAccount Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. CashAccount40 - Optional 0..1
SettlementInformation Instruction between two clearing agents stipulating the cash transfer characteristics between the two parties. SettlementInstruction11 - Optional 0..1
IntermediaryAgent1 Agent between the debtor’s agent and the creditor’s agent.
IntermediaryAgent1Account Unambiguous identification of the account of the intermediary agent 1 at its servicing agent in the payment chain. CashAccount40 - Optional 0..1
IntermediaryAgent2 Agent between the debtor’s agent and the creditor’s agent.
IntermediaryAgent2Account Unambiguous identification of the account of the intermediary agent 2 at its servicing agent in the payment chain. CashAccount40 - Optional 0..1
IntermediaryAgent3 Agent between the debtor’s agent and the creditor’s agent.
IntermediaryAgent3Account Unambiguous identification of the account of the intermediary agent 3 at its servicing agent in the payment chain. CashAccount40 - Optional 0..1
CreditorAgent Financial institution servicing an account for the creditor. BranchAndFinancialInstitutionIdentification6 - Optional 0..1
CreditorAgentAccount Unambiguous identification of the account of the creditor agent at its servicing agent to which a credit entry will be made as a result of the payment transaction. CashAccount40 - Optional 0..1
Creditor Party to which an amount of money is due. PartyIdentification135 - Optional 0..1
CreditorAccount Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. CashAccount40 - Optional 0..1
UltimateCreditor Ultimate party to which an amount of money is due. PartyIdentification135 - Optional 0..1
Purpose Underlying reason for the payment transaction. Usage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.
InstructionForDebtorAgent Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the debtor agent. IsoMax140Text - Optional 0..1
PreviousInstructingAgent1 Agent between the debtor’s agent and the instructing agent. Usage: If more than one previous instructing agent is present, then PreviousInstructingAgent1 identifies the agent between the DebtorAgent and the PreviousInstructingAgent2. BranchAndFinancialInstitutionIdentification6 - Optional 0..1
PreviousInstructingAgent1Account Unambiguous identification of the account of the previous instructing agent 1 at its servicing agent in the payment chain. CashAccount40 - Optional 0..1
PreviousInstructingAgent2 Agent between the debtor’s agent and the instructing agent. Usage: If more than two previous instructing agent are present, then PreviousInstructingAgent2 identifies the agent between the PreviousInstructingAgent1 and the PreviousInstructingAgent3. BranchAndFinancialInstitutionIdentification6 - Optional 0..1
PreviousInstructingAgent2Account Unambiguous identification of the account of the previous instructing agent 2 at its servicing agent in the payment chain. CashAccount40 - Optional 0..1
PreviousInstructingAgent3 Agent between the debtor’s agent and the instructing agent. Usage: If PreviousInstructingAgent3 is present, then PreviousInstructingAgent3 identifies the agent between the PreviousInstructingAgent2 and the InstructingAgent. BranchAndFinancialInstitutionIdentification6 - Optional 0..1
PreviousInstructingAgent3Account Unambiguous identification of the account of the previous instructing agent 3 at its servicing agent in the payment chain. CashAccount40 - Optional 0..1
InstructionForNextAgent Further information related to the processing of the payment instruction that may need to be acted upon by the next agent.
InstructionForCreditorAgent Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. InstructionForCreditorAgent3 - Unknown 0..0
RelatedRemittanceInformation Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain. RemittanceLocation7 - Collection 0..10
RemittanceInformation Structured information that enables the matching, that is reconciliation, of a payment with the items that the payment is intended to settle, such as commercial invoices in an account receivable system. RemittanceInformation21 - 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 AdditionalPaymentInformationV11 implementation follows a specific implementaiton pattern. First of all, AdditionalPaymentInformationV11 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AdditionalPaymentInformationV11Document implements IOuterDocument. Because AdditionalPaymentInformationV11 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AdditionalPaymentInformationV11.

classDiagram
    class IOuterRecord
    AdditionalPaymentInformationV11 --|> IOuterRecord : Implements
    AdditionalPaymentInformationV11Document --|> IOuterDocument~AdditionalPaymentInformationV11~ : Implements
    class IOuterDocument~AdditionalPaymentInformationV11~ {
        AdditionalPaymentInformationV11 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AdditionalPaymentInformationV11Document *-- AdditionalPaymentInformationV11 : 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.028.001.11">
    <AddtlPmtInf>
        <Assgnmt>
            <!-- Assignment inner content -->
        </Assgnmt>
        <Case>
            <!-- Case inner content -->
        </Case>
        <Undrlyg>
            <!-- Underlying inner content -->
        </Undrlyg>
        <Inf>
            <!-- Information inner content -->
        </Inf>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </AddtlPmtInf>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_IBiLQdcBEeq_l4BJLVUF2Q"
  previousVersion="_Lv9JccP_Eemsic1bQcEtLA"
  name="AdditionalPaymentInformationV11"
  definition="Scope&#xD;&#xA;The AdditionalPaymentInformation message is sent by an account servicing institution to an account owner.&#xD;&#xA;This message is used to provide additional or corrected information on a payment instruction or statement entry, in order to allow reconciliation.&#xD;&#xA;Usage&#xD;&#xA;The AdditionalPaymentInformation message provides elements which are usually not reported in a statement or advice (for example full remittance information or identification of parties other than the account servicing institution and the account owner). It complements information about a payment instruction that has already been received, in the form of one or several entries of the original payment instruction.&#xD;&#xA;The AdditionalPaymentInformation message covers one and only one original payment instruction. If several payment instructions need further details, multiple AdditionalPaymentInformation messages must be used, one for each of the payment instructions.&#xD;&#xA;The AdditionalPaymentInformation message may be used as a result of two investigation processes and in a way outlined below.&#xD;&#xA;- A ClaimNonReceipt workflow raised by the creditor or recipient of the payment: This means that the payment instruction has reached the creditor or beneficiary. The account owner needs further details or correct information for its reconciliation processes. The AdditionalPaymentInformation can be used to provide the missing information;&#xD;&#xA;- A RequestToModifyPayment workflow raised by the debtor or one of the intermediate agents upstream: When the payment instruction has reached its intended recipient and the modification does not affect the accounting at the account servicing institution, this AdditionalPaymentInformation message allows the account owner to receive further particulars or correct information about a payment instruction or an entry passed to its account.&#xD;&#xA;The AdditionalPayment Information message cannot be used to trigger a request for modification of a payment instruction activity. A RequestToModifyPayment message must be used. In other words, if a debtor or one of intermediate agent (excluding the account servicing institution of the creditor) realises the some information was missing in the original payment instruction, he should not use an AdditionalPaymentInformation but instead a RequestToModifyPayment message.&#xD;&#xA;It is assumed that when an account servicing institution sends out an AdditionalPaymentInformation message, the institution is fairly confident that this will resolve the case. Therefore it does not need to wait for a Resolution Of Investigation message. Neither does the account owner, or whoever receives the additional information, need to send back a ResolutionOfInvestigation message. Positive resolution in this case is implicit. Both parties are expected to close the case. In the event that the problem does not go away, a party can re-open the case."
  registrationStatus="Registered"
  messageSet="_moz48_2VEeGjgKzdN0DbWA"
  xmlTag="AddtlPmtInf"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_IBiLSdcBEeq_l4BJLVUF2Q"
    previousVersion="_Lv9JecP_Eemsic1bQcEtLA"
    name="Assignment"
    definition="Identifies the assignment of an investigation case from an assigner to an assignee.&#xD;&#xA;Usage: The assigner must be the sender of this confirmation and the assignee must be the receiver."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Assgnmt"
    complexType="_BzPdIW49EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_IBiLS9cBEeq_l4BJLVUF2Q"
    previousVersion="_Lv9Je8P_Eemsic1bQcEtLA"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Case"
    complexType="_8BF4W248EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_IBiLTdcBEeq_l4BJLVUF2Q"
    previousVersion="_Lv9JfcP_Eemsic1bQcEtLA"
    name="Underlying"
    definition="Identifies the underlying payment instruction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Undrlyg"
    complexType="_ef6I4dcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_IBiLT9cBEeq_l4BJLVUF2Q"
    previousVersion="_Lv9Jf8P_Eemsic1bQcEtLA"
    name="Information"
    definition="Additional information to the underlying payment instruction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Inf"
    complexType="_ggXkwdcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_IBiLUdcBEeq_l4BJLVUF2Q"
    previousVersion="_Lv9JgcP_Eemsic1bQcEtLA"
    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="028"
    flavour="001"
    version="11" />
</messageDefinition>

ISO Building Blocks

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