CreditorPaymentActivationRequestStatusReportV10

pain.014.001.10

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
%% CreditorPaymentActivationRequestStatusReportV10 recursion level 0 with max 0
CreditorPaymentActivationRequestStatusReportV10 *-- "1..1" GroupHeader106 : GroupHeader
CreditorPaymentActivationRequestStatusReportV10 *-- "1..1" OriginalGroupInformation30 : OriginalGroupInformationAndStatus
CreditorPaymentActivationRequestStatusReportV10 *-- "0..1" OriginalPaymentInstruction46 : OriginalPaymentInformationAndStatus
CreditorPaymentActivationRequestStatusReportV10 *-- "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
%% GroupHeader106 recursion level 0 with max 1
class GroupHeader106{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
GroupHeader106 *-- "1..1" PartyIdentification135 : InitiatingParty
GroupHeader106 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ForwardingAgent
GroupHeader106 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : DebtorAgent
GroupHeader106 *-- "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
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
  

GroupHeader106 members

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

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
%% OriginalPaymentInstruction46 recursion level 0 with max 1
class OriginalPaymentInstruction46{
    OriginalPaymentInformationIdentification IsoMax35Text
    OriginalNumberOfTransactions IsoMax15NumericText
    OriginalControlSum IsoDecimalNumber
    PaymentInformationStatus ExternalPaymentGroupStatus1Code
}
OriginalPaymentInstruction46 *-- "0..0" StatusReasonInformation12 : StatusReasonInformation
OriginalPaymentInstruction46 *-- "0..0" NumberOfTransactionsPerStatus5 : NumberOfTransactionsPerStatus
OriginalPaymentInstruction46 *-- "0..0" PaymentTransaction145 : 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
}
%% PaymentTransaction145 recursion level 1 with max 1
class PaymentTransaction145{
    StatusIdentification IsoMax35Text
    OriginalInstructionIdentification IsoMax35Text
    OriginalEndToEndIdentification IsoMax35Text
    OriginalUETR IsoUUIDv4Identifier
    TransactionStatus ExternalPaymentTransactionStatus1Code
    DebtorDecisionDateTime IsoISODateTime
    AcceptanceDateTime IsoISODateTime
    AccountServicerReference IsoMax35Text
    ClearingSystemReference IsoMax35Text
}
PaymentTransaction145 *-- "0..0" StatusReasonInformation12 : StatusReasonInformation
PaymentTransaction145 *-- "0..1" PaymentConditionStatus1 : PaymentConditionStatus
PaymentTransaction145 *-- "0..0" Charges12 : ChargesInformation
PaymentTransaction145 *-- "0..1" OriginalTransactionReference38 : OriginalTransactionReference
PaymentTransaction145 *-- "0..0" Document12 : EnclosedFile
PaymentTransaction145 *-- "0..0" SupplementaryData1 : SupplementaryData
  

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

classDiagram
    class IOuterRecord
    CreditorPaymentActivationRequestStatusReportV10 --|> IOuterRecord : Implements
    CreditorPaymentActivationRequestStatusReportV10Document --|> IOuterDocument~CreditorPaymentActivationRequestStatusReportV10~ : Implements
    class IOuterDocument~CreditorPaymentActivationRequestStatusReportV10~ {
        CreditorPaymentActivationRequestStatusReportV10 Message
     }
  

Document wrapper for serialization

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

classDiagram
    CreditorPaymentActivationRequestStatusReportV10Document *-- CreditorPaymentActivationRequestStatusReportV10 : 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.10">
    <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="_qzYDUQLFEe2X55dNQNVKfg"
  previousVersion="_CUa3cdcBEeq_l4BJLVUF2Q"
  name="CreditorPaymentActivationRequestStatusReportV10"
  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="_RZFL1f2VEeGjgKzdN0DbWA"
  xmlTag="CdtrPmtActvtnReqStsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_qzYDUwLFEe2X55dNQNVKfg"
    previousVersion="_CUbegdcBEeq_l4BJLVUF2Q"
    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="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;WithInList&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;ValidationRuleRejected1Code&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;WithInList&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;ValidationRuleStatus1Code&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_qzYDVQLFEe2X55dNQNVKfg"
    previousVersion="_CUbeg9cBEeq_l4BJLVUF2Q"
    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="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;WithInList&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;ValidationRuleRejected1Code&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;WithInList&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;ValidationRulePending1Code&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_qzYDVwLFEe2X55dNQNVKfg"
    previousVersion="_CUbehdcBEeq_l4BJLVUF2Q"
    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="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;WithInList&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;ValidationRuleRejected1Code&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;WithInList&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;ValidationRuleRejected1Code&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_qzYDWQLFEe2X55dNQNVKfg"
    previousVersion="_CUbeh9cBEeq_l4BJLVUF2Q"
    name="GroupStatusReceivedRule"
    definition="If OriginalGroupInformationAndStatus/GroupStatus is present and is equal to RCVD (Received), then OriginalPaymentInformationAndStatus/PaymentInformationStatus is not allowed."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[*]/PaymentInformationStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;WithInList&quot;&gt;&lt;leftOperand&gt;/OriginalGroupInformationAndStatus/GroupStatus&lt;/leftOperand&gt;&lt;rightOperand&gt;ValidationRuleReceived1Code&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/OriginalPaymentInformationAndStatus[1]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_qzYDWwLFEe2X55dNQNVKfg"
    previousVersion="_CUbeidcBEeq_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="_qzYDZQLFEe2X55dNQNVKfg"
    previousVersion="_CUbekdcBEeq_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="_NKkV8QLGEe2X55dNQNVKfg" />
  <messageBuildingBlock
    xmi:id="_qzYDZwLFEe2X55dNQNVKfg"
    previousVersion="_CUbek9cBEeq_l4BJLVUF2Q"
    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="_qzYDaQLFEe2X55dNQNVKfg"
    previousVersion="_CUbeldcBEeq_l4BJLVUF2Q"
    name="OriginalPaymentInformationAndStatus"
    definition="Information concerning the original payment information, to which the status report message refers."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="OrgnlPmtInfAndSts"
    complexType="_OJv0exlWEe2Do_UtrNmb2g" />
  <messageBuildingBlock
    xmi:id="_qzYDawLFEe2X55dNQNVKfg"
    previousVersion="_CUbel9cBEeq_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="014"
    flavour="001"
    version="10" />
</messageDefinition>

ISO Building Blocks

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