Customer Documentation Message Status Report

Transcription

1 Customer Documentation Message Status Report Version 2.2 April 2018

2 THIS DOCUMENT ( DOCUMENT ) IS PROVIDED UNDER THE TERMS OF THIS RTP DOCUMENTATION AGREEMENT ("AGREEMENT"). ANY USE OR REPRODUCTION OF THE DOCUMENT CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. This Agreement is an agreement between Recipient and The Clearing House s Company, L.L.C. ( Payco ). Capitalized terms used but not defined in this Agreement shall have the meanings given to such terms in the Real-Time s Operating Rules or Real-Time s Participation Rules released by Payco from time to time (collectively, the Rules ) which are available for download at Payco s website, For purposes of this Agreement, Recipient means the person who receives this Document from Payco or, if the person who receives this Document from Payco is the representative of a juristic person, that juristic person. Subject to the terms of this Agreement, Payco hereby grants Recipient a worldwide, nonassignable, non-sublicensable, non-transferable, non-exclusive, royalty-free copyright license to reproduce this Document and prepare derivative works of this Document that are products and services that integrate with the Real-Time s service provided by Payco ( Works ) and publicly display, publicly perform, distribute and sublicense the Works (the License ). As a condition to exercising the rights and licenses granted hereunder, Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Works, it is Recipient's responsibility to acquire that license before distributing the Works. The Document is the property of Payco and Payco retains all right, title, and interest in and to the proprietary rights expressed in this document and the information contained therein. Recipient shall not disclose the Document to any third party and no rights in the Document are granted other than those specifically authorized by the License. Any reproduction of the Document must reproduce this Agreement, including partial copies. The Document must be returned to Payco or the Works and Document must be destroyed immediately, upon Payco s request. In the event of such a request, Recipient will provide a certification if it is a natural person, or a certification of a senior officer or executive if it is a representative of a juristic person, that all copies of the Document and Works have been destroyed or returned to Payco as required. If you are a Participant, you acknowledge and agree that this agreement and the licenses granted hereunder are subject to your Participant Agreement and the Rules, and you agree that nothing herein shall relieve you of your obligation to comply with the foregoing. In the event of a conflict between this Agreement and the Participant Agreement or the Rules, the Participant Agreement or the Rules, as applicable, shall control. EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON The Clearing House s Company L.L.C. 2

3 INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Recipient is solely responsible for determining the appropriateness of using the Document and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations. Recipient shall, at its sole cost and expense, indemnify and hold Payco and its affiliates harmless from and against any and all damages arising out of or related to Recipient s use and reproduction of the document and works. PAYCO SHALL HAVE NO LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR REPRODUCTION OF THE DOCUMENT OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER BY RECIPIENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. If Recipient institutes patent litigation against Payco or any affiliate of Payco (including a crossclaim or counterclaim in a lawsuit) alleging infringement of Recipient's patent(s), then the License of this Agreement shall terminate as of the date such litigation is filed. All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use of the Document and Works as soon as reasonably practicable. However, Recipient's obligations under this Agreement shall continue and survive. This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. Each party waives its rights to a jury trial in any resulting litigation The Clearing House s Company L.L.C. 3

4 CHANGES VERSION 2.0 TO VERSION 2.1 Section Change Comments Generally Changed references to Messages to Messages Added Occurrence Information overview Occurrence column updated to reflect RTP-specific usage rather than ISO general requirements. (These changes are also reflected in the Detail Message Field Descriptions for fields noted.) Occurrence column updated to reflect RTP-specific usage rather than ISO general requirements. This change was made to ensure alignment with terminology used in the RTP Network Operating Rules. This section was added to clarify the meaning of Occurrence within the Message Structure Description and Detail Message Field Descriptions. The following fields were updated from [0..1] to [1..1]: The following fields were updated from [1..1] to [0..1]: (These changes are also reflected in the Detail Message Field Descriptions for fields noted.) M/O/C column updated to reflect RTP product usage Message (Index 1.1) Format extended to 35 characters (originally defined as 31 characters). Additionally, a Rule is noted to show that the first 20 characters of message ID are validated structurally. If the structure is not as defined, RTP will reject with an Administration Advice message with Reason Code 650. The example was updated to reflect the format change. The following fields were updated as noted: : O field changed to C : All M fields changed to C : O field changed to C : All M fields changed to C : All M fields changed to C V2.0 format description: Pos Prefix "M" Pos File creation date in format YYYYMMDD Pos FI Identifier (9 digit Routing and Transit Number) Pos Message generation source ("B" if generated by a TCH FI) Pos Alphabetic serial identifier (2 alphabetic characters) Pos Message serial number (10 numeric characters) V2.1 format description: Pos Prefix "M" 2018 The Clearing House s Company L.L.C. 4

