Iso20022

CreditorPaymentActivationRequestV04

pain.013.001.04

The CreditorPaymentActivationRequest message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used to initiate a creditor payment activation request.

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
%% CreditorPaymentActivationRequestV04 recursion level 0 with max 0
CreditorPaymentActivationRequestV04 *-- "1..1" GroupHeader45 : GroupHeader
CreditorPaymentActivationRequestV04 *-- "1..1" PaymentInstruction17 : PaymentInformation
CreditorPaymentActivationRequestV04 *-- "0..1" SupplementaryData1 : SupplementaryData

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

GroupHeader building block

Set of characteristics shared by all individual transactions included in the message. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% GroupHeader45 recursion level 0 with max 1
class GroupHeader45{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
}
GroupHeader45 *-- "1..1" PartyIdentification43 : InitiatingParty
%% 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

GroupHeader45 members

Member name Description Data Type / Multiplicity
MessageIdentification Point to point reference assigned by the instructing party and sent to the next party in the chain to unambiguously identify the message. Usage: The instructing party has to make sure that ‘MessageIdentification’ is unique per instructed party for a pre-agreed period. IsoMax35Text - Required 1..1
CreationDateTime Date and time at which a (group of) payment instruction(s) was created by the instructing party. IsoISODateTime - Required 1..1
NumberOfTransactions Number of individual transactions contained in the message. IsoMax15NumericText - Required 1..1
ControlSum Total of all individual amounts included in the message, irrespective of currencies. IsoDecimalNumber - Optional 0..1
InitiatingParty Party initiating the creditor payment activation request. This can either be the creditor himself or the party that initiates the request on behalf of the creditor. PartyIdentification43 - Required 1..1

PaymentInformation building block

Set of characteristics that applies to the debit side of the payment transactions included in the creditor payment initiation. Instruction to pay an amount of money to an ultimate beneficiary, on behalf of an originator. This instruction may have to be forwarded several times to complete the settlement chain. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PaymentInstruction17 recursion level 0 with max 1
class PaymentInstruction17{
    PaymentInformationIdentification IsoMax35Text
    PaymentMethod PaymentMethod7Code
    RequestedExecutionDate IsoISODate
    ChargeBearer ChargeBearerType1Code
}
PaymentInstruction17 *-- "0..1" PaymentTypeInformation19 : PaymentTypeInformation
PaymentInstruction17 *-- "1..1" PartyIdentification43 : Debtor
PaymentInstruction17 *-- "0..1" CashAccount24 : DebtorAccount
PaymentInstruction17 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
PaymentInstruction17 *-- "0..1" PartyIdentification43 : UltimateDebtor
PaymentInstruction17 *-- "1..0" CreditTransferTransaction21 : CreditTransferTransaction
%% PaymentTypeInformation19 recursion level 1 with max 1
class PaymentTypeInformation19{
    InstructionPriority Priority2Code
}
PaymentTypeInformation19 *-- "0..1" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation19 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation19 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% 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
%% 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
%% CreditTransferTransaction21 recursion level 1 with max 1
class CreditTransferTransaction21{
    ChargeBearer ChargeBearerType1Code
}
CreditTransferTransaction21 *-- "1..1" PaymentIdentification1 : PaymentIdentification
CreditTransferTransaction21 *-- "0..1" PaymentTypeInformation19 : PaymentTypeInformation
CreditTransferTransaction21 *-- "1..1" IAmountType4Choice : Amount
CreditTransferTransaction21 *-- "0..1" Cheque7 : ChequeInstruction
CreditTransferTransaction21 *-- "0..1" PartyIdentification43 : UltimateDebtor
CreditTransferTransaction21 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent1
CreditTransferTransaction21 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent2
CreditTransferTransaction21 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent3
CreditTransferTransaction21 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent
CreditTransferTransaction21 *-- "1..1" PartyIdentification43 : Creditor
CreditTransferTransaction21 *-- "0..1" CashAccount24 : CreditorAccount
CreditTransferTransaction21 *-- "0..1" PartyIdentification43 : UltimateCreditor
CreditTransferTransaction21 *-- "0..0" InstructionForCreditorAgent1 : InstructionForCreditorAgent
CreditTransferTransaction21 *-- "0..1" IPurpose2Choice : Purpose
CreditTransferTransaction21 *-- "0..10" RegulatoryReporting3 : RegulatoryReporting
CreditTransferTransaction21 *-- "0..1" TaxInformation3 : Tax
CreditTransferTransaction21 *-- "0..10" RemittanceLocation4 : RelatedRemittanceInformation
CreditTransferTransaction21 *-- "0..1" RemittanceInformation10 : RemittanceInformation
CreditTransferTransaction21 *-- "0..0" SupplementaryData1 : SupplementaryData

