AdditionalPaymentInformationV04

camt.028.001.04

Scope The Additional Payment Information 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 Additional Payment Information 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 Additional Payment Information message covers one and only one original payment instruction. If several payment instructions need further details, multiple Additional Payment Information 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.

• A Claim Non Receipt 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 Additional Payment Information can be used to provide the missing information.
• A Request To Modify Payment 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 Additional Payment Information message allows the account owner to receive further particulars or correct information about a payment instruction or an entry passed to its account. The Additional Payment Information message cannot be used to trigger a request for modification of a payment instruction activity. A Request To Modify Payment 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 Additional Payment Information but instead a Request To Modify Payment message. It is assumed that when an account servicing institution sends out an Additional Payment Information 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 Resolution Of Investigation 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.

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
%% AdditionalPaymentInformationV04 recursion level 0 with max 0
AdditionalPaymentInformationV04 *-- "1..1" CaseAssignment3 : Assignment
AdditionalPaymentInformationV04 *-- "1..1" Case3 : Case
AdditionalPaymentInformationV04 *-- "1..1" IUnderlyingTransaction2Choice : Underlying
AdditionalPaymentInformationV04 *-- "1..1" PaymentComplementaryInformation3 : Information
AdditionalPaymentInformationV04 *-- "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
%% CaseAssignment3 recursion level 0 with max 1
class CaseAssignment3{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
CaseAssignment3 *-- "1..1" IParty12Choice : Assigner
CaseAssignment3 *-- "1..1" IParty12Choice : Assignee
%% IParty12Choice recursion level 1 with max 1
%% IParty12Choice recursion level 1 with max 1
  

CaseAssignment3 members

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
%% Case3 recursion level 0 with max 1
class Case3{
    Identification IsoMax35Text
    ReopenCaseIndication IsoYesNoIndicator
}
Case3 *-- "1..1" IParty12Choice : Creator
%% IParty12Choice recursion level 1 with max 1
  

Case3 members

Underlying building block

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

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

UnderlyingTransaction2Choice members

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
%% PaymentComplementaryInformation3 recursion level 0 with max 1
class PaymentComplementaryInformation3{
    InstructionIdentification IsoMax35Text
    EndToEndIdentification IsoMax35Text
    TransactionIdentification IsoMax35Text
    RequestedExecutionDate IsoISODate
    RequestedCollectionDate IsoISODate
    InterbankSettlementDate IsoISODate
    InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
    InstructionForDebtorAgent IsoMax140Text
}
PaymentComplementaryInformation3 *-- "0..1" PaymentTypeInformation25 : PaymentTypeInformation
PaymentComplementaryInformation3 *-- "0..1" IAmountType3Choice : Amount
PaymentComplementaryInformation3 *-- "0..1" PartyIdentification43 : UltimateDebtor
PaymentComplementaryInformation3 *-- "0..1" PartyIdentification43 : Debtor
PaymentComplementaryInformation3 *-- "0..1" CashAccount24 : DebtorAccount
PaymentComplementaryInformation3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
PaymentComplementaryInformation3 *-- "0..1" CashAccount24 : DebtorAgentAccount
PaymentComplementaryInformation3 *-- "0..1" SettlementInstruction1 : SettlementInformation
PaymentComplementaryInformation3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent1
PaymentComplementaryInformation3 *-- "0..1" CashAccount24 : IntermediaryAgent1Account
PaymentComplementaryInformation3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent2
PaymentComplementaryInformation3 *-- "0..1" CashAccount24 : IntermediaryAgent2Account
PaymentComplementaryInformation3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent3
PaymentComplementaryInformation3 *-- "0..1" CashAccount24 : IntermediaryAgent3Account
PaymentComplementaryInformation3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
PaymentComplementaryInformation3 *-- "0..1" CashAccount24 : CreditorAgentAccount
PaymentComplementaryInformation3 *-- "0..1" PartyIdentification43 : Creditor
PaymentComplementaryInformation3 *-- "0..1" CashAccount24 : CreditorAccount
PaymentComplementaryInformation3 *-- "0..1" PartyIdentification43 : UltimateCreditor
PaymentComplementaryInformation3 *-- "0..1" IPurpose2Choice : Purpose
PaymentComplementaryInformation3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : PreviousInstructingAgent
PaymentComplementaryInformation3 *-- "0..1" CashAccount24 : PreviousInstructingAgentAccount
PaymentComplementaryInformation3 *-- "0..0" InstructionForNextAgent1 : InstructionForNextAgent
PaymentComplementaryInformation3 *-- "0..0" InstructionForCreditorAgent1 : InstructionForCreditorAgent
PaymentComplementaryInformation3 *-- "0..1" RemittanceInformation7 : RemittanceInformation
%% PaymentTypeInformation25 recursion level 1 with max 1
class PaymentTypeInformation25{
    InstructionPriority Priority2Code
    ClearingChannel ClearingChannel2Code
    SequenceType SequenceType3Code
}
PaymentTypeInformation25 *-- "0..1" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation25 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation25 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% IAmountType3Choice recursion level 1 with max 1
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% SettlementInstruction1 recursion level 1 with max 1
class SettlementInstruction1{
    SettlementMethod SettlementMethod1Code
}
SettlementInstruction1 *-- "0..1" CashAccount24 : SettlementAccount
SettlementInstruction1 *-- "0..1" IClearingSystemIdentification3Choice : ClearingSystem
SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingReimbursementAgent
SettlementInstruction1 *-- "0..1" CashAccount24 : InstructingReimbursementAgentAccount
SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedReimbursementAgent
SettlementInstruction1 *-- "0..1" CashAccount24 : InstructedReimbursementAgentAccount
SettlementInstruction1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : ThirdReimbursementAgent
SettlementInstruction1 *-- "0..1" CashAccount24 : ThirdReimbursementAgentAccount
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% IPurpose2Choice recursion level 1 with max 1
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% InstructionForNextAgent1 recursion level 1 with max 1
class InstructionForNextAgent1{
    Code Instruction4Code
    InstructionInformation IsoMax140Text
}
%% InstructionForCreditorAgent1 recursion level 1 with max 1
class InstructionForCreditorAgent1{
    Code Instruction3Code
    InstructionInformation IsoMax140Text
}
%% RemittanceInformation7 recursion level 1 with max 1
class RemittanceInformation7{
    Unstructured IsoMax140Text
}
RemittanceInformation7 *-- "0..0" StructuredRemittanceInformation9 : Structured
  

PaymentComplementaryInformation3 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 AdditionalPaymentInformationV04 implementation follows a specific implementaiton pattern. First of all, AdditionalPaymentInformationV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AdditionalPaymentInformationV04Document implements IOuterDocument. Because AdditionalPaymentInformationV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AdditionalPaymentInformationV04.

classDiagram
    class IOuterRecord
    AdditionalPaymentInformationV04 --|> IOuterRecord : Implements
    AdditionalPaymentInformationV04Document --|> IOuterDocument~AdditionalPaymentInformationV04~ : Implements
    class IOuterDocument~AdditionalPaymentInformationV04~ {
        AdditionalPaymentInformationV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AdditionalPaymentInformationV04Document *-- AdditionalPaymentInformationV04 : 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.04">
    <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="_sYCjIVkyEeGeoaLUQk__nA_-1513426724"
  nextVersions="_wQzacRPeEeSVo-TFVwFHvA"
  previousVersion="_GN9QONE-Ed-BzquC8wXy7w_-434015417"
  name="AdditionalPaymentInformationV04"
  definition="Scope&#xD;&#xA;The Additional Payment Information 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 Additional Payment Information 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 Additional Payment Information message covers one and only one original payment instruction. If several payment instructions need further details, multiple Additional Payment Information 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 Claim Non Receipt 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 Additional Payment Information can be used to provide the missing information.&#xD;&#xA;- A Request To Modify Payment 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 Additional Payment Information 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 Additional Payment Information message cannot be used to trigger a request for modification of a payment instruction activity. A Request To Modify Payment 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 Additional Payment Information but instead a Request To Modify Payment message.&#xD;&#xA;It is assumed that when an account servicing institution sends out an Additional Payment Information 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 Resolution Of Investigation 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="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AddtlPmtInf"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_sYLtEFkyEeGeoaLUQk__nA_1488272778"
    nextVersions="_wQzacxPeEeSVo-TFVwFHvA"
    name="Assignment"
    definition="Identifies the assignment of an investigation case from an assigner to an assignee.&#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="_sbKvolkyEeGeoaLUQk__nA_1583838951" />
  <messageBuildingBlock
    xmi:id="_sYLtEVkyEeGeoaLUQk__nA_605039491"
    nextVersions="_wQzadRPeEeSVo-TFVwFHvA"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Case"
    complexType="_tijOcFkyEeGeoaLUQk__nA_-1838378407" />
  <messageBuildingBlock
    xmi:id="_sYLtElkyEeGeoaLUQk__nA_491200425"
    nextVersions="_wQzadxPeEeSVo-TFVwFHvA"
    name="Underlying"
    definition="Identifies the underlying payment instruction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Undrlyg"
    complexType="_P3N9Vp9XEeGBX4a4yy-WHg_2030305441" />
  <messageBuildingBlock
    xmi:id="_sYVeEFkyEeGeoaLUQk__nA_-392032862"
    nextVersions="_wQzaeRPeEeSVo-TFVwFHvA"
    name="Information"
    definition="Additional information to the underlying payment instruction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Inf"
    complexType="_tYHgElkyEeGeoaLUQk__nA_-2128201528" />
  <messageBuildingBlock
    xmi:id="_sYVeEVkyEeGeoaLUQk__nA_1999910584"
    nextVersions="_wQzaexPeEeSVo-TFVwFHvA"
    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="04" />
</messageDefinition>

ISO Building Blocks

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