5 2.1.3 Sample Creation Date and Time (Index 1.2), Acceptance Date and Time (Index 3.101), and Interbank Settlement Date (Index 3.194) format added for Clearing System Reference (Index 3.103) updated to ensure that Creditor FI echoes the Clearing System Reference from the inbound pacs.008 to the outbound pacs Format description added to Member ID (Indexes and 3.151) Product usage added to Original Reference (Index 3.184) for clarity. Pos File creation date in format YYYYMMDD Pos FI Identifier (11 digit Participant ID) Pos Message generation source ("B" if generated by a TCH FI) Pos Alphabetic serial identifier (3 alphabetic characters) Pos Message serial number (11 numeric characters) None. None. Format is a 9 digit routing and transit number. None. CHANGES VERSION 2.1 TO VERSION 2.2 Section Change Comments Generally Non- Message changed to - Change to align with RTP Network Operating Rules. Message throughout the document. 1.6 New section 1.6 Added for clarity regarding use of the word Agent 1.7 New section 1.7 Included to provide clarity with regard to message types as defined by RTP Network Operating Rules Removed any instance of fix 0 (zero) as no amount available. Replaced with n/a. None Added a new row for Stand-Alone Remittance Advice (with pain.013) Changed M/O/C from M to C for indexes: Given usage of remt.001 in both the Credit Transfer and Request for use cases, the pacs.002 response will need to carry different values in each use case. The original row for Stand-Alone Remittance Advice contemplated the credit transfer use case only. None Updated product usage of Status Clarified which codes are eligible for use in Credit 2018 The Clearing House s Company L.L.C. 5

6 (Index 3.9) Updated Rules for Additional Information (Index 3.57) to include NARR as an applicable code for use of this field Updated (Credit Transfer) and Rules of Clearing System Reference (Index 3.103) to clarify the source of information for the pacs.002 message sent by the Creditor FI to RTP in the payment use case Updated ( Message) of Interbank Settlement Amount (Index 3.185) to include a reference to the table in section Added reason codes: - RC01 - RC Added reason code: Transfer use case vs. use case. Note that ACTC is not an acceptable Status Code for Message Status Reports. None. None. None. None. Code will not be returned to participants. For internal RTP testing purposes only The Clearing House s Company L.L.C. 6

7 Contents Changes Version 2.0 to Version CHANGES VERSION 2.1 TO VERSION Contents ABOUT THIS DOCUMENT Document Purpose Scope Acronyms Message Format Description and Overall Message Structure Occurrence Information Date /Time Format Agent Message Definitions MESSAGE STRUCTURE SPECIFICATION MESSAGE STATUS REPORT Message Status Report pacs Scope Message Structure Description Detail Message Field Description APPENDIX List and Usage of ISO Error Codes (Reject / Reason Codes) List and Usage of non-iso Error Codes (Reject / Reason Codes) The Clearing House s Company L.L.C. 7

8 1 ABOUT THIS DOCUMENT 1.1 Document Purpose 1.2 Scope This document defines the standard product message formats used within RTP, a real-time payment system from The Clearing House, for sending and receiving Message Status Reports, between RTP and Participants using the System. Participants should use this document as a reference as they develop their messaging systems to send and receive real-time messages in ISO format to RTP. It should be noted that in some instances, the terms, descriptions, or usages described in this document differ from terms and definitions used in the ISO standard. The terms, descriptions, and usages specified for RTP will apply to RTP credit transfers and payment related messages. This document covers the following: The message structure of the pacs message used in RTP The required data types and usage rules of the data fields in these messages This document does not include message flows for the pacs.002 message. 1.3 Acronyms Acronym BAH ET ISO TPSP UNIFI XML Description Business Application Header Eastern Time International Standards Organization Third Party Service Provider Universal Financial Industry Message scheme Extensible Mark-up Language 2018 The Clearing House s Company L.L.C. 8

9 1.4 Message Format Description and Overall Message Structure Message Status Report Version 2.2 Information about the message format and the overall message structure are provided in the document The Clearing House Business Application Header Version 2.0 chapters: 2 - Message Format Description 3 Overall Message Structure Occurrence Information The Message Structure Description and Detail Message Field Description Sections include an Occurrence definition that indicates how each field is to be used within RTP. These occurrence notations have two element. The first character is a binary indicator to show whether a field is mandatory (1) or optional (0). The second character indicates how many occurrences of the field are allowed within RTP usage. This starts at 1 occurrence and can extend to an unlimited number n. Notation Description [1..1] Is a mandatory single field with one occurrence [0..1] Is an optional field with one occurrence [0..n] Is an optional field with unlimited occurrences Please note that RTP product usage of each field is consistent with, but not always equal to, ISO defined occurrence. For example, ISO may define a field as optional with one occurrence [0..1], but such field may be defined as required with one occurrence [1..1] within RTP. Further, if a field is a mandatory sub-element of an optional field, the occurrence represents the nature of the sub-element should the optional field be present. For example, while Date and Place of Birth (Index within the Credit Transfer (pacs.008) message) is an optional field, if it is present, Birth Date, City of Birth, and Country of Birth must also be present. Therefore, these fields are represented as being mandatory with a single occurrence ([1..1]) even though they may not be present in every Credit Transfer message. Index XML Tag Element Name Occurr. Length M/O/C DtAndPlcOfBirth Date And Place Of Birth [0..1] C BirthDt Birth Date [1..1] 10 C CityOfBirth City Of Birth [1..1] 35 C CtryOfBirth Country Of Birth [1..1] 2 C 1 M mandatory / O optional / C - conditional 2018 The Clearing House s Company L.L.C. 9

