RequestToModifyPaymentV08

camt.087.001.08

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:

• ResolutionOfInvestigation message with a positive final outcome when the case assignee can perform the requested modification;
• ResolutionOfInvestigation 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);
• RejectCaseAssignment message when the case assignee is unable or not authorised to perform the requested modification;
• NotificationOfCaseAssignment 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 RequestToModifyPayment message covers one and only one original instruction at a time. If several original payment instructions need to be modified, then multiple RequestToModifyPayment messages must be sent. The RequestToModifyPayment 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 RequestToModifyPayment 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 ResolutionOfInvestigation message. (See section on ResolutionOfInvestigation for more details). The RequestToModifyPayment message must never be sent to request the modification of the currency of the original payment instruction. If the currency is wrong, use a CustomerPaymentCancellationRequest or a FIToFIPaymentCancellationRequest message to cancel it and issue and a new payment instruction. The RequestToModifyPayment message may be forwarded to subsequent case assignee(s). When a RequestToModifyPayment 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 ResolutionOfInvestigation 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 RequestToModifyPayment 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 CustomerPaymentCancellationRequest or a FIToFIPaymentCancellationRequest 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 AdditionalPaymentInformation message sent to the creditor of the original payment instruction;
• a DebitAuthorisationRequest message sent to the creditor of the original payment instruction;
• a CustomerPaymentCancellationRequest or a FIToFIPaymentCancellationRequest message sent to a subsequent case assignee. The RequestToModifyPayment message can be sent to correct characteristics of an original payment instruction following receipt of an UnableToApply 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, that is the cover is executed through the agent(s) mentioned in the RequestToModifyPayment 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 NotificationOfCaseAssignment message must be sent to the case assigner. Otherwise, the request to modify payment case must be rejected (by means of a negative ResolutionOfInvestigation 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
%% RequestToModifyPaymentV08 recursion level 0 with max 0
RequestToModifyPaymentV08 *-- "1..1" CaseAssignment5 : Assignment
RequestToModifyPaymentV08 *-- "0..1" Case5 : Case
RequestToModifyPaymentV08 *-- "1..1" IUnderlyingTransaction7Choice : Underlying
RequestToModifyPaymentV08 *-- "1..1" RequestedModification10 : Modification
RequestToModifyPaymentV08 *-- "0..1" InstructionForAssignee1 : InstructionForAssignee
RequestToModifyPaymentV08 *-- "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

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

Underlying building block

Identifies the payment transaction to be modified. 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

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
%% RequestedModification10 recursion level 0 with max 1
class RequestedModification10{
    InstructionIdentification IsoMax35Text
    EndToEndIdentification IsoMax35Text
    TransactionIdentification IsoMax35Text
    RequestedCollectionDate IsoISODate
    InterbankSettlementDate IsoISODate
    InterbankSettlementAmount IsoActiveOrHistoricCurrencyAndAmount
    ChargeBearer ChargeBearerType1Code
    InstructionForDebtorAgent IsoMax140Text
}
RequestedModification10 *-- "0..1" PaymentTypeInformation27 : PaymentTypeInformation
RequestedModification10 *-- "0..1" IDateAndDateTime2Choice : RequestedExecutionDate
RequestedModification10 *-- "0..1" SettlementDateTimeIndication1 : SettlementTimeIndication
RequestedModification10 *-- "0..1" IAmountType4Choice : Amount
RequestedModification10 *-- "0..1" PartyIdentification135 : UltimateDebtor
RequestedModification10 *-- "0..1" PartyIdentification135 : Debtor
RequestedModification10 *-- "0..1" CashAccount40 : DebtorAccount
RequestedModification10 *-- "0..1" CashAccount40 : DebtorAgentAccount
RequestedModification10 *-- "0..1" SettlementInstruction13 : SettlementInformation
RequestedModification10 *-- "0..1" CashAccount40 : CreditorAgentAccount
RequestedModification10 *-- "0..1" PartyIdentification135 : Creditor
RequestedModification10 *-- "0..1" CashAccount40 : CreditorAccount
RequestedModification10 *-- "0..1" PartyIdentification135 : UltimateCreditor
RequestedModification10 *-- "0..1" IPurpose2Choice : Purpose
RequestedModification10 *-- "0..0" InstructionForNextAgent1 : InstructionForNextAgent
RequestedModification10 *-- "0..0" InstructionForCreditorAgent3 : InstructionForCreditorAgent
RequestedModification10 *-- "0..10" RemittanceLocation7 : RelatedRemittanceInformation
RequestedModification10 *-- "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
%% SettlementDateTimeIndication1 recursion level 1 with max 1
class SettlementDateTimeIndication1{
    DebitDateTime IsoISODateTime
    CreditDateTime IsoISODateTime
}
%% 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
%% 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
%% SettlementInstruction13 recursion level 1 with max 1
SettlementInstruction13 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructingReimbursementAgent
SettlementInstruction13 *-- "0..1" CashAccount40 : InstructingReimbursementAgentAccount
SettlementInstruction13 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructedReimbursementAgent
SettlementInstruction13 *-- "0..1" CashAccount40 : InstructedReimbursementAgentAccount
%% 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
%% 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
  

RequestedModification10 members

InstructionForAssignee building block

Further information related to the processing of the investigation that may need to be acted upon by the assignee. Further information related to the processing of the investigation that may need to be acted upon by the assignee. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InstructionForAssignee1 recursion level 0 with max 1
class InstructionForAssignee1{
    Code ExternalAgentInstruction1Code
    InstructionInformation IsoMax140Text
}
  

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

classDiagram
    class IOuterRecord
    RequestToModifyPaymentV08 --|> IOuterRecord : Implements
    RequestToModifyPaymentV08Document --|> IOuterDocument~RequestToModifyPaymentV08~ : Implements
    class IOuterDocument~RequestToModifyPaymentV08~ {
        RequestToModifyPaymentV08 Message
     }
  

Document wrapper for serialization

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

classDiagram
    RequestToModifyPaymentV08Document *-- RequestToModifyPaymentV08 : 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.08">
    <ReqToModfyPmt>
        <Assgnmt>
            <!-- Assignment inner content -->
        </Assgnmt>
        <Case>
            <!-- Case inner content -->
        </Case>
        <Undrlyg>
            <!-- Underlying inner content -->
        </Undrlyg>
        <Mod>
            <!-- Modification inner content -->
        </Mod>
        <InstrForAssgne>
            <!-- InstructionForAssignee inner content -->
        </InstrForAssgne>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </ReqToModfyPmt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_IBkAj9cBEeq_l4BJLVUF2Q"
  previousVersion="_LwBa4cP_Eemsic1bQcEtLA"
  name="RequestToModifyPaymentV08"
  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;- ResolutionOfInvestigation message with a positive final outcome when the case assignee can perform the requested modification;&#xD;&#xA;- ResolutionOfInvestigation 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;- RejectCaseAssignment message when the case assignee is unable or not authorised to perform the requested modification;&#xD;&#xA;- NotificationOfCaseAssignment 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 RequestToModifyPayment message covers one and only one original instruction at a time. If several original payment instructions need to be modified, then multiple RequestToModifyPayment messages must be sent.&#xD;&#xA;The RequestToModifyPayment 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 RequestToModifyPayment 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 ResolutionOfInvestigation message. (See section on ResolutionOfInvestigation for more details).&#xD;&#xA;The RequestToModifyPayment message must never be sent to request the modification of the currency of the original payment instruction. If the currency is wrong, use a CustomerPaymentCancellationRequest or a FIToFIPaymentCancellationRequest message to cancel it and issue and a new payment instruction.&#xD;&#xA;The RequestToModifyPayment message may be forwarded to subsequent case assignee(s).&#xD;&#xA;When a RequestToModifyPayment 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 ResolutionOfInvestigation 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 RequestToModifyPayment 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 CustomerPaymentCancellationRequest or a FIToFIPaymentCancellationRequest 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 AdditionalPaymentInformation message sent to the creditor of the original payment instruction;&#xD;&#xA;- a DebitAuthorisationRequest message sent to the creditor of the original payment instruction;&#xD;&#xA;- a CustomerPaymentCancellationRequest or a FIToFIPaymentCancellationRequest message sent to a subsequent case assignee.&#xD;&#xA;The RequestToModifyPayment message can be sent to correct characteristics of an original payment instruction following receipt of an UnableToApply 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, that is the cover is executed through the agent(s) mentioned in the RequestToModifyPayment 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 NotificationOfCaseAssignment message must be sent to the case assigner. Otherwise, the request to modify payment case must be rejected (by means of a negative ResolutionOfInvestigation message)."
  registrationStatus="Registered"
  messageSet="_moz48_2VEeGjgKzdN0DbWA"
  xmlTag="ReqToModfyPmt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_IBkAl9cBEeq_l4BJLVUF2Q"
    previousVersion="_LwBa6cP_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="_IBkAmdcBEeq_l4BJLVUF2Q"
    previousVersion="_LwBa68P_Eemsic1bQcEtLA"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Case"
    complexType="_8BF4W248EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_IBkAm9cBEeq_l4BJLVUF2Q"
    previousVersion="_LwBa7cP_Eemsic1bQcEtLA"
    name="Underlying"
    definition="Identifies the payment transaction to be modified."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Undrlyg"
    complexType="_ef6I4dcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_IBkAndcBEeq_l4BJLVUF2Q"
    previousVersion="_LwBa78P_Eemsic1bQcEtLA"
    name="Modification"
    definition="Identifies the list of modifications requested."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Mod"
    complexType="_cwVosdcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_IBkAn9cBEeq_l4BJLVUF2Q"
    previousVersion="_LwBa8cP_Eemsic1bQcEtLA"
    name="InstructionForAssignee"
    definition="Further information related to the processing of the investigation that may need to be acted upon by the assignee."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="InstrForAssgne"
    complexType="_cj1mAdA1EeeCAfThR1cp_Q" />
  <messageBuildingBlock
    xmi:id="_IBkAodcBEeq_l4BJLVUF2Q"
    previousVersion="_LwBa88P_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="087"
    flavour="001"
    version="08" />
</messageDefinition>

ISO Building Blocks

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