PaymentInstruction17 members

Member name Description Data Type / Multiplicity
PaymentInformationIdentification Reference assigned by a sending party to unambiguously identify the payment information block within the message. IsoMax35Text - Optional 0..1
PaymentMethod Specifies the means of payment that will be used to move the amount of money. PaymentMethod7Code - Required 1..1
PaymentTypeInformation Set of elements used to further specify the type of transaction. PaymentTypeInformation19 - Optional 0..1
RequestedExecutionDate Date at which the initiating party requests the clearing agent to process the payment. If payment by cheque, the date when the cheque must be generated by the bank. Usage: This is the date on which the debtor’s account(s) is (are) to be debited. IsoISODate - Required 1..1
Debtor Party that owes an amount of money to the (ultimate) creditor. PartyIdentification43 - Required 1..1
DebtorAccount Account used to process charges associated with a transaction. CashAccount24 - Optional 0..1
DebtorAgent Financial institution servicing an account for the debtor. BranchAndFinancialInstitutionIdentification5 - Required 1..1
UltimateDebtor Ultimate party that owes an amount of money to the (ultimate) creditor. PartyIdentification43 - Optional 0..1
ChargeBearer Specifies which party/parties will bear the charges associated with the processing of the payment transaction. ChargeBearerType1Code - Optional 0..1
CreditTransferTransaction Payment processes required to transfer cash from the debtor to the creditor. CreditTransferTransaction21 - Unknown 1..0

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

classDiagram
    class IOuterRecord
    CreditorPaymentActivationRequestV04 --|> IOuterRecord : Implements
    CreditorPaymentActivationRequestV04Document --|> IOuterDocument~CreditorPaymentActivationRequestV04~ : Implements
    class IOuterDocument~CreditorPaymentActivationRequestV04~ {
        CreditorPaymentActivationRequestV04 Message
     }

Document wrapper for serialization

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

classDiagram
    CreditorPaymentActivationRequestV04Document *-- CreditorPaymentActivationRequestV04 : 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:pain.013.001.04">
    <CdtrPmtActvtnReq>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <PmtInf>
            <!-- PaymentInformation inner content -->
        </PmtInf>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CdtrPmtActvtnReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_BK4QQU_HEeSNduMozFyRUg"
  nextVersions="_akmd4TqxEeWZFYSPlduMhw"
  previousVersion="_qwFzwTijEeKpHbBQ3XWFBw"
  name="CreditorPaymentActivationRequestV04"
  definition="The CreditorPaymentActivationRequest message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used to initiate a creditor payment activation request."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CdtrPmtActvtnReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_BK4QQ0_HEeSNduMozFyRUg"
    nextVersions="_akmd4zqxEeWZFYSPlduMhw"
    previousVersion="_NWrXk8beEeK2p4LkLN96KA"
    name="SupplementaryDataRule"
    definition="The SupplementaryData building block at message level must not be used to provide additional information about a transaction. The SupplementaryData element at transaction level should be used for that purpose."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_BK4QRU_HEeSNduMozFyRUg"
    nextVersions="_akmd5TqxEeWZFYSPlduMhw"
    previousVersion="_qwFzyzijEeKpHbBQ3XWFBw"
    name="GroupHeader"
    definition="Set of characteristics shared by all individual transactions included in the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_QmL0Q9p-Ed-ak6NoX_4Aeg_1336812673" />
  <messageBuildingBlock
    xmi:id="_BK4QR0_HEeSNduMozFyRUg"
    nextVersions="_akmd5zqxEeWZFYSPlduMhw"
    previousVersion="_qwFzzzijEeKpHbBQ3XWFBw"
    name="PaymentInformation"
    definition="Set of characteristics that applies to the debit side of the payment transactions included in the creditor payment initiation."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="PmtInf"
    complexType="_bG7QoU_JEeSNduMozFyRUg" />
  <messageBuildingBlock
    xmi:id="_BK4QSU_HEeSNduMozFyRUg"
    nextVersions="_akmd6TqxEeWZFYSPlduMhw"
    previousVersion="_qwFz0zijEeKpHbBQ3XWFBw"
    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="pain"
    messageFunctionality="013"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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