10 1.5 Date /Time Format 1.6 Agent All message processing dates are required to be set to Eastern Time (Eastern Standard Time or Eastern Daylight Time, as applicable under the Energy Policy Act of 2005) by the message sender. This includes the following fields: Creation Date Time Interbank Settlement Date (set by RTP) Date field within the Business Reference field Date field within the Message field Date field within the Instruction field Date field within the field The term Agent is the entity which will always be a Member FI and party to a RTP payment / message and should be read in the context of the description in the. 1.7 Message Definitions Message Non- Message Message Message Definition An administrative message in the format specified in the RTP Technical Specifications that is transmitted between the RTP and a Participant, a -related Message, or a related Message Response. A message, other than a Message or a Message Response, in the format specified by the RTP Technical Specifications that is transmitted between Participants. A -related Message may be a Request for, a Request for Information, a Remittance Advice, a Acknowledgement, or a Request for Return of Funds. A message in the format specified by the RTPS Technical Specifications that a Sending Participant submits to the RTPS to instruct the Receiving Participant to pay a fixed amount of money to the Receiver to effectuate an RTPS The Clearing House s Company L.L.C. 10

11 2 MESSAGE STRUCTURE SPECIFICATION MESSAGE STATUS REPORT 2.1 Message Status Report pacs Scope The FI To FI Status Report message is used for different functions in RTP. Message Status Report of Credit Transfer (pacs.008) Message Status Report to all Messages Response to Credit Transfer Message The Message Status Report of Credit Transfer Message (pacs.002) provides information about the Response (i.e. Accept, Accept w/o Posting, or Reject) to the Credit Transfer (pacs.008) message. RTP will use the Message Status Report (pacs.002) to update the Debtor FI on the transaction status of the original Credit Transfer (pacs.008) message. This pacs.002 message can be either initiated by the Creditor FI (RTP acts as intermediary) or by the System (RTP). A further Message Status Report (pacs.002) is sent from RTP to the Creditor FI, to notify them that the system has completed processing a Credit Transfer and that the funds can be released to the customer Message Status Report Messages The Message Status Report (pacs.002) is used to provide a real time response to all Messages. The pacs.002 will confirm that the message has been received and whether or not it passed business validation. As such, the Message Status Report is effectively a "technical" response. Where a Message has been accepted by the receiving party, a subsequent response may also be required in order to fulfil the request contained within the message, or to advise that the request is being declined. The full list of Messages is as follows: Message Description ISO Schema Message Status Report pacs Request for pain Response to Request for pain System Time-out Message & Request for Return of Funds camt Response to Request for Return of Funds camt Stand-alone Remittance Advice remt Message Status Report of Credit Transfer is a response message without an additional Message Status Report 2018 The Clearing House s Company L.L.C. 11

12 Request for Information Response to Request for Information Acknowledgement camt camt camt Message Status Report (pacs.002) fields Message Message Status Report Data Source Original Message The following table provides the information which needs to be mapped to the fields on the Message Status Report (pacs.002) Original Message Name Original Instruction Original Instructing Agent 3 (field Member or ) 4 Instructed Agent 5 (field Member or ) Interbank Settlement Amount Interbank Settlement Date Credit Transfer Group Header / Message fix 'pacs ' Credit Transfer Information / / Instruction Credit Transfer Information / / Credit Transfer Information / Instructed Agent Credit Transfer Information / Instructing Agent Credit Transfer Information / Interbank Settlement Amount Group Header / Interbank Settlement Date Request for Group Header / Message fix 'pain ' Information / Information n/a Information / Debtor Agent Group Header / Initiating Party / Information / Credit Transfer / Amount / Instructed Amount n/a Response to Request for Group Header / Message fix 'pain ' Original Information and Status / Original Information n/a Information / Credit Transfer / Creditor Agent Group Header / Initiating Party / n/a n/a Request for Return of Funds / System Timeout Assignment / fix 'camt ' Underlying / Information / Original Instruction Underlying / Information / Original Assignment / Assignee / Agent Assignment / Assigner / Agent Underlying / Information / Original Interbank Settlement Amount Underlying / Informatio n / Original Interbank Settlement Date Response to Request for Return of Funds Assignment / fix 'camt ' Cancellation Details / Original Group Information and Status / Resolve Case / n/a Assignment / Assignee / Agent Assignment / Assigner / Agent n/a n/a 3 Member under Financial Institution / Clearing System ; under / Organization / Other 4 In case of reject by the system the Instructing Agent will be RTP 5 Member under Financial Institution / Clearing System ; under / Organization / Other 2018 The Clearing House s Company L.L.C. 12

