pain.014.001.09
The CreditorPaymentActivationRequestStatusReport message is sent by a party to the next party in the creditor payment activation request chain. It is used to inform the latter about the positive or negative status of a creditor payment activation request (either single or file).
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
%% CreditorPaymentActivationRequestStatusReportV09 recursion level 0 with max 0
CreditorPaymentActivationRequestStatusReportV09 *-- "1..1" GroupHeader87 : GroupHeader
CreditorPaymentActivationRequestStatusReportV09 *-- "1..1" OriginalGroupInformation30 : OriginalGroupInformationAndStatus
CreditorPaymentActivationRequestStatusReportV09 *-- "0..1" OriginalPaymentInstruction42 : OriginalPaymentInformationAndStatus
CreditorPaymentActivationRequestStatusReportV09 *-- "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
%% GroupHeader87 recursion level 0 with max 1
class GroupHeader87{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
GroupHeader87 *-- "1..1" PartyIdentification135 : InitiatingParty
GroupHeader87 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
GroupHeader87 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : CreditorAgent
%% 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
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
GroupHeader87 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. | |
| CreationDateTime | Date and time at which the status report was created by the instructing party. | IsoISODateTime - Required 1..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 |
| DebtorAgent | Financial institution servicing an account for the debtor. | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
| CreditorAgent | Financial institution servicing an account for the creditor. | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
OriginalGroupInformationAndStatus building block
Original group information concerning the group of transactions, to which the status report message refers to. Provides information on the original group, to which the message refers. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% OriginalGroupInformation30 recursion level 0 with max 1
class OriginalGroupInformation30{
OriginalMessageIdentification IsoMax35Text
OriginalMessageNameIdentification IsoMax35Text
OriginalCreationDateTime IsoISODateTime
OriginalNumberOfTransactions IsoMax15NumericText
OriginalControlSum IsoDecimalNumber
GroupStatus ExternalPaymentGroupStatus1Code
}
OriginalGroupInformation30 *-- "0..0" StatusReasonInformation12 : StatusReasonInformation
OriginalGroupInformation30 *-- "0..0" NumberOfTransactionsPerStatus5 : NumberOfTransactionsPerStatus
%% StatusReasonInformation12 recursion level 1 with max 1
class StatusReasonInformation12{
AdditionalInformation IsoMax105Text
}
StatusReasonInformation12 *-- "0..1" PartyIdentification135 : Originator
StatusReasonInformation12 *-- "0..1" IStatusReason6Choice : Reason
%% NumberOfTransactionsPerStatus5 recursion level 1 with max 1
class NumberOfTransactionsPerStatus5{
DetailedNumberOfTransactions IsoMax15NumericText
DetailedStatus ExternalPaymentTransactionStatus1Code
DetailedControlSum IsoDecimalNumber
}
OriginalGroupInformation30 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalMessageIdentification | Point to point reference, as assigned by the original instructing party, to unambiguously identify the original message. | IsoMax35Text - Required 1..1 |
| OriginalMessageNameIdentification | Specifies the original message name identifier to which the message refers. | IsoMax35Text - Required 1..1 |
| OriginalCreationDateTime | Date and time at which the original message was created. | IsoISODateTime - Optional 0..1 |
| OriginalNumberOfTransactions | Number of individual transactions contained in the original message. | IsoMax15NumericText - Optional 0..1 |
| OriginalControlSum | Total of all individual amounts included in the original message, irrespective of currencies. | IsoDecimalNumber - Optional 0..1 |
| GroupStatus | Specifies the status of a group of transactions. | ExternalPaymentGroupStatus1Code - Optional 0..1 |
| StatusReasonInformation | Set of elements used to provide detailed information on the status reason. | StatusReasonInformation12 - Unknown 0..0 |
| NumberOfTransactionsPerStatus | Detailed information on the number of transactions for each identical transaction status. | NumberOfTransactionsPerStatus5 - Unknown 0..0 |
OriginalPaymentInformationAndStatus building block
Information concerning the original payment information, to which the status report message refers. Provides details on the original transactions, to which the status report message refers. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% OriginalPaymentInstruction42 recursion level 0 with max 1
class OriginalPaymentInstruction42{
OriginalPaymentInformationIdentification IsoMax35Text
OriginalNumberOfTransactions IsoMax15NumericText
OriginalControlSum IsoDecimalNumber
PaymentInformationStatus ExternalPaymentGroupStatus1Code
}
OriginalPaymentInstruction42 *-- "0..0" StatusReasonInformation12 : StatusReasonInformation
OriginalPaymentInstruction42 *-- "0..0" NumberOfTransactionsPerStatus5 : NumberOfTransactionsPerStatus
OriginalPaymentInstruction42 *-- "0..0" PaymentTransaction136 : TransactionInformationAndStatus
%% StatusReasonInformation12 recursion level 1 with max 1
class StatusReasonInformation12{
AdditionalInformation IsoMax105Text
}
StatusReasonInformation12 *-- "0..1" PartyIdentification135 : Originator
StatusReasonInformation12 *-- "0..1" IStatusReason6Choice : Reason
%% NumberOfTransactionsPerStatus5 recursion level 1 with max 1
class NumberOfTransactionsPerStatus5{
DetailedNumberOfTransactions IsoMax15NumericText
DetailedStatus ExternalPaymentTransactionStatus1Code
DetailedControlSum IsoDecimalNumber
}
%% PaymentTransaction136 recursion level 1 with max 1
class PaymentTransaction136{
StatusIdentification IsoMax35Text
OriginalInstructionIdentification IsoMax35Text
OriginalEndToEndIdentification IsoMax35Text
OriginalUETR IsoUUIDv4Identifier
TransactionStatus ExternalPaymentTransactionStatus1Code
DebtorDecisionDateTime IsoISODateTime
AcceptanceDateTime IsoISODateTime
AccountServicerReference IsoMax35Text
ClearingSystemReference IsoMax35Text
}
PaymentTransaction136 *-- "0..0" StatusReasonInformation12 : StatusReasonInformation
PaymentTransaction136 *-- "0..1" PaymentConditionStatus1 : PaymentConditionStatus
PaymentTransaction136 *-- "0..0" Charges7 : ChargesInformation
PaymentTransaction136 *-- "0..1" OriginalTransactionReference37 : OriginalTransactionReference
PaymentTransaction136 *-- "0..0" Document12 : EnclosedFile
PaymentTransaction136 *-- "0..0" SupplementaryData1 : SupplementaryData
OriginalPaymentInstruction42 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalPaymentInformationIdentification | Unique identification, as assigned by the original sending party, to unambiguously identify the original payment information group. | IsoMax35Text - Required 1..1 |
| OriginalNumberOfTransactions | Number of individual transactions contained in the original payment information group. | IsoMax15NumericText - Optional 0..1 |
| OriginalControlSum | Total of all individual amounts included in the original payment information group, irrespective of currencies. | IsoDecimalNumber - Optional 0..1 |
| PaymentInformationStatus | Specifies the status of the payment information group. | ExternalPaymentGroupStatus1Code - Optional 0..1 |
| StatusReasonInformation | Provides detailed information on the status reason. | StatusReasonInformation12 - Unknown 0..0 |
| NumberOfTransactionsPerStatus | Detailed information on the number of transactions for each identical transaction status. | NumberOfTransactionsPerStatus5 - Unknown 0..0 |
| TransactionInformationAndStatus | Provides information on the original transactions to which the status report message refers. | PaymentTransaction136 - Unknown 0..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 CreditorPaymentActivationRequestStatusReportV09 implementation follows a specific implementaiton pattern. First of all, CreditorPaymentActivationRequestStatusReportV09 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CreditorPaymentActivationRequestStatusReportV09Document implements IOuterDocument. Because CreditorPaymentActivationRequestStatusReportV09 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CreditorPaymentActivationRequestStatusReportV09.
classDiagram
class IOuterRecord
CreditorPaymentActivationRequestStatusReportV09 --|> IOuterRecord : Implements
CreditorPaymentActivationRequestStatusReportV09Document --|> IOuterDocument~CreditorPaymentActivationRequestStatusReportV09~ : Implements
class IOuterDocument~CreditorPaymentActivationRequestStatusReportV09~ {
CreditorPaymentActivationRequestStatusReportV09 Message
}
Document wrapper for serialization
The only real purpose CreditorPaymentActivationRequestStatusReportV09Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.014.001.09’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CreditorPaymentActivationRequestStatusReportV09.ToDocument() method. The returned CreditorPaymentActivationRequestStatusReportV09Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CreditorPaymentActivationRequestStatusReportV09Document *-- CreditorPaymentActivationRequestStatusReportV09 : 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.014.001.09">
<CdtrPmtActvtnReqStsRpt>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<OrgnlGrpInfAndSts>
<!-- OriginalGroupInformationAndStatus inner content -->
</OrgnlGrpInfAndSts>
<OrgnlPmtInfAndSts>
<!-- OriginalPaymentInformationAndStatus inner content -->
</OrgnlPmtInfAndSts>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CdtrPmtActvtnReqStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_CUa3cdcBEeq_l4BJLVUF2Q"
nextVersions="_qzYDUQLFEe2X55dNQNVKfg"
previousVersion="_Lv8ie8P_Eemsic1bQcEtLA"
name="CreditorPaymentActivationRequestStatusReportV09"
definition="The CreditorPaymentActivationRequestStatusReport message is sent by a party to the next party in the creditor payment activation request chain. It is used to inform the latter about the positive or negative status of a creditor payment activation request (either single or file)."
registrationStatus="Registered"
messageSet="_wRx2wk2rEeG_I4xRYCA_7g"
xmlTag="CdtrPmtActvtnReqStsRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_CUbegdcBEeq_l4BJLVUF2Q"
nextVersions="_qzYDUwLFEe2X55dNQNVKfg"
previousVersion="_Lv8ifcP_Eemsic1bQcEtLA"
name="GroupStatusAcceptedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to ACTC (AcceptedTechnicalValidation), ACCP (AcceptedCustomerProfile), ACSP (AcceptedSettlementInProcess), ACSC (AcceptedSettlementCompleted) or ACWC (AcceptedWithChange), then OriginalPaymentInformationAndStatus/PaymentInformationStatus must be different from RJCT (Rejected)."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand><rightOperand>ValidationRuleRejected1Code</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>ValidationRuleStatus1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_CUbeg9cBEeq_l4BJLVUF2Q"
nextVersions="_qzYDVQLFEe2X55dNQNVKfg"
previousVersion="_Lv8if8P_Eemsic1bQcEtLA"
name="GroupStatusPendingRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to PDNG (Pending), then OriginalPaymentInformationAndStatus/PaymentInformationStatus must be different from RJCT (Rejected)."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand><rightOperand>ValidationRuleRejected1Code</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>ValidationRulePending1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_CUbehdcBEeq_l4BJLVUF2Q"
nextVersions="_qzYDVwLFEe2X55dNQNVKfg"
previousVersion="_Lv8igcP_Eemsic1bQcEtLA"
name="GroupStatusRejectedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RJCT (Rejected), then OriginalPaymentInformationAndStatus/PaymentInformationStatus, if present, must be equal to RJCT (Rejected)."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand><rightOperand>ValidationRuleRejected1Code</rightOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>ValidationRuleRejected1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_CUbeh9cBEeq_l4BJLVUF2Q"
nextVersions="_qzYDWQLFEe2X55dNQNVKfg"
previousVersion="_Lv8ig8P_Eemsic1bQcEtLA"
name="GroupStatusReceivedRule"
definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RCVD (Received), then OriginalPaymentInformationAndStatus/PaymentInformationStatus is not allowed."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><ComplexRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ComplexRule"><mustBe><connector>AND</connector><BooleanRule xsi:type="Absence"><leftOperand>/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus</leftOperand></BooleanRule></mustBe><onCondition><connector>AND</connector><BooleanRule xsi:type="Presence"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand></BooleanRule><BooleanRule xsi:type="WithInList"><leftOperand>/OriginalGroupInformationAndStatus/GroupStatus</leftOperand><rightOperand>ValidationRuleReceived1Code</rightOperand></BooleanRule><BooleanRule xsi:type="Presence"><leftOperand>/OriginalPaymentInformationAndStatus[1]</leftOperand></BooleanRule></onCondition></ComplexRule></RuleDefinition>" />
<constraint
xmi:id="_CUbeidcBEeq_l4BJLVUF2Q"
nextVersions="_qzYDWwLFEe2X55dNQNVKfg"
previousVersion="_Lv8ihcP_Eemsic1bQcEtLA"
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="_CUbekdcBEeq_l4BJLVUF2Q"
nextVersions="_qzYDZQLFEe2X55dNQNVKfg"
previousVersion="_Lv8ijcP_Eemsic1bQcEtLA"
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="_SvmQkW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_CUbek9cBEeq_l4BJLVUF2Q"
nextVersions="_qzYDZwLFEe2X55dNQNVKfg"
previousVersion="_Lv8ij8P_Eemsic1bQcEtLA"
name="OriginalGroupInformationAndStatus"
definition="Original group information concerning the group of transactions, to which the status report message refers to."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="OrgnlGrpInfAndSts"
complexType="_XtP2UW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_CUbeldcBEeq_l4BJLVUF2Q"
nextVersions="_qzYDaQLFEe2X55dNQNVKfg"
previousVersion="_Lv8ikcP_Eemsic1bQcEtLA"
name="OriginalPaymentInformationAndStatus"
definition="Information concerning the original payment information, to which the status report message refers."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="OrgnlPmtInfAndSts"
complexType="_cdiBcdcZEeqRFcf2R4bPBw" />
<messageBuildingBlock
xmi:id="_CUbel9cBEeq_l4BJLVUF2Q"
nextVersions="_qzYDawLFEe2X55dNQNVKfg"
previousVersion="_Lv8ik8P_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="pain"
messageFunctionality="014"
flavour="001"
version="09" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.