pain.013.001.10
The CreditorPaymentActivationRequest message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor.
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
%% CreditorPaymentActivationRequestV10 recursion level 0 with max 0
CreditorPaymentActivationRequestV10 *-- "1..1" GroupHeader105 : GroupHeader
CreditorPaymentActivationRequestV10 *-- "1..1" PaymentInstruction42 : PaymentInformation
CreditorPaymentActivationRequestV10 *-- "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
%% GroupHeader105 recursion level 0 with max 1
class GroupHeader105{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
NumberOfTransactions IsoMax15NumericText
ControlSum IsoDecimalNumber
}
GroupHeader105 *-- "1..1" PartyIdentification135 : InitiatingParty
GroupHeader105 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ForwardingAgent
%% 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
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
GroupHeader105 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 the message was created. | 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. | PartyIdentification135 - Required 1..1 |
| ForwardingAgent | Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution. | BranchAndFinancialInstitutionIdentification6 - Optional 0..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
%% PaymentInstruction42 recursion level 0 with max 1
class PaymentInstruction42{
PaymentInformationIdentification IsoMax35Text
PaymentMethod PaymentMethod7Code
ChargeBearer ChargeBearerType1Code
}
PaymentInstruction42 *-- "0..1" AdviceType1 : RequestedAdviceType
PaymentInstruction42 *-- "0..1" PaymentTypeInformation26 : PaymentTypeInformation
PaymentInstruction42 *-- "0..1" IDateAndDateTime2Choice : RequestedExecutionDate
PaymentInstruction42 *-- "0..1" IDateAndDateTime2Choice : ExpiryDate
PaymentInstruction42 *-- "0..1" PaymentCondition1 : PaymentCondition
PaymentInstruction42 *-- "1..1" PartyIdentification135 : Debtor
PaymentInstruction42 *-- "0..1" CashAccount40 : DebtorAccount
PaymentInstruction42 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
PaymentInstruction42 *-- "0..1" CashAccount40 : DebtorAgentAccount
PaymentInstruction42 *-- "0..1" PartyIdentification135 : UltimateDebtor
PaymentInstruction42 *-- "1..0" CreditTransferTransaction57 : CreditTransferTransaction
%% AdviceType1 recursion level 1 with max 1
AdviceType1 *-- "0..1" IAdviceType1Choice : CreditAdvice
AdviceType1 *-- "0..1" IAdviceType1Choice : DebitAdvice
%% PaymentTypeInformation26 recursion level 1 with max 1
class PaymentTypeInformation26{
InstructionPriority Priority2Code
}
PaymentTypeInformation26 *-- "0..0" IServiceLevel8Choice : ServiceLevel
PaymentTypeInformation26 *-- "0..1" ILocalInstrument2Choice : LocalInstrument
PaymentTypeInformation26 *-- "0..1" ICategoryPurpose1Choice : CategoryPurpose
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% PaymentCondition1 recursion level 1 with max 1
class PaymentCondition1{
AmountModificationAllowed IsoTrueFalseIndicator
EarlyPaymentAllowed IsoTrueFalseIndicator
DelayPenalty IsoMax140Text
GuaranteedPaymentRequested IsoTrueFalseIndicator
}
PaymentCondition1 *-- "0..1" IAmountOrRate1Choice : ImmediatePaymentRebate
%% 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
%% 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
%% CreditTransferTransaction57 recursion level 1 with max 1
class CreditTransferTransaction57{
ChargeBearer ChargeBearerType1Code
}
CreditTransferTransaction57 *-- "1..1" PaymentIdentification6 : PaymentIdentification
CreditTransferTransaction57 *-- "0..1" PaymentTypeInformation26 : PaymentTypeInformation
CreditTransferTransaction57 *-- "0..1" PaymentCondition1 : PaymentCondition
CreditTransferTransaction57 *-- "0..1" IDateAndDateTime2Choice : RequestedExecutionDate
CreditTransferTransaction57 *-- "1..1" IAmountType4Choice : Amount
CreditTransferTransaction57 *-- "0..1" CreditTransferMandateData1 : MandateRelatedInformation
CreditTransferTransaction57 *-- "0..1" Cheque16 : ChequeInstruction
CreditTransferTransaction57 *-- "0..1" PartyIdentification135 : UltimateDebtor
CreditTransferTransaction57 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent1
CreditTransferTransaction57 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent2
CreditTransferTransaction57 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : IntermediaryAgent3
CreditTransferTransaction57 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent
CreditTransferTransaction57 *-- "0..1" CashAccount40 : CreditorAgentAccount
CreditTransferTransaction57 *-- "1..1" PartyIdentification135 : Creditor
CreditTransferTransaction57 *-- "0..1" CashAccount40 : CreditorAccount
CreditTransferTransaction57 *-- "0..1" PartyIdentification135 : UltimateCreditor
CreditTransferTransaction57 *-- "0..0" InstructionForCreditorAgent3 : InstructionForCreditorAgent
CreditTransferTransaction57 *-- "0..1" IPurpose2Choice : Purpose
CreditTransferTransaction57 *-- "0..10" RegulatoryReporting3 : RegulatoryReporting
CreditTransferTransaction57 *-- "0..1" TaxInformation10 : Tax
CreditTransferTransaction57 *-- "0..10" RemittanceLocation7 : RelatedRemittanceInformation
CreditTransferTransaction57 *-- "0..1" RemittanceInformation21 : RemittanceInformation
CreditTransferTransaction57 *-- "0..0" Document12 : EnclosedFile
CreditTransferTransaction57 *-- "0..0" SupplementaryData1 : SupplementaryData
PaymentInstruction42 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 |
| RequestedAdviceType | Type of advice details requested. | AdviceType1 - Optional 0..1 |
| PaymentTypeInformation | Set of elements used to further specify the type of transaction. | PaymentTypeInformation26 - 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. | IDateAndDateTime2Choice - Optional 0..1 |
| ExpiryDate | Date by which the debtor must have accepted or rejected the request. Usage: Beyond this date, the request becomes void and cannot be processed anymore. | IDateAndDateTime2Choice - Optional 0..1 |
| PaymentCondition | Conditions for the execution of the payment. | PaymentCondition1 - Optional 0..1 |
| Debtor | Party that owes an amount of money to the (ultimate) creditor. | PartyIdentification135 - Required 1..1 |
| DebtorAccount | Account used to process charges associated with a transaction. | CashAccount40 - Optional 0..1 |
| DebtorAgent | Financial institution servicing an account for the debtor. | BranchAndFinancialInstitutionIdentification6 - Required 1..1 |
| DebtorAgentAccount | Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. | CashAccount40 - Optional 0..1 |
| UltimateDebtor | Ultimate party that owes an amount of money to the (ultimate) creditor. | PartyIdentification135 - 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. | CreditTransferTransaction57 - 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 CreditorPaymentActivationRequestV10 implementation follows a specific implementaiton pattern. First of all, CreditorPaymentActivationRequestV10 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CreditorPaymentActivationRequestV10Document implements IOuterDocument. Because CreditorPaymentActivationRequestV10 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CreditorPaymentActivationRequestV10.
classDiagram
class IOuterRecord
CreditorPaymentActivationRequestV10 --|> IOuterRecord : Implements
CreditorPaymentActivationRequestV10Document --|> IOuterDocument~CreditorPaymentActivationRequestV10~ : Implements
class IOuterDocument~CreditorPaymentActivationRequestV10~ {
CreditorPaymentActivationRequestV10 Message
}
Document wrapper for serialization
The only real purpose CreditorPaymentActivationRequestV10Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.013.001.10’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CreditorPaymentActivationRequestV10.ToDocument() method. The returned CreditorPaymentActivationRequestV10Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CreditorPaymentActivationRequestV10Document *-- CreditorPaymentActivationRequestV10 : 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.10">
<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="_XXWvgQLFEe2X55dNQNVKfg"
previousVersion="_CUbemdcBEeq_l4BJLVUF2Q"
name="CreditorPaymentActivationRequestV10"
definition="The CreditorPaymentActivationRequest message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor."
registrationStatus="Registered"
messageSet="_RZFL1f2VEeGjgKzdN0DbWA"
xmlTag="CdtrPmtActvtnReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_XXWvgwLFEe2X55dNQNVKfg"
previousVersion="_CUbem9cBEeq_l4BJLVUF2Q"
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="_XXWvkQLFEe2X55dNQNVKfg"
previousVersion="_CUbeodcBEeq_l4BJLVUF2Q"
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="_e6QgQQLFEe2X55dNQNVKfg" />
<messageBuildingBlock
xmi:id="_XXWvkwLFEe2X55dNQNVKfg"
previousVersion="_CUbeo9cBEeq_l4BJLVUF2Q"
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="_Uzy54QzGEe2Wmf2RrXviyA" />
<messageBuildingBlock
xmi:id="_XXWvlQLFEe2X55dNQNVKfg"
previousVersion="_CUbepdcBEeq_l4BJLVUF2Q"
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="10" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.