13 Message Status Report (pacs.002) fields Original Message Original Message Name Original Instruction Original Instructing Agent 3 (field Member or ) 4 Instructed Agent 5 (field Member or ) Interbank Settlement Amount Interbank Settlement Date Message Stand-alone Remittance Advice (with pacs.008) Group Header / Message fix 'remt ' Original Information / References / Instruction Original Information / References / Group Header / Message Recipient / Group Header / Initiating Party / Remittance Information / Original Information / Amount / Instructed Amount n/a Stand-alone Remittance Advice (with pain.013) Group Header / Message fix 'remt ' Original Information / References / Information Original Information / References / Group Header / Message Recipient / Group Header / Initiating Party / Remittance Information / Original Information / Amount / Instructed Amount n/a Request for Information Assignment / fix 'camt ' Underlying / Interbank / Original Instruction Underlying / Interbank / Original Assignment / Assignee / Agent Assignment / Assigner / Agent Underlying / Interbank / Original Interbank Settlement Amount Underlying / Interbank / Original Interbank Settlement Date Response to Request for Information Assignment / fix 'camt ' Underlying / Interbank / Original Instruction Underlying / Interbank / Original Assignment / Assignee / Agent Assignment / Assigner / Agent Underlying / Interbank / Original Interbank Settlement Amount Underlying / Interbank / Original Interbank Settlement Date Acknowledge ment Assignment / fix 'camt ' Proprietary Data / Data / Original Reference / Instruction Proprietary Data / Data / Original Reference / Assignment / Assignee / Agent Assignment / Assigner / Agent n/a n/a Confirmation of Response to Credit Transfer Group Header / Message fix 'pacs ' Information and Status / Original Instruction Information and Status / Original Information and Status / Instructing Agent Information and Status / Instructed Agent Information and Status / Original Reference / Interbank Settlement Amount Informatio n and Status / Original Reference / Interbank Settlement Date 2018 The Clearing House s Company L.L.C. 13

14 2.1.2 Message Structure Description Index XML Tag Element Name Occurr. Length M/O/C 6 FIToFIPmtStsRpt FITo FI Status Report V07 [1..1] M 1.0 GrpHdr Group Header [1..1] M 1.1 MsgId Message [1..1] 35 M 1.2 CreDtTm Creation Date Time [1..1] 19 M 2.0 OrgnlGrpInfAndSts Original Group Information And Status [1..1] M 2.1 OrgnlMsgId Original Message [1..1] 35 M 2.2 OrgnlMsgNmId Original Message Name [1..1] 35 M 2.3 OrgnlCreDtTm Original Creation Date Time [1..1] 19 M 2.4 OrgnlNbOfTxs Original Number Of s [1..1] 1 M 3.0 Information And Status [1..1] M 3.6 OrgnlInstrId Original Instruction [0..1] 35 M 3.8 OrgnlTxId Original [0..1] 35 C 3.9 TxSts Status [0..1] 4 M 3.10 StsRsnInf Status Reason Information [0..1] O 3.54 Rsn Reason [0..1] O 3.55 Cd Code [0..1] 4 C 3.56 Prtry Proprietary [0..1] 4 C 3.57 AddtlInf Additional Information [0..1] 105 O AccptncDtTm Acceptance Date Time [1..1] 19 M ClrSysRef Clearing System Reference [0..1] 35 O InstgAgt Instructing Agent [1..1] M FinInstnId Financial Institution [1..1] M ClrSysMmbId Clearing System Member [1..1] M MmbId Member [1..1] 9 M InstdAgt Instructed Agent [1..1] M FinInstnId Financial Institution [1..1] M ClrSysMmbId Clearing System Member [1..1] M MmbId Member [1..1] 9 M OrgnlTxRef Original Reference [0..1] C IntrBkSttlmAmt Interbank Settlement Amount [0..1] 18 C Ccy Currency [required] 3 C IntrBkSttlmDt Interbank Settlement Date [0..1] 10 C Detail Message Field Description The following section of this document provides the detailed information of each element used in the Message Status Report (pacs.002) message for RTP. In some cases, a single field has two different meanings: the ISO Definition, and the RTP. In these instances, the first definition is based on the ISO specification provided by the ISO RMG group. The second definition is the definition The Clearing House developed for the product usage of this element within the RTP implementation. The second definition is only provided where the RTP product usage is different from the ISO group specification, or where more detailed information of the usage of this field is required. 6 M mandatory / O optional / C - conditional 2018 The Clearing House s Company L.L.C. 14

