RequestToModifyPaymentV03

camt.087.001.03

Scope The RequestToModifyPayment message is sent by a case creator/case assigner to a case assignee. This message is used to request the modification of characteristics of an original payment instruction. Usage The RequestToModifyPayment message must be answered with a:

• Resolution Of Investigation message with a positive final outcome when the case assignee can perform the requested modification
• Resolution Of Investigation message with a negative final outcome when the case assignee may perform the requested modification but fails to do so (too late, irrevocable instruction, one requested element cannot be modified.)
• Reject Case Assignment message when the case assignee is unable or not authorised to perform the requested modification
• Notification Of Case Assignment message to indicate whether the case assignee will take on the case himself or reassign the case to a subsequent party in the payment processing chain. The Request To Modify Payment message covers one and only one original instruction at a time. If several original payment instructions need to be modified, then multiple Request To Modify Payment messages must be sent. The Request To Modify Payment message can be sent to request the modification of one or several elements of the original payment instruction. If many elements need to be modified, it is recommended to cancel the original payment instruction and initiate a new one. The Request To Modify Payment must be processed on an all or nothing basis. If one of the elements to be modified cannot be altered, the assignment must be rejected in full by means of a negative Resolution Of Investigation message. (See section on Resolution Of Investigation for more details.) The Request To Modify Payment message must never be sent to request the modification of the currency of the original payment instruction. If the currency is wrong, use Request To Cancel Payment message to cancel it and issue and a new payment instruction. The Request To Modify Payment message may be forwarded to subsequent case assignee(s). When a Request To Modify Payment message is used to decrease the amount of the original payment instruction, the modification will trigger a return of funds from the case assignee to the case creator. The assignee may indicate, within the Resolution Of Investigation message, the amount to be returned, the date it is or will be returned and the channel through which the return will be done. The Request To Modify Payment message must never be sent to request the increase of the amount of the original payment instruction. To increase the amount in a payment, the debtor can do one of the following:
• Cancel the first payment using a Request To Cancel Payment message and make a new payment with a higher and correct amount.
• Simply send a second payment with the supplementary amount. Depending on the requested modification(s) and the processing stage of the original payment instruction, the processing of a request to modify payment case may end with one of the following:
• an Additional Payment Information message sent to the creditor of the original payment instruction
• a Debit Authorisation Request message sent to the creditor of the original payment instruction
• a Request To Cancel Payment message sent to a subsequent case assignee The Request To Modify Payment message can be sent to correct characteristics of an original payment instruction following receipt of an Unable To Apply message. In this scenario, the case identification will remain the same. The RequestToModifyPayment message has the following main characteristics: The case creator assigns a unique case identification. This information will be passed unchanged to all subsequent case assignee(s). Lowering the amount of an original payment instruction for which cover is provided by a separate instruction will systematically mean the modification of the whole transaction, including the cover. The case assignee performing the amount modification must initiate the return of funds in excess to the case creator. The modification of the agent’s or agents’ information on an original payment instruction for which cover is provided by a separate instruction will systematically mean the whole transaction is modified, i.e., the cover is executed through the agent(s) mentioned in the Request To Modify Payment message. The cover payment must not be modified separately. The modification of a payment instruction can be initiated by either the debtor or any subsequent agent in the payment processing chain. The case creator provides the information to be modified in line with agreements made with the case assignee. If the case assignee needs in turn to assign the case to a subsequent case assignee, the requested modification(s) must be in line with the agreement made with the next case assignee and a Notification Of Case Assignment message must be sent to the case assigner. Otherwise, the request to modify payment case must be rejected (by means of a negative Resolution Of Investigation 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
%% RequestToModifyPaymentV03 recursion level 0 with max 0
RequestToModifyPaymentV03 *-- "1..1" CaseAssignment3 : Assignment
RequestToModifyPaymentV03 *-- "1..1" Case3 : Case
RequestToModifyPaymentV03 *-- "1..1" IUnderlyingTransaction2Choice : Underlying
RequestToModifyPaymentV03 *-- "1..1" RequestedModification5 : Modification
RequestToModifyPaymentV03 *-- "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 payment transaction to be modified. 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

Modification building block

Identifies the list of modifications requested. Provide further details on the requested modifications of the underlying payment instruction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% RequestedModification5 recursion level 0 with max 1
class RequestedModification5{
    InstructionIdentification IsoMax35Text
    EndToEndIdentification IsoMax35Text
    TransactionIdentification IsoMax35Text
    RequestedExecutionDate IsoISODate
    RequestedCollectionDate IsoISODate
    InterbankSettlementDate IsoISODate
    InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
    InstructionForDebtorAgent IsoMax140Text
}
RequestedModification5 *-- "0..1" PaymentTypeInformation25 : PaymentTypeInformation
RequestedModification5 *-- "0..1" IAmountType4Choice : Amount
RequestedModification5 *-- "0..1" PartyIdentification43 : UltimateDebtor
RequestedModification5 *-- "0..1" PartyIdentification43 : Debtor
RequestedModification5 *-- "0..1" CashAccount24 : DebtorAccount
RequestedModification5 *-- "0..1" CashAccount24 : DebtorAgentAccount
RequestedModification5 *-- "0..1" SettlementInstruction3 : SettlementInformation
RequestedModification5 *-- "0..1" CashAccount24 : CreditorAgentAccount
RequestedModification5 *-- "0..1" PartyIdentification43 : Creditor
RequestedModification5 *-- "0..1" CashAccount24 : CreditorAccount
RequestedModification5 *-- "0..1" PartyIdentification43 : UltimateCreditor
RequestedModification5 *-- "0..1" IPurpose2Choice : Purpose
RequestedModification5 *-- "0..0" InstructionForNextAgent1 : InstructionForNextAgent
RequestedModification5 *-- "0..0" InstructionForCreditorAgent1 : InstructionForCreditorAgent
RequestedModification5 *-- "0..1" RemittanceInformation11 : 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
%% IAmountType4Choice 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
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% SettlementInstruction3 recursion level 1 with max 1
SettlementInstruction3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingReimbursementAgent
SettlementInstruction3 *-- "0..1" CashAccount24 : InstructingReimbursementAgentAccount
SettlementInstruction3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedReimbursementAgent
SettlementInstruction3 *-- "0..1" CashAccount24 : InstructedReimbursementAgentAccount
%% 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
%% 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
}
%% RemittanceInformation11 recursion level 1 with max 1
class RemittanceInformation11{
    Unstructured IsoMax140Text
}
RemittanceInformation11 *-- "0..0" StructuredRemittanceInformation13 : Structured
  

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