15 For the ISO Definition and further detail on the message itself please refer to the official ISO website ( Note: To identify which business purpose the pacs.002 message is being used to support, two different product usages are provided: Credit Transfer to describe functionality relating to Message Status Report of Credit Transfer (pacs.008) Messages to describe functionality relating to all other Messages using the Message Status Report. FI To FI Status Report V07 Group Header GrpHdr Set of characteristics shared by all individual transactions included in the status report message. Index: 1.0 <GrpHdr> Occurrences: [1..1] Message GrpHdr +MsgId Point to point reference, as 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 Message is unique per instructed party for a pre-agreed period. Credit Transfer: Assigned by the Instructing Agent (Creditor FI or RTP). The Instructing Agent (or the System if originated by RTP) must ensure the uniqueness of this message identification. Index: 1.1 Assigned by the Instructing Agent (Creditor FI, Debtor FI, or RTP). The Instructing Agent (or the System if originated by RTP) must ensure the uniqueness of this message identification <MsgId> Occurrences: [1..1] Format: MYYYYMMDDbbbbbbbbbbbBAAAnnnnnnnnnnn Pos Prefix "M" Pos File creation date in format YYYYMMDD Pos FI Identifier (11 digit Participant ID) Pos Message generation source ("B" if generated by a TCH 2018 The Clearing House s Company L.L.C. 15

16 Rules: Reason Codes: Notes: FI; H if generated by TCH) Pos Alphabetic serial identifier (3 alphabetic characters) Pos Message serial number (11 numeric characters) The first 20 characters of the Message ID (positions 01-20) are validated for structural alignment according to the format specification. In case of structural validation failure, reject with code 650 in Administration Advice message (admi.002) Where RTP is the intermediary, the Message Identifier in the message received by the System from the Instructing Agent (Creditor FI) is passed untouched by the System to the Instructed Agent (Debtor FI). Where RTP is generating the pacs.002 message the Message Identifier is generated by the system (identified with 'H' on the 19th position). Example: Note: the message identification for the original request message (the or Message) is different than the message identification for the corresponding pacs.002 (Message Status Report) message. <MsgId>M BRRR </MsgId> Creation Date Time GrpHdr +CreDtTm Index: 1.2 Occurrences: [1..1] Format: Notes: Example: Date and time at which the message was created. <CreDtTm> YYYY-MM-DDThh:mm:ss The date is required to be set to Eastern Time (ET). <CreDtTm> T10:05:20</CreDtTm> Original Group Information and Status OrgnlGrpInfAndSts Index: 2.0 Occurrences: [1..1] Notes: Original group information concerning the group of transactions, to which the status report message refers <OrgnlGrpInfAndSts> RTP will only refer to one transaction per pacs.002 message The Clearing House s Company L.L.C. 16

17 Original Message OrgnlGrpInfAndSts +OrgnlMsgId ISO Definition: Point to point reference, as assigned by the original instructing party, to unambiguously identify the original message. Product Usage Credit Transfer: Product Usage Index: 2.1 Occurrences: [1..1] Example: The Original Message ID of the Credit Transfer. The Original Message ID of the Message. <OrgnlMsgId> <OrgnlMsgId>M BFFF </OrgnlMsgId> Original Message Name OrgnlGrpInfAndSts +OrgnlMsgNmId Specifies the original message name identifier to which the message refers Credit Transfer: Specifies the type of the original message, to which this pacs.002 message is a response Index: 2.2 Occurrences: [1..1] Reasons Codes: Example: Same as above <OrgnlMsgNmId> Reject with code '650' in Administration Advice message (admi.002) if Original Message Name is not valid. <OrgnlMsgNmId>pacs </OrgnlMsgNmId> Codes camt camt camt camt Name / Description Unable to Apply (Request for Information) Additional Information (Response to Request for Information) Resolution of Investigation (Response to Request for Return of Funds) Acknowledgement Receiver 2018 The Clearing House s Company L.L.C. 17

18 camt pacs pacs pain pain remt Cancellation (Request for Return of Funds or System Timeout) Status Report (eg. Response to Credit Transfer) Credit Transfer Creditor Activation Request (Request for ) Creditor Activation Request Status Request (Response to Request for ) Stand-alone Invoice/Remittance Advice Original Creation Date Time OrgnlGrpInfAndSts +OrgnlCreDtTm Credit Transfer: Date and time at which the original message was created. This date is referring to the original Credit Transfer. Index: 2.3 Occurrences: [0..1] Reasons Codes: Note: Example: This date is referring to the original Message. <OrgnlCreDtTm> Reject with code '650' in Administration Advice message (admi.002) if not valid. The date is required to be set to Eastern Time (ET). <OrgnlCreDtTm> T10:05:00</OrgnlCreDtTm> Original Number of s OrgnlGrpInfAndSts +OrgnlNbOfTxs Index: 2.4 Number of individual transactions contained in the original message. <OrgnlNbOfTxs> Occurrences: [1..1] Rules: Expected value is 1 Reasons Codes: Example: Reject with code '650' in Administration Advice message (admi.002) if value is not '1'. <OrgnlNbOfTxs>1</OrgnlNbOfTxs> Information and Status 2018 The Clearing House s Company L.L.C. 18

19 Information concerning the original transactions, to which the status report message refers. Index: 3.0 <> Occurrences: [1..1] Original Instruction +OrgnlInstrId Unique identification, as assigned by the original instructing party for the original instructed party, to unambiguously identify the original instruction. Credit Transfer: Index: 3.6 The Instruction of the Credit Transfer for which this message is the response. The Instruction of the Message for which this message is the response. <OrgnlInstrId> Occurrences: [0..1] Example: <OrgnlInstrId> BFFFF </OrgnlInstrId> Original +OrgnlTxId Credit Transfer: Unique identification, as assigned by the original first instructing agent, to unambiguously identify the transaction. The unique identifier, assigned by the first instructing agent to unambiguously identify the transaction that is passed on unchanged throughout the entire interbank chain. This is the transaction identifier assigned by the Debtor FI. If the Instructing Agent is the same as the Debtor FI, the and Instruction should be the same. In case a Credit Transfer was initiated based on a Request for (pain.013) message, this element is filled with the Information from the pain.013. The unique identifier, assigned by the first instructing agent. The Original is optional for Message Status Report on messages. Index: The Clearing House s Company L.L.C. 19

20 <OrgnlTxId> Occurrences: [0..1] Rules: Example: The is mandatory for the Message Status Report of Credit Transfer. <OrgnlTxId> BSEDP </OrgnlTxId> Status +TxSts Credit Transfer: Specifies the status of a transaction, in a coded form. The status of the item: ACTC, ACWP, or RJCT (see definitions for codes below) Index: 3.9 The status of the item: either RCVD or RJCT (see definitions for codes below) <TxSts> Occurrences: [0..1] Rules: Reason Codes: Note: Example: Must be either 'RJCT', 'RCVD', 'ACWP' or 'ACTC' Reject with code 650 in administration message admi.002 if invalid code. Code 'RCVD' is used as Message Status Report to all Messages that can be processed without issue by the receiving agent. <TxSts>ACTC</TxSts> Codes ACTC ACWP RCVD RJCT Name / Description Accept has been Accepted Accept Without Posting instruction included in the Credit Transfer is Accepted without being Posted to the Creditor Customers account. This is done so further checks and status update can be performed (eg. OFAC checks). See System Message Flows for more information. Received Message has been received by the receiving agent. Reject or Message has been rejected. Status Reason Information 2018 The Clearing House s Company L.L.C. 20

21 +StsRsnInf Index: 3.10 Provides detailed information on the status reason. <StsRsnInf> Occurrences: [0..1] Reason +StsRsnInf ++Rsn Index: 3.54 Specifies the reason for the status report. <Rsn> Occurrences: [0..1] Notes: Both the ISO reason codes and also proprietary codes are used. Either Element Code or Proprietary can be provided per transaction. Code +StsRsnInf ++Rsn +++Cd Credit Transfer: Index: 3.55 Reason for the status, as published in an external reason code list. A code signifying reason for the rejection of the original message in ISO format. Same as above. <Cd> Occurrences: [0..1] Rules: Only present if the transaction status is 'RJCT'. Note: List of available ISO Codes are in the Appendix Example: <Cd>RC03</Cd> Proprietary +StsRsnInf ++Rsn +++Prtry Credit Transfer: Reason for the status, in a proprietary form. A code signifying reason for the rejection of the original message. Same as above The Clearing House s Company L.L.C. 21

22 Index: 3.56 <Prtry> Occurrences: [0..1] Rules: Only present if the transaction status is 'RJCT'. Note: List of available ISO Codes are in the Appendix Example: <Prtry>1100</Prtry> Additional Information +StsRsnInf ++AddtlInf Credit Transfer: Index: 3.57 Further details on the status reason. Additional information can be used for several purposes such as the reporting of repaired information. Additional information for 'Any Other Reasons' Reason Code. Same as above. <AddtlInf> Occurrences: [0..1] Rules: Reason Codes: Example: Only applicable for Reason Codes: Any Other Reasons - NARR Narrative Reject with code '650' in Administration Advice message (admi.002) if XML parsing error; otherwise not checked. <AccptncDtTm> T10:05:10</AccptncDtTm> Acceptance Date Time +AccptncDtTm Credit Transfer: Point in time when the payment order from the initiating party meets the processing conditions of the account servicing agent. This means that the account servicing agent has received the payment order and has applied checks such as authorization, availability of funds. Point in time when the instruction from the Instructing Agent (Debtor FI) has been accepted by the Instructed Agent (Creditor FI). Point in time when the Message has been received by the Receiving Agent The Clearing House s Company L.L.C. 22

23 Index: <AccptncDtTm> Occurrences: [1..1] Format: YYYY-MM-DDThh:mm:ss Note: Example: The date is required to be set to ET. <AccptncDtTm> T10:05:10</AccptncDtTm> Clearing System Reference +ClrSysRef Unique reference, as assigned by a clearing system, to unambiguously identify the instruction. Credit Transfer: Index: of the Reconciliation Window within which this transaction is processed. Can only be supplied by RTP. The Creditor FI should echo the value supplied in the pacs.008 message back to RTP in the response to a Credit Transfer message. Not used for Message Status Report on messages. <ClrSysRef> Occurrences: [0..1] Rules: Reason Codes: Example: The Clearing System Reference is - Only applicable if transaction status is 'ACTC' or 'ACWP'. Reject with code '650' in Administration Advice message (admi.002) if XML parsing error; otherwise not checked. <ClrSysRef>001</ClrSysRef> Instructing Agent +InstgAgt Agent that instructs the next party in the chain to carry out the (set of) instruction(s). Usage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on. The instructing agent is the party sending the status message and not 2018 The Clearing House s Company L.L.C. 23

24 Credit Transfer: the party that sent the original instruction that is being reported on. Index: Same as above. <InstgAgt> Occurrences: [1..1] 2018 The Clearing House s Company L.L.C. 24

25 Financial Institution +InstgAgt ++FinInstnId Index: Message Status Report Version 2.2 Unique and unambiguous identification of a financial institution, as assigned under an internationally recognized or proprietary identification scheme. <FinInstnId> Occurrences: [1..1] Clearing System Member +InstgAgt ++FinInstnId +++ClrSysMmbId Index: Occurrences: [1..1] Information used to identify a member within a clearing system. <ClrSysMmbId> Member +InstgAgt ++FinInstnId +++ClrSysMmbId ++++MmbId Credit Transfer: of a member of a clearing system. of the Instructed Agent (Debtor FI) for this Message Status Report of Credit Transfer (pacs.002) message. Index: of the Instructed Agent for this Message Status Report. <MmbId> Occurrences: [1..1] Format: Rules: Reason Codes: 9 digit Routing and Transit Number. For Message Status Report of Credit Transfer Member must be: Identical to the Member of the Instructed Agent (Creditor FI) of the original Credit Transfer (pacs.008) message A valid 9 digit Routing and Transit Number For Message Status Report of Credit Transfer - Reject with code '650' in Administration Advice message (admi.002) if Routing and Transit Number is invalid or not identical to the Routing and Transit Number of the Creditor FI from the original pacs The Clearing House s Company L.L.C. 25

26 Example: <MmbId> </MmbId> Instructed Agent +InstdAgt Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s). Credit Transfer: Index: Usage: The instructed agent is the party receiving the status message and not the party that received the original instruction that is being reported on. The instructed agent is the party receiving the status message and not the party that received the original instruction that is being reported on. Same as above. <InstdAgt> Occurrences: [1..1] Financial Institution +InstdAgt ++FinInstnId Index: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognized or proprietary identification scheme. <FinInstnId> Occurrences: [1..1] Clearing System Member +InstdAgt ++FinInstnId +++ClrSysMmbId Index: Occurrences: [1..1] Information used to identify a member within a clearing system. <ClrSysMmbId> 2018 The Clearing House s Company L.L.C. 26

27 Member +InstdAgt ++FinInstnId +++ClrSysMmbId ++++MmbId Credit Transfer: of a member of a clearing system. Message Status Report Version 2.2 of the Instructed Agent (Debtor FI) for this Message Status Report of Credit Transfer (pacs.002) message. Index: of the Instructed Agent for this Message Status Report. <MmbId> Occurrences: [1..1] Format: Rules: Reason Codes: Example: 9 digit Routing and Transit Number For Message Status Report of Credit Transfer Member must be: Identical to the Member of the Instructing Agent (Debtor FI) of the original Credit Transfer (pacs.008) message A valid 9 digit Routing and Transit Number For Message Status Report of Credit Transfer - Reject with code '650' in Administration Advice message (admi.002) if Routing and Transit Number is invalid or not identical to the Routing and Transit Number of the Debtor FI from the original pacs.008. <MmbId> </MmbId> Original Reference +OrgnlTxRef Credit Transfer: Key elements used to identify the original transaction that is being referred to. Must provide Interbank Settlement Amount and Interbank Settlement Date from the original Credit Transfer. Must provide Interbank Settlement Amount from: - Request for. Must provide Interbank Settlement Date from: - Request for Return of Funds (camt.056), - Request for Information (camt.026), and - Response to Request for Information (camt.028). Index: <OrgnlTxRef> 2018 The Clearing House s Company L.L.C. 27