classDiagram
    class IOuterRecord
    RequestToModifyPaymentV03 --|> IOuterRecord : Implements
    RequestToModifyPaymentV03Document --|> IOuterDocument~RequestToModifyPaymentV03~ : Implements
    class IOuterDocument~RequestToModifyPaymentV03~ {
        RequestToModifyPaymentV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    RequestToModifyPaymentV03Document *-- RequestToModifyPaymentV03 : 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.087.001.03">
    <ReqToModfyPmt>
        <Assgnmt>
            <!-- Assignment inner content -->
        </Assgnmt>
        <Case>
            <!-- Case inner content -->
        </Case>
        <Undrlyg>
            <!-- Underlying inner content -->
        </Undrlyg>
        <Mod>
            <!-- Modification inner content -->
        </Mod>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </ReqToModfyPmt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_pmmdtzqxEeWZFYSPlduMhw"
  nextVersions="_F3nqcWXpEeap-P22vGV91g"
  previousVersion="_wQzatxPeEeSVo-TFVwFHvA"
  name="RequestToModifyPaymentV03"
  definition="Scope&#xD;&#xA;The RequestToModifyPayment message is sent by a case creator/case assigner to a case assignee.&#xD;&#xA;This message is used to request the modification of characteristics of an original payment instruction.&#xD;&#xA;Usage&#xD;&#xA;The RequestToModifyPayment message must be answered with a:&#xD;&#xA;- Resolution Of Investigation message with a positive final outcome when the case assignee can perform the requested modification&#xD;&#xA;- Resolution Of Investigation message with a negative final outcome when the case assignee may perform the requested modification but fails to do so (too late, irrevocable instruction, one requested element cannot be modified.)&#xD;&#xA;- Reject Case Assignment message when the case assignee is unable or not authorised to perform the requested modification&#xD;&#xA;- Notification Of Case Assignment message to indicate whether the case assignee will take on the case himself or reassign the case to a subsequent party in the payment processing chain.&#xD;&#xA;The Request To Modify Payment message covers one and only one original instruction at a time. If several original payment instructions need to be modified, then multiple Request To Modify Payment messages must be sent.&#xD;&#xA;The Request To Modify Payment message can be sent to request the modification of one or several elements of the original payment instruction. If many elements need to be modified, it is recommended to cancel the original payment instruction and initiate a new one.&#xD;&#xA;The Request To Modify Payment must be processed on an all or nothing basis. If one of the elements to be modified cannot be altered, the assignment must be rejected in full by means of a negative Resolution Of Investigation message. (See section on Resolution Of Investigation for more details.)&#xD;&#xA;The Request To Modify Payment message must never be sent to request the modification of the currency of the original payment instruction. If the currency is wrong, use Request To Cancel Payment message to cancel it and issue and a new payment instruction.&#xD;&#xA;The Request To Modify Payment message may be forwarded to subsequent case assignee(s).&#xD;&#xA;When a Request To Modify Payment message is used to decrease the amount of the original payment instruction, the modification will trigger a return of funds from the case assignee to the case creator. The assignee may indicate, within the Resolution Of Investigation message, the amount to be returned, the date it is or will be returned and the channel through which the return will be done.&#xD;&#xA;The Request To Modify Payment message must never be sent to request the increase of the amount of the original payment instruction. To increase the amount in a payment, the debtor can do one of the following:&#xD;&#xA;- Cancel the first payment using a Request To Cancel Payment message and make a new payment with a higher and correct amount.&#xD;&#xA;- Simply send a second payment with the supplementary amount.&#xD;&#xA;Depending on the requested modification(s) and the processing stage of the original payment instruction, the processing of a request to modify payment case may end with one of the following:&#xD;&#xA;- an Additional Payment Information message sent to the creditor of the original payment instruction&#xD;&#xA;- a Debit Authorisation Request message sent to the creditor of the original payment instruction&#xD;&#xA;- a Request To Cancel Payment message sent to a subsequent case assignee&#xD;&#xA;The Request To Modify Payment message can be sent to correct characteristics of an original payment instruction following receipt of an Unable To Apply message. In this scenario, the case identification will remain the same.&#xD;&#xA;The RequestToModifyPayment message has the following main characteristics:&#xD;&#xA;The case creator assigns a unique case identification. This information will be passed unchanged to all subsequent case assignee(s).&#xD;&#xA;Lowering the amount of an original payment instruction for which cover is provided by a separate instruction will systematically mean the modification of the whole transaction, including the cover. The case assignee performing the amount modification must initiate the return of funds in excess to the case creator.&#xD;&#xA;The modification of the agent's or agents' information on an original payment instruction for which cover is provided by a separate instruction will systematically mean the whole transaction is modified, i.e., the cover is executed through the agent(s) mentioned in the Request To Modify Payment message. The cover payment must not be modified separately.&#xD;&#xA;The modification of a payment instruction can be initiated by either the debtor or any subsequent agent in the payment processing chain.&#xD;&#xA;The case creator provides the information to be modified in line with agreements made with the case assignee. If the case assignee needs in turn to assign the case to a subsequent case assignee, the requested modification(s) must be in line with the agreement made with the next case assignee and a Notification Of Case Assignment message must be sent to the case assigner. Otherwise, the request to modify payment case must be rejected (by means of a negative Resolution Of Investigation message)."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="ReqToModfyPmt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_pmmduTqxEeWZFYSPlduMhw"
    nextVersions="_F3nqc2XpEeap-P22vGV91g"
    previousVersion="_wQzawxPeEeSVo-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="_pmmduzqxEeWZFYSPlduMhw"
    nextVersions="_F3nqdWXpEeap-P22vGV91g"
    previousVersion="_wQzaxRPeEeSVo-TFVwFHvA"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Case"
    complexType="_tijOcFkyEeGeoaLUQk__nA_-1838378407" />
  <messageBuildingBlock
    xmi:id="_pmmdvTqxEeWZFYSPlduMhw"
    nextVersions="_F3nqd2XpEeap-P22vGV91g"
    previousVersion="_wQzaxxPeEeSVo-TFVwFHvA"
    name="Underlying"
    definition="Identifies the payment transaction to be modified."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Undrlyg"
    complexType="_P3N9Vp9XEeGBX4a4yy-WHg_2030305441" />
  <messageBuildingBlock
    xmi:id="_pmmdvzqxEeWZFYSPlduMhw"
    nextVersions="_F3nqeWXpEeap-P22vGV91g"
    previousVersion="_wQzayRPeEeSVo-TFVwFHvA"
    name="Modification"
    definition="Identifies the list of modifications requested."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Mod"
    complexType="_11le1Tq4EeWZFYSPlduMhw" />
  <messageBuildingBlock
    xmi:id="_pmmdwTqxEeWZFYSPlduMhw"
    nextVersions="_F3nqe2XpEeap-P22vGV91g"
    previousVersion="_wQzayxPeEeSVo-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="087"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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