28 Occurrences: [0..1] Interbank Settlement Amount +OrgnlTxRef ++IntrBkSttlmAmt Credit Transfer: Index: Amount of money moved between the instructing agent and the instructed agent. The total amount that the Debtor FI is obligated to pay the Creditor FI upon the Creditor FI s acceptance of the payment instructed by the Credit Transfer (pacs.008) message. Amount of the Business Message if provided. Where no amount is available in the original Business Message the amount field will not be populated. See table in section for more information. <IntrBkSttlmAmt> Occurrences: [0..1] Reason Codes: Notes: Example: Attribute Reject structural validation failure with code '650' in Administration Advice message (admi.002) if: The value of this field is less than zero The value in this field is greater than supported by the ISO definition for the maximum number of digits (total 18 digit) The currency code is not valid The number of decimal digits is greater than the specified number of digits as defined by the ISO4217 definition RTP is only supporting USD and the maximum decimal digits allowed are two. <IntrBkSttlmAmt>525.25</IntrBkSttlmAmt> Currency Index: Rules: A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". <Ccy> Currency must be a currency that is supported by RTP (US Dollar). Reason Codes: Example: Codes: USD Reject with code 'AM11' in Message Status Report (pacs.002) if the currency code is not supported by RTP. USD Name / Description US Dollar Numeric code: The Clearing House s Company L.L.C. 28

29 2018 The Clearing House s Company L.L.C. 29

30 Interbank Settlement Date +OrgnlTxRef ++IntrBkSttlmDt Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. Credit Transfer: Index: Interbank settlement date of the approved payment instruction from the original pacs.008 message. Field only used in Request for Return of Funds (camt.056), Request for Information (camt.026), and Response to Request for Information (camt.028). For all other messages, this is not populated. <IntrBkSttlmDt> Occurrences: [0..1] Format: Reason Codes: Example: YYYY-MM-DD Reject with code '650' in Administration Advice message (admi.002) if XML parsing error. <IntrBkSttlmDt> </IntrBkSttlmDt> 2018 The Clearing House s Company L.L.C. 30

31 3 APPENDIX 3.1 List and Usage of ISO Error Codes (Reject / Reason Codes) The table includes the reason codes used by RTP in the event that a message fails business validation within the system and also the codes that are available to the receiving FIs, when they receive a message that fails business validation within their systems. The list is a sub-set of the full ISO rejection reason code list and contains those codes that are deemed applicable to RTP. The codes in this document are specifically for business validation failures. Structural errors encountered during processing should result in an Administration Message being returned to the sender. ISO Reason Code Usage Requirement ISO Description Used by FI Used by RTP Notes AC02 FI Debtor account number invalid or missing AC03 FI Creditor account number invalid or missing AC04 FI Account number specified has been closed on the bank of account's books. AC06 FI Account specified is blocked, prohibiting posting of transactions against it. Y N To be used if account is invalid. Y N To be used if account is invalid. Y N Account closed. AC07 FI Creditor account number closed Y N AC10 FI Debtor account currency is invalid or Y N RTP only supports US Dollar. missing AC11 FI Creditor account currency is invalid or missing Y N RTP only supports US Dollar AC13 FI Debtor account type missing or invalid AC14 FI Creditor account type missing or invalid AG01 Both forbidden on this type of account (formerly NoAgreement) AG03 Both type not supported / authorized on this account 2018 The Clearing House s Company L.L.C. 31 Y N Y N The System is not validating the account type. Y N The System is not validating the account type. Y Y TCH usage: Agent is not authorized to send or receive this transaction type (pacs.008). Y Y TCH usage: Agent is not authorized to send or receive this business message type (e.g. pain.013).

32 ISO Reason Code Usage Requirement ISO Description Used by FI Used by RTP Notes AM02 TCH Specific transaction/message amount is greater than allowed maximum AM04 TCH Amount of funds available to cover specified message amount is insufficient. AM09 FI Amount received is not the amount agreed or expected AM11 Both currency is invalid or missing 2018 The Clearing House s Company L.L.C. 32 N Y N Y Used if Net Position breaches Prefunded Balance Y N Y Y Used if currency is not USD AM12 Both Amount is invalid or missing Y Y Used if Total Interbank Settlement Amount is not equal to Interbank Settlement Amount AM13 TCH amount exceeds limits N Y set by clearing system BE04 FI Specification of creditor's address, Y N which is required for payment, is missing/not correct (formerly IncorrectCreditorAddress). BE06 FI End customer specified is not known Y N at associated Sort/National Bank Code or does no longer exist in the books BE07 FI Specification of debtor's address, which is required for payment, is missing/not correct Y N BE10 FI Debtor country code is missing or invalid BE11 FI Creditor country code is missing or invalid BE13 FI Country code of debtor s residence is missing or Invalid BE14 FI Country code of creditor's residence is missing or Invalid BE16 FI Debtor identification code missing or invalid BE17 FI Creditor identification code missing or invalid DS24 TCH Waiting time expired due to incomplete order Y N System is not validating country code. Y N System is not validating country code. Y N System is not validating country code. Y N System is not validating country code. Y N Y N N Y Used for System Time-out. DT04 TCH Future date not supported N Y Used for if Date provided is outside of date range.

33 ISO Reason Code Usage Requirement ISO Description Used by FI Used by RTP Notes DUPL TCH is a duplicate of another payment DS0H TCH Signer is not allowed to sign for this account FF02 TCH Syntax error reason is provided as narrative information in the additional reason information. FF03 TCH Invalid Type Information N Y FF08 FI End to End Id missing or invalid Y N MD07 FI End customer is deceased. Y N NARR FI Reason is provided as narrative information in the additional reason information. RC01 TCH Bank identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode). Y Y N Y TCH usage: Sender of the message is not linked to the participant. N Y Additional information will be provided in the field Additional Information Y N Additional information will be provided in the field Additional Information Y Y RC02 TCH Bank Identified is invalid or missing N Y Only used if invalid. RC03 TCH Debtor FI identifier is invalid or Y Y missing RC04 TCH Creditor FI identifier is invalid or missing Y Y 2018 The Clearing House s Company L.L.C. 33

34 3.2 List and Usage of non-iso Error Codes (Reject / Reason Codes) Message Status Report Version 2.2 The table includes the reason codes used by RTP in the event that a message fails business validation within the system. These are codes that are proprietary codes used by RTP as there are no associated ISO reason codes available. Note: In the event ISO will provided additional reason codes in the future RTP might change the proprietary reason codes to ISO reason codes. Reason Code Usage Requirement Description Used by FI Used by RTP Notes NOAT FI Receiving Customer Account does not support/accept this message type Both Any Other Reasons Reason is provided as narrative information in the additional reason information TCH Central Switch (RTP) system malfunction 9910 TCH Instructed Agent signed-off N Y 9934 TCH Instructing Agent signed-off N Y 9946 TCH Instructing Agent suspended N Y 9947 TCH Instructed Agent suspended N Y 9948 TCH Central Switch (RTP) service is suspended N Y Y N Typically used in response to a Request for when the Debtor Customer has not authorized Request for on the account or for the particular Initiator of the Request for Y Y Additional information will be provided in the field Additional Information N N Reserved for future use by the system The Clearing House s Company L.L.C. 34