Technical Guide GPP Fndt Message Usage For Account Lookup Interface
User Manual: Pdf
Open the PDF directly: View PDF .
Page Count: 47
Download | |
Open PDF In Browser | View PDF |
GPP PAYplus Fndt Message Usage for Account Lookup Interface Technical Guide Product Version: 4.6.8 Catalog ID: GPP4.6-00-T16-01-201801 Copyright © 2009-2018 Finastra International Limited, or a member of the Finastra group of companies (“Finastra”). All Rights Reserved. Confidential - Limited Distribution to Authorized Persons Only, pursuant to the terms of the license agreement by which you were granted a license from Finastra for the applicable software or services and this documentation. Republication or redistribution, in whole or in part, of the content of this documentation or any other materials made available by Finastra is prohibited without the prior written consent of Finastra. The software and documentation are protected as unpublished work and constitute a trade secret of Finastra International Limited, or a member of the Finastra group of companies, Head Office: One Kingdom Street, Paddington, London W2 6BL, United Kingdom. Disclaimer Finastra does not guarantee that any information contained herein is and will remain accurate or that use of the information will ensure correct and faultless operation of the relevant software, services or equipment. This document contains information proprietary to Finastra. Finastra does not undertake mathematical research but only applies mathematical models recognized within the financial industry. Finastra does not guarantee the intrinsic theoretical validity of the calculation models used. Finastra, its agents, and employees shall not be held liable to or through any user for any loss or damage whatsoever resulting from reliance on the information contained herein or related thereto. The information contained in this document and the general guidance of Finastra staff does not take the place of qualified compliance personnel or legal counsel within your institution. FINASTRA CANNOT RENDER LEGAL, ACCOUNTING OR OTHER PROFESSIONAL SERVICES TO YOUR INSTITUTION. THE INFORMATION CONTAINED HEREIN IS GENERAL IN NATURE AND DOES NOT CONSTITUTE LEGAL ADVICE OR A LEGAL OPINION. CONSULT YOUR LEGAL COUNSEL FOR LEGAL ADVICE SPECIFIC TO YOUR SITUATION OR CIRCUMSTANCES OR TO ANSWER ANY LEGAL QUESTIONS. This document is not intended as a substitute for formal education in the regulatory requirements of banking, banking operations, lending, lending operations, or other topics generally applicable to financial institutions. Your financial institution is solely responsible for configuring and using the software or services in a way that meets policies, practices, and laws applicable to your institution, including, without limitation: (1) options and selections made on prompts; (2) entries in the software program; (3) program setup; and (4) documents produced by the software or services. It is the obligation of the customer to ensure that responsible decisions are taken when using Finastra products. Information in this document is subject to change without notice and does not represent a commitment on the part of Finastra. Feedback Do you have comments about our guides and online help? Please address any comments and questions to your local Finastra representative. Need more information? Read more about our products at http://www.finastra.com or contact your local Finastra office at http://www.finastra.com/contact. Version Control Version Date 1.0 Summary of Changes Document created 2.0 December 2015 Updated for rebranding 3.0 June 2016 Updated with marking of subtrees that the order of their child elements is not mandatory 4.0 August 2016 Updated with fix in format definition of Office tags 5.0 December 2016 Updated with an additional note explaining the usage of the Credentials element in the Header structure and a clarifying statement redrawing the Product scope in regards to the population of the Pmnt tag. 6.0 January 2017 Updated with the following: Removal of the tag D_SKIP_PERSIST_ON_ERROR from Response structure and examples Additional note on the tag in D_SKIP_PERSIST_ON_ERROR in Request structure to indicate its irrelevancy for interfaces Update of population instruction for the P_MID tag within the Response to indicate that it must be populated when matching Response based on it 7.0 April 2017 Updated with the option to provide the IBAN in addition to the Account No in the Request, when provided in the transaction, to allow identification by it in the FI’s CDB. 8.0 July 2017 Updated with additional note specifying that fee information cannot be provided in the response when invoked for Source account on Outgoing file handling (as part of Pre-Processing Transaction stage) GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 3 Table of Contents 1 INTRODUCTION .......................................................................................................................... 5 1.1 1.2 1.3 1.4 1.5 2 Overview ............................................................................................................................... 5 About This Guide .................................................................................................................. 5 Background ........................................................................................................................... 5 Scope .................................................................................................................................... 5 References ............................................................................................................................ 5 INTERFACE STRUCTURES ....................................................................................................... 6 2.1 Account Lookup Request ...................................................................................................... 6 2.1.1 Minimal Scope ................................................................................................................... 6 2.1.2 Detailed Structure when using Minimal Scope .................................................................. 8 2.2 Account Lookup Response ................................................................................................. 13 2.2.1 Minimal Scope ................................................................................................................. 13 2.2.2 Minimal Scope + Fees Information Option ...................................................................... 31 3 USAGE ....................................................................................................................................... 37 APPENDIX A: GLOSSARY OF TERMS .............................................................................................. 38 APPENDIX B: CONVENTIONS (INCLUDING FORMAT AND PRESENCE) ...................................... 39 APPENDIX C: EXAMPLES OF REQUESTS AND RESPONSES ....................................................... 41 C.1 Debit Account Lookup Request .................................................................................................. 41 C.2 Credit Account Lookup Request ................................................................................................. 41 C.3 Successful Debit Account Lookup Response ............................................................................. 42 C.4 Successful Credit Account Lookup Response ............................................................................ 43 C.5 Successful Debit Account Lookup Response with Fees ............................................................ 44 C.6 Failed Account Lookup Response .............................................................................................. 46 GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 4 1 Introduction Note: This document has not yet been certified for GPP V4.6; therefore, there may be inaccuracies in this document that may require amendments in the future. For more information, please contact your Finastra Project Manager. 1.1 Overview This guide describes GPP’s standard Account Lookup interface between GPP and the Financial Institution HOST system responsible for providing account and customer information. GPP Standard Account Lookup is an XML interface based on GPP’s Fndt (FuNDs Transfer) message format. Account Lookup interface is typically using MQ (or web service) for communication with the host system (in many cases via a message mediation layer). Detailed in this document are the interface structure of the Account Lookup interface Request and Response: Account Lookup Request (outward from GPP’s perspective, to the financial institution HOST). Account Lookup Response (inward to GPP’s perspective, from the financial institution HOST) GPP usually invokes the Account Lookup on customer accounts – usually the debit account on outgoing credit transfers and the credit account on incoming credit transfers. GPP may invoke an Account Lookup request for both the debit account and the credit account in the case of a book transfer. It is expected that in such a scenario, two invocations of Account Lookup are performed for the same transaction. The processing, manual handling and configuration required around Account Lookup are not detailed in this document. For more details refer to the sections related to the Account Lookup interface in the GPP Business Guide System Integration - Single Payments. 1.2 About This Guide Information is provided for clients implementing an Account Lookup interface with Global PAYplus (GPP), using the GPP Fndt (FuNDs Transfer) Message Format as the base for request when providing transaction information, and response for providing account information. 1.3 Background A standard interface was defined to streamline the process of integrating GPP with various existing systems in a bank or financial institution. In addition to providing additional fields for GPP processing, this structure supports the usage of ISO 20022 or SWIFT messages embedded in the structure. When the transaction message is received as a SWIFT message it is included within the Fndt Message within a GPP specific wrapping XML structure, with the original text in one tag and a structured list of attributes as additional and separate tags. 1.4 Scope The guide covers only the structure and mapping aspects. The rest of the functionality is described in the GPP Business Guide System Integration – Single Payments document. 1.5 References For information about the GPP Fndt Message structure, see GPP Technical Guide Fndt Message Format. GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 5 For more information about the logic and functionality around this interface, see GPP Business Guide System Integration - Single Payments. 2 Interface Structures For the formatting and conventions in the interface detailed structure tables, the following should be taken into consideration: The shading in the detailed tables in this chapter marks tags, which represent subtree parents, for example, tags in level 1, 2, where leaf tags in level 3 exist under the level 1 and 2. Each level has a different shade, with the first (1) being the darkest shade and gradually getting lighter through the levels. For conventions, including the explanation of the values in the Presence and Format within the detailed structure tables, see Appendix B: Conventions (Including Format and Presence). For examples of the different requests and responses for different scenarios, see Appendix C: Examples of Requests and Responses. 2.1 Account Lookup Request 2.1.1 Minimal Scope The following sections from the full Fndt (Funds Transfer) Message structure are the Product minimal scope to be included when it is used as an Account Lookup Request (additional sections can be configured to be included, if required): Notes: The Pmnt section appears in the below minimal scope, as it is recommended for readability, and our Product default scope includes it. However, it can be excluded per financial institution’s requirement. When a sub-tree tag is marked with * - the elements underneath it can appear in any order. That is the XSD definition of the list of elements is ’all’ and not ’sequence.’ Level 1 Level 2 Level 3 Level 4 Level 5 Description FndtMsg Header General identifying attributes Msg Transaction message and extension Pmnt Pmnt quotes the transaction (whether it is ISO based pain/pacs or a SWIFT message embedded within the GPP proprietary XML structure). For more information, see GPP Technical Guide Fndt Message document. Extn* Processing PersistentI nfo* GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 6 Level 1 Level 2 Level 3 Level 4 Level 5 Description Credit Populated for credit Account Lookup Account Info request when contextName is CreditAccountLookup and Credit Fee Account Info Debit Populated for debit Account Lookup Account Info request when contextName is DebitAccountLookup and Debit Fee Account Info Reference Data* Transaction related profile reference data. Only added when IBAN is provided in transaction and hence may need to be sent to bank system in Request M_DBT_AC COUNT* In Account Lookup Request when contextName is DebitAccountLookup only Debit Account IBAN may be sent in this extension. M_CDT_AC COUNT* In Account Lookup Request when contextName is CreditAccountLookup only Credit Account IBAN may be sent in this extension. GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 7 2.1.2 Detailed Structure when using Minimal Scope Notes: The Pmnt section appears in this table, since it is recommended for readability. However, it can be excluded. When a sub-tree tag is marked with * - the elements underneath it can appear in any order. That is the XSD definition of the list of elements is ’all’ and not ’sequence.’ For the conventions of the Presence and Format columns in this table, see Appendix B: Conventions (Including Format and Presence). Tag L 0 1 2 3 4 FndtMsg 1 Header 2 contextName 3 + + + 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field [1..1] Fndt (Funds Transfer) Message [1..1] Header [0..1] Context Name Generic field to add information regarding the specific usage. Text {1,n} Populate with either of: CreditAccountLookup: for validation of the credit account DebitAccountLookup: for validation of the debit account Text {1,n} If required – populate with specific local context string Note: Specifically for the usage for Account Lookup request, the value can be CreditAccountLookup or DebitAccountLookup contextLocalName 3 + [0..1] Context Local Name Generic optional field to add regarding the specific usage, but using the financial institution system terminology naming, in case such a local name exists and is required for the identification on the financial institution side credentials 3 + [0..1] Credentials Credentials when required GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Note: The usage of this section, if populated, is allowing to filter results returned in the Fndt Message structure, based on the credentials (permissions) of the quoted GPP User. For example Page 8 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field filtering out details of transactions belonging to an Office, the quoted user does not have permissions for. This section is mainly used when Fndt Message structure is used within SOA services, but can also be applied, if filtering is required, when using it in interface structures. If left empty – no filtering occurs In the context of Account Lookup initiated from the GPP flow – has less meaning and business rational. UserID 4 + [0..1] User ID User ID Text {1,8} Populate with User Id Role 4 + [0..1] Role Role Text {1,50} Populate with User Role D_SKIP_PERSIST _ON_ERROR 3 [0..1] Skip Persist On Error Indicator An indication whether to store the [1,0] {1, 1} transaction details when an error or errors were found + Populate with 01 Note: Not relevant for interfaces. This is used when the structure is used in Web Services Workflow 3 + [0..1] Workflow Defined for mass processing. The Text {1,50} valid values are Template, File, or Swift P_MID 3 + [0..1] GPP Message The Internal GPP message Identifier Identifier deliveryTimestamp 3 + [0..1] Deliver Timestamp Text {1,16} The Timestamp when the request ISO Date was created Time Populate with - TBD Map from P_MID (logical field P_MID) Populate with Office Date Time 1 Not skip the saving of the message in case of error invoking the Account Lookup request GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 9 Tag L 0 1 2 3 4 P_INIT_SRC_ID 3 EventID 3 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field + [0..1] Initiating Source ID The ID of the source system initiating the request/response Text {1,50} Map GPP + [0..1] Event ID Unique 16-chars event ID generated for each interface request Text {1,16} Map from D_MEI_EVENT_ID if the INTERFACE_TYPES.EVENT_ID_GEN ERATION is configured with 1 for the INTERFACE_TYPE entry for this request This ID is used to identify a resent request (EventID is as in the original request), from a new request issued due to force or retry (EventID quotes a new value) Msg 2 Pmnt 3 Extn 3 ProcessingPersiste 4 ntInfo* + [1..1] Message + [0..1] Payment + [1..1] Extension [1..1] Processing Transaction derived attributes Persistent Info relevant to the transaction information [0..1] Credit Side Information on the Credit side. Persistent Info Note: In the context of the Account Lookup usage – will only be populated if the invocation is for the transaction’s credit account –is CreditAccountLookup + + ISO or SWIFT message text that is stored in an XML structure in the XML_MSG The entire transaction message is mapped from MINF.XML_MSG CreditSide* 5 P_CDT_ACCT_NB 6 + [0..1] Credit Account The credit account number to be Number validated Text {1,34} When is CreditAccountLookup - mapped from D_FIRST_IN_CDT_CHAIN_ACC_NUM P_CDT_ACCT_CC 6 Y + [0..1] Credit Account The currency of the credit Currency account [A-Z] {3, 3} When is CreditAccountLookup: If MINF.P_CDT_ACCT_CCY (logical field P_CDT_ACCT_CCY) is not empty (credit account was GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 10 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field P_CDT_ACCT_OF FICE 6 DebitSide* 5 P_DBT_ACCT_NB 6 P_DBT_ACCT_CC Y P_DBT_ACCT_OF FICE + [0..1] Credit Account The office of the credit account Office [0..1] Information on the Debit side. Debit Side Persistent Info Note: In the context of the Account Lookup usage, will only be populated if the invocation is for the transaction’s debit account, is DebitAccountLookup + [0..1] Debit Account Number The debit account number to be validated 6 + [0..1] Debit Account Currency The currency of the debit account [A-Z] {3, 3} 6 + [0..1] Debit Account Office The office of the debit account + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | manually added) - mapped from P_CDT_ACCT_CCY Else – mapped from MINF.P_STTLM_CCY (logical field P_STTLM_CCY) [A-Z,0-9] {3, When is 3} CreditAccountLookup: If logical field P_CDT_ACCT_OFFICE is not empty (credit account was manually added) – mapped from P_CDT_ACCT_OFFICE Else – mapped from MINF.P_OFFICE (logical field P OFFICE) Text {1,34} When is DebitAccountLookup- mapped from D_FIRST_IN_DBT_CHAIN_ACC_NUM When is DebitAccountLookup: If MINF.P_DBT_ACCT_CCY (logical field P_DBT_ACCT_CCY) is not empty (debit account was manually added) - mapped from P_DBT_ACCT_CCY Else – mapped from MINF.P_STTLM_CCY (logical field P_STTLM_CCY) [A-Z,0-9] {3, When is 3} DebitAccountLookup: Page 11 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field ReferenceData* 4 M_DBT_ACCOUN T 5 + + F_DBT_ACCT_IBA 6 N M_CDT_ACCOUN T 5 F_CDT_ACCT_IBA 6 N + + + [0..1] Reference Data [0..1] Debit Account Debit Account Details [0..1] Debit Account IBAN The IBAN of the debit account [0..1] Credit Account Credit Account Details [0..1] Credit Account The IBAN of the debit account IBAN GPP PAYplus | Fndt Message Usage for Account Lookup Interface | If logical field P_DBT_ACCT_OFFICE is not empty (debit account was manually added) – mapped from P_DBT_ACCT_OFFICE Else – mapped from MINF.P_OFFICE (logical field P OFFICE) if IBAN was provided as the debtor account in the transaction – this extension and the IBAN tag are populated to allow identification using the IBAN in the FI’s CDB system Text {1,34} When is DebitAccountLookup, and if IBAN was provided in the transaction - mapped from X_DBTR_ACCT_ID if IBAN was provided as the creditor account in the transaction – this extension and the IBAN tag are populated to allow identification using the IBAN in the FI’s CDB system Text {1,34} When is CreditAccountLookup, and if IBAN was provided in the transaction - mapped from X_CDTR_ACCT_ID Page 12 2.2 Account Lookup Response 2.2.1 Minimal Scope The following sections from the full Fndt (Funds Transfer) Message structure are the Product minimal scope to be included when it is used as an Account Lookup Response (additional sections can be configured to be included, if required): Notes: The Pmnt section appears in this table, since it is recommended for readability, and our Product default scope includes it as optional. However, it can be excluded. When a sub-tree tag is marked with * - the elements underneath it can appear in any order. That is the XSD definition of the list of elements is ’all’ and not ’sequence.’ Level 1 Level 2 Level 3 Level 4 Level 5 Description FndtMsg Header General identifying attributes Msg Transaction message and extension Pmnt Pmnt quotes the transaction (whether it is ISO based pain/pacs a SWIFT message embedded within the GPP proprietary XML structure) For more information, see GPP Technical Guide Fndt Message document. Extn* ProcessingPers istentInfo* P_CDT_ACCT _NB ,P_CDT_ACCT _CCY and P_CDT_ACCT _OFFICE P_DBT_ACCT _NB, P_DBT_ACCT _CCY and P_DBT_ACCT _OFFICE ReferenceData* Transaction related profile reference data. M_DBT_ACCO Debit Account Information UNT* populated for debit Account Lookup response. GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 13 Level 1 Level 2 Level 3 Level 4 Level 5 Description This information also include Stop Flags/Posting Restrictions set on the debit account M_CDT_ACCO Credit Account Information UNT* populated for credit Account Lookup response This information also include Stop Flags/Posting Restrictions set on the credit account M_DBT_CUST Debit Party Profile _PROFILE* Information populated for debit Account Lookup response This information also include Stop Flags/Posting Restrictions set on the debit customer M_CDT_CUST Credit Party Profile _PROFILE* Information populated for credit Account Lookup response This information also include Stop Flags / Posting Restrictions set on the credit customer M_CONTACT_ Contact Profile Information INFO populated for either of credit or debit Account Lookup response (can be either a contact for these accounts or their customers) ResponseD etails Applicable for Interface Responses Possible errors that may be encountered by the host system while processing Account Lookup request: Technical errors: Request not valid Host system not available Functional errors: Account not found Account currency does not match In addition, Stop Flags/Posting Restrictions may be reported back within the relevant account or customer information in the response. GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 14 2.2.1.1 Detailed Structure When Using Minimal Scope Notes: The Pmnt section appears in this table, since it is recommended for readability. However, it can be excluded. When a sub-tree tag is marked with * - the elements underneath it can appear in any order. That is the XSD definition of the list of elements is ’all’ and not ’sequence.’ For the conventions of the Presence and Format columns in this table, see Appendix B: Conventions (Including Format and Presence). Tag L FndtMsg 1 Header 2 contextName 3 0 1 2 3 4 5 6 7 8 9 10 + + + Presence Element [1..1] Fndt (Funds Transfer) Message [1..1] Header [0..1] Context Name Description Format Mapped From/Into GPP Table and Field Generic field to add information regarding the specific usage. Text {1,n} Populate with value in in the request - either of these: CreditAccountLookup: for validation of the credit account DebitAccountLookup: for validation of the debit account Text {1,n} If required, populate with specific local context string Note: Specifically for the usage for Account Lookup response, the value can be CreditAccountLookup or DebitAccountLookup contextLocalName 3 + [0..1] Context Local Name Generic optional field to add regarding the specific usage, but using the financial institution system terminology naming, in case a local name such exists and is required for the identification on the financial institution side credentials 3 + [0..1] Credentials Credentials when required GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Note: The usage of this section, if populated, is Page 15 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field allowing to filter results returned in the Fndt Message structure, based on the credentials (permissions) of the quoted GPP User. For example, filtering out details of transactions belonging to an Office, the quoted user does not have permissions for. This section is mainly used when Fndt Message structure is used within SOA services, but can also be applied, if filtering is required, when using it in interface structures. If left empty – no filtering occurs In the context of Account Lookup initiated from the GPP flow – has less meaning and business rationale. UserID 4 + [0..1] User ID User ID Text {1,8} If included in the Request and filtering is required, copy the same vale as in the Request UserId Role 4 + [0..1] Role Role Text {1,50} If included in the Request and filtering is required, copy the same vale as in the Request UserId Workflow 3 + [0..1] Workflow Defined for mass processing. The valid values are Template, File or Swift Text {1,50} Populate with - TBD P_MID 3 + [0..1] GPP Message Identifier The Internal GPP message Text {1,16} Identifier GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Must be populated with the value in in the request when used for matching in GPP (always in file processing) Page 16 Tag L deliveryTimestamp 3 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field + [0..1] Deliver Timestamp The Timestamp when either the request or the response was created ISO Date Time Populate either from request or with current Timestamp The ID of the source system initiating the request/response Text {1,50} Populate with a code of the HOST system Unique 16-chars event ID generated for each interface request Text {1,16} Note: As per specific integration, if matching between response and its request is not done using MQ Correlation ID, this tag can be used as part of the matching key when quoting the timestamp of the request. If MQ Correlation ID is used for matching, this tag can quote the timestamp when the response was created P_INIT_SRC_ID EventID 3 + 3 Msg 2 Pmnt 3 Extn* 3 ProcessingPersistentInfo* 4 [0..1] + [0..1] + + + + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Initiating Source System Id Event ID [1..1] Message [0..1] Payment [1..1] Extension [1..1] ProcessingPersi stentInfo ISO or SWIFT message text that is stored in an XML structure in the XML_MSG Will not be used in GPP Can be copied from request. Currently not used in GPP for matching with request – so – not mandatory Optionally can be populated with value in in the request, or omitted Will not be used in GPP Transaction derived attributes relevant to the transaction information Page 17 Tag L CreditSide* 5 0 1 2 3 4 5 6 7 8 9 10 + Presence Element Description [0..1] Credit Side Persistent Info Information on the Credit side. Format Mapped From/Into GPP Table and Field Text {1,34} When = CreditAccountLookup Populated with the validated account number [A-Z] {3,3} When = CreditAccountLookup Populated with the validated account currency In the context of the Account Lookup usage – will only be populated if the invocation is for the transaction’s credit account – is CreditAccountLookup P_CDT_ACCT_NB + 6 [0..1] Credit Account umber The credit account number that is validated and returned from host system Note: This number may be a different number than received in the request. Either identification logic in the host identified the number sent not as an account no (may be customer no), or to support cases of redirect. P_CDT_ACCT_CCY 6 + [0..1] Credit Account Currency The currency of the validated credit account Note: This currency may be a different currency than received in the request. This may occur in scenarios of redirect. P_CDT_ACCT_OFFICE 6 + [0..1] Credit Account Office The office of the validated credit account Note: The value in this tag is not expected to be different than the value sent in request DebitSide* 5 + [0..1] Debit Side Persistent Info [A-Z,0-9] {3, 3} When = CreditAccountLookup Populated with the validated account office Information on the Debit side. Note: In the context of the Account Lookup usage, will GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 18 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field Text {1,34} Populated with the validated account number (if = DebitAccountLookup) [A-Z] {3,3} Populated with the validated account currency (if = DebitAccountLookup) only be populated if the invocation is for the transaction’s debit account, is DebitAccountLookup P_DBT_ACCT_NB 6 + [0..1] Debit Account Number The debit account number that is validated and returned from host system Note: This number may be a different number than received in the request. Either identification logic in the host identified the number sent not as an account no (may be customer no), or to support cases of redirect. P_DBT_ACCT_CCY 6 + [0..1] Debit Account Currency The currency of the validated debit account Note: This currency may be a different currency than received in the request. This may occur in scenarios of redirect. P_DBT_ACCT_OFFICE 6 + [0..1] Debit Account Office The office of the validated debit account Note: The value in this tag is not expected to be different than the value sent in request ReferenceData* 4 M_DBT_ACCOUNT 5 + + [0..1] Reference Data [0..1] Debit Account Debit Account Details Note: In the context of the Account Lookup usage, this is only expected to be populated if the invocation is for the transaction’s debit GPP PAYplus | Fndt Message Usage for Account Lookup Interface | [A-Z,0-9] {3, 3} Populated with the validated account office (if = DebitAccountLookup) Mapped into the Object that would have contained details from the Account profile of the debit account, if Accounts were managed in GPP Page 19 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field account, is DebitAccountLookup F_DBT_ACCT_ASSET 6 + [0..1] Debit Account Asset Flag Indicates whether the debit [1,0] {1,1} account asset flag. Mapped into the PDO F_DBT_ACCT_ASSET Note: Assumed to be set to 0 (false) for customer account. 6 + [0..1] Debit Account Booking Entity The booking entity / accounting system of the debit account. F_DBT_ACCT_ACC_TYPE 6 + [0..1] Debit Account Account Type Text {1,10} The account type of the debit account. Mandatory as part of the Debit Account details when Debit Account is validated, as required for remaining processing, and specifically Posting. F_DBT_ACCT_BOOKNG_ ENT Text {1,20} Mapped into the PDO F_DBT_ACCT_BOOKNG_EN T Mapped into the PDO F_DBT_ACCT_ACC_TYPE Note: Should be populated with values that fit the Account Types configured in GPP. F_DBT_ACCT_IS_RESIDE 6 NT + [0..1] Debit Account Is Resident Indicates whether the debit [1,0] {1,1} account owner is a resident of the country for this account. F_DBT_ACCT_IBAN 6 + [0..1] Debit Account IBAN The IBAN of the debit account Text {1,34} Mapped into the PDO F_DBT_ACCT_IBAN F_DBT_ACCT_STOPFLAG 6 DR + [0..1] Debit Stop Flag / Posting Restriction on Debit Account on indication Indicates that there is a debit Stop Flag / Posting Restriction set on the debit account. [1,0] {1,1} Mapped into the PDO F_DBT_ACCT_STOPFLAGDR GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Mapped into the PDO F_DBT_ACCT_IS_RESIDENT Note: Specific reason indicated in the next tag. Page 20 Tag L F_DBT_ACCT_REASOND R 6 0 1 2 3 4 5 6 7 8 9 10 + F_DBT_ACCT_STOPFLAG 6 CR F_DBT_ACCT_REASONC R + 6 + Presence Element Description Format Mapped From/Into GPP Table and Field [0..1] Debit Stop Flag / Posting Restriction on Debit Account Reason The code / reason for the debit Stop Flag / Posting Restriction set on the debit account. Text {1,35} Mapped into the PDO F_DBT_ACCT_REASONDR Credit Stop Flag / Posting Restriction on Debit Account on indication Indicates that there is a credit Stop Flag / Posting Restriction set on the debit account. [1,0] {1,1} Mapped into the PDO F_DBT_ACCT_STOPFLAGCR Credit Stop Flag / Posting Restriction on account reason The code / reason for the credit Stop Flag / Posting Restriction set on the account. Text {1,35} Mapped into the PDO F_DBT_ACCT_REASONCR [0..1] [0..1] Note: Codes provided should quote values already configured in GPP as Stop Flags. Note: Specific reason indicated in the next tag. Note: Codes provided should quote values already configured in GPP as Stop Flags. M_CDT_ACCOUNT 5 + [0..1] Credit Account Credit Account Details Mapped into the Object that would have contained details from the Account profile of the credit account, if Accounts were managed in GPP Note: In the context of the Account Lookup usage, this is only expected to be populated if the invocation is for the transaction’s debit account, is CreditAccountLookup F_CDT_ACCT_ASSET 6 + [0..1] Credit Account Asset Flag Indicates whether the credit account asset flag. [1,0] {1,1} Mapped into the PDO F_CDT_ACCT_ASSET Note: Assumed to be set to 0 (false) for customer account. GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 21 Tag L F_CDT_ACCT_BOOKNG_ ENT 6 F_CDT_ACCT_ACC_TYPE 6 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field + [0..1] Credit Account Booking Entity The booking entity / accounting system of the credit account. Text {1,20} Mapped into the PDO F_CDT_ACCT_BOOKNG_EN T + [0..1] Credit Account Account Type Text {1,10} The account type of the credit account. . Mandatory as part of the Credit Account details when the Credit Account is validated, as required for remaining processing, and specifically Posting. Mapped into the PDO F_CDT_ACCT_ACC_TYPE Note: Should be populated with values that fit the Account Types configured in GPP. F_CDT_ACCT_IS_RESIDE 6 NT + [0..1] Credit Account Is Indicates whether the Resident credit account owner is a resident of the country for this account. [1,0] {1,1} Mapped into the PDO F_CDT_ACCT_IS_RESIDENT F_CDT_ACCT_IBAN 6 + [0..1] Credit Account IBAN The IBAN of the credit account Text {1,34} Mapped into the PDO F_CDT_ACCT_IBAN F_CDT_ACCT_STOPFLA GDR 6 + [0..1] Debit Stop Flag / Posting Restriction on Credit Account on indication Indicates that there is a [1,0] {1,1} debit Stop Flag / Posting Restriction set on the credit account. Debit Stop Flag / Posting Restriction on Credit Account Reason Text {1,35} The code / reason for the debit Stop Flag / Posting Restriction set on the credit account. F_CDT_ACCT_REASOND R 6 + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | [0..1] Mapped into the PDO F_CDT_ACCT_STOPFLAGDR Note: Specific reason indicated in the next tag Mapped into the PDO F_CDT_ACCT_REASONDR Note: Codes provided should quote values already configured in GPP as Stop Flags. Page 22 Tag L F_CDT_ACCT_STOPFLA GCR 6 F_CDT_ACCT_REASONC R M_DBT_CUST_PROFILE 0 1 2 3 4 5 6 7 8 9 10 + 6 5 + + Presence Element Description [0..1] Credit Stop Flag / Posting Restriction on Credit Account on indication [1,0] {1,1} Indicates that there is a credit Stop Flag/Posting Restriction set on the credit account. Credit Stop Flag / Posting Restriction on Credit Account Reason Text {1,35} The code/reason for the credit Stop Flag/Posting Restriction set on the credit account. Debit Customer Debit Customer Details [0..1] [0..1] Format Mapped From/Into GPP Table and Field Mapped into the PDO F_CDT_ACCT_STOPFLAGCR Note: Specific reason indicated in the next tag. Mapped into the PDO F_CDT_ACCT_REASONCR Note: Codes provided should quote values already configured in GPP as Stop Flags. Mapped into the Object that would have contained details from the Party profile of the debit customer, if Customers were managed in GPP Note: In the context of the Account Lookup usage, this is only expected to be populated if the invocation is for the transaction’s debit account, is DebitAccountLookup F_DBT_CUST_CUST_CAT 6 EGORY + [0..1] Debit Customer Category The debtor customer category 6 + [0..1] Debit Customer Name The debtor customer name Text {1,35} F_DBT_CUST_PROFESSI 6 ON + [0..1] Debit Customer Profession The debtor customer profession Text {1,4} Mapped into the PDO F_DBT_CUST_PROFESSION F_DBT_CUST_SWIFT_ID 6 + [0..1] Debit Customer BIC The BIC/BEI of the debtor customer. Text {1,12} Mapped into the PDO F_DBT_CUST_SWIFT_ID F_DBT_CUST_ABA 6 + [0..1] Debit Customer ABA The ABA of the debtor customer. Text {1,9} Mapped into the PDO F_DBT_CUST_ABA F_DBT_CUST_CUST_NA ME Text {1,10} Mapped into the PDO F_DBT_CUST_CUST_CATEG ORY Mapped into the PDO F_DBT_CUST_CUST_NAME Note: Relevant for US. GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 23 Tag L F_DBT_CUST_ALIAS 6 0 1 2 3 4 5 6 7 8 9 10 + Presence Element Description Format Mapped From/Into GPP Table and Field [0..1] Debit Customer FED Number The FED number of the debtor customer. Text {1,6} Mapped into the PDO F_DBT_CUST_ALIAS Note: Relevant for US. F_DBT_CUST_BASE_NO 6 + [0..1] Debit Customer External ID Text {1,34} The external Id of the debtor customer in the external financial institution system. Mapped into the PDO F_DBT_CUST_BASE_NO F_DBT_CUST_FEE_ACC OUNT_NO 6 + [0..1] Debit Customer Fee Account Number The fee account number to Text {1,34} be used for the debtor customer. Mapped into the PDO F_DBT_CUST_FEE_ACCOUN T_NO Note: This tag (and the next two) will only be specified if a separate fee account is required to be used for charging the debtor. F_DBT_CUST_FEE_ACC OUNT_CCY 6 + [0..1] Debit Fee Account Currency The currency of the debit fee account. [A-Z] {3, 3} F_DBT_CUST_FEE_ACC OUNT_OFFICE 6 + [0..1] Debit Fee Account Office The office of the debit fee account. [A-Z,0-9] {3, 3} Mapped into the PDO F_DBT_CUST_FEE_ACCOUN T_OFFICE F_DBT_CUST_STOPFLAG 6 FROM + [0..1] Debit Stop Flag / Posting Restriction on Debit Customer indication Indicates that there is a debit Stop Flag/Posting Restriction set on the debit customer. [1,0] {1,1} Mapped into the PDO F_DBT_CUST_STOPFLAGFR OM Debit Stop Flag / Posting Restriction on Debit Customer Reason The code/reason for the debit Stop Flag/Posting Restriction set on the debit customer. Text {1,35} Mapped into the PDO F_DBT_CUST_FROMREASO N F_DBT_CUST_FROMREA SON 6 + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | [0..1] Mapped into the PDO F_DBT_CUST_FEE_ACCOUN T_CCY Note: Specific reason indicated in the next tag. Note: Codes provided should quote values already configured in GPP as Stop Flags. Page 24 Tag L F_DBT_CUST_STOPFLAG 6 TO F_DBT_CUST_TOREASO N 6 0 1 2 3 4 5 6 7 8 9 10 + + Presence Element Description Format Mapped From/Into GPP Table and Field [0..1] Credit Stop Flag/Posting Restriction on Debit Customer Indication Indicates that there is a credit Stop Flag/Posting Restriction set on the debit customer. [1,0] {1,1} Mapped into the PDO F_DBT_CUST_STOPFLAGTO Credit Stop Flag/Posting Restriction on Debit Customer Reason The code/reason for the credit Stop Flag/Posting Restriction set on the debit customer. Text {1,35} Mapped into the PDO F_DBT_CUST_TOREASON [0..1] Note: Specific reason indicated in the next tag. Note: Codes provided should quote values already configured in GPP as Stop Flags. F_DBT_CUST_COUNTRY CODE 6 + [0..1] Country code Debtor address Country [A-Z] {3,3} Mapped into the PDO F_DBT_CUST_COUNTRYCO DE F_DBT_CUST_CITY 6 + [0..1] Debtor address city Debtor address city Text {1,35} Mapped into the PDO F_DBT_CUST_CITY F_DBT_CUST_ZIP 6 + [0..1] Zip code Debtor address Zip Code Text {1,10} Mapped into the PDO F_DBT_CUST_ZIP F_DBT_CUST_STATE 6 + [0..1] Debtor address State Debtor address state [A-Z] {2,2} Mapped into the PDO F_DBT_CUST_STATE F_DBT_CUST_ADDRESS 1 6 + [0..1] Debtor Address Line 1 Debtor address line 1 Text {1,35} Mapped into the PDO F_DBT_CUST_ADDRESS1 F_DBT_CUST_ADDRESS 2 6 + [0..1] Debtor Address Line 2 Debtor address line 2 Text {1,35} Mapped into the PDO F_DBT_CUST_ADDRESS2 F_DBT_CUST_ADDRESS 3 6 + [0..1] Debtor Address Line 3 Debtor address line 3 Text {1,35} Mapped into the PDO F_DBT_CUST_ADDRESS3 F_DBT_CUST_ADDRESS 4 6 + [0..1] Debtor Address Line 4 Debtor address line 4 Text {1,35} Mapped into the PDO F_DBT_CUST_ADDRESS4 GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 25 Tag L M_CDT_CUST_PROFILE 5 0 1 2 3 4 5 6 7 8 9 10 + Presence Element Description [0..1] Credit Customer Credit Customer Details Format Mapped From/Into GPP Table and Field Mapped into the Object that would have contained details from the Party profile of the credit customer, if Customers were managed in GPP Note: In the context of the Account Lookup usage, this is only expected to be populated if the invocation is for the transaction’s debit account, is CreditAccountLookup F_CDT_CUST_CUST_CAT 6 EGORY + [0..1] Credit Customer Category The creditor customer category Text {1,10} Mapped into the PDO F_CDT_CUST_CUST_CATEG ORY F_CDT_CUST_CUST_NA ME 6 + [0..1] Credit Customer Name The creditor customer name Text {1,35} Mapped into the PDO F_CDT_CUST_CUST_NAME F_CDT_CUST_PROFESSI 6 ON + [0..1] Credit Customer Profession The creditor customer profession Text {1,4} Mapped into the PDO F_CDT_CUST_PROFESSION F_CDT_CUST_SWIFT_ID 6 + [0..1] Credit Customer BIC The BIC/BEI of the creditor Text {1,12} customer. F_CDT_CUST_ABA 6 + [0..1] Credit Customer ABA The ABA of the creditor customer. Mapped into the PDO F_CDT_CUST_SWIFT_ID Text {1,9} Mapped into the PDO F_CDT_CUST_ABA Text {1,6} Mapped into the PDO F_CDT_CUST_ALIAS Note: Relevant for US. F_CDT_CUST_ALIAS 6 + [0..1] Credit Customer FED Number The FED number of the creditor customer. Note: Relevant for US. F_CDT_CUST_BASE_NO 6 + [0..1] Credit Customer External ID The external Id of the Text {1,34} creditor customer in the external financial institution system. Mapped into the PDO F_CDT_CUST_BASE_NO F_CDT_CUST_FEE_ACC OUNT_NO 6 + [0..1] Credit Customer Fee Account Number The fee account number to Text {1,34} be used for the creditor customer. Mapped into the PDO F_CDT_CUST_FEE_ACCOUN T_NO GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 26 Tag L F_CDT_CUST_FEE_ACC OUNT_CCY 6 F_CDT_CUST_FEE_ACC OUNT_OFFICE F_CDT_CUST_STOPFLA GFROM Presence Element Description Format Mapped From/Into GPP Table and Field + [0..1] Credit Fee Account Currency The currency of the credit fee account. [A-Z] {3, 3} Mapped into the PDO F_CDT_CUST_FEE_ACCOUN T_CCY 6 + [0..1] Credit Fee Account Office The office of the credit fee account. [A-Z,0-9] {3, 3} Mapped into the PDO F_CDT_CUST_FEE_ACCOUN T_OFFICE 6 + [0..1] Debit Stop Flag / Posting Restriction on Credit Customer Indication Indicates that there is a [1,0] {1,1} debit Stop Flag / Posting Restriction set on the credit customer. Debit Stop Flag / Posting Restriction on Credit Customer Reason The code/reason for the Text {1,35} debit Stop Flag/Posting Restriction set on the credit customer. Credit Stop Flag / Posting Restriction on Credit Customer Indication [1,0] {1,1} Indicates that there is a credit Stop Flag/Posting Restriction set on the credit customer. Credit Stop Flag / Posting Restriction on Credit Customer Reason Text {1,35} The code/reason for the credit Stop Flag/Posting Restriction set on the credit customer. F_CDT_CUST_FROMREA 6 SON F_CDT_CUST_STOPFLA GTO F_CDT_CUST_TOREASO N 6 6 0 1 2 3 4 5 6 7 8 9 10 + + + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | [0..1] [0..1] [0..1] Mapped into the PDO F_CDT_CUST_STOPFLAGFR OM Note: Specific reason indicated in the next tag. Mapped into the PDO F_CDT_CUST_FROMREASO N Note: Codes provided should quote values already configured in GPP as Stop Flags. Mapped into the PDO F_CDT_CUST_STOPFLAGTO Note: Specific reason indicated in the next tag. Mapped into the PDO F_CDT_CUST_TOREASON Note: Codes provided should quote values already configured in GPP as Stop Flags. Page 27 Tag L F_CDT_CUST_COUNTRY CODE 6 F_CDT_CUST_CITY 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field + [0..1] Creditor Country code Creditor address country [A-Z] {3,3} Mapped into the PDO F_CDT_CUST_COUNTRYCO DE 6 + [0..1] Debtor address city Creditor address city Text {1,35} Mapped into the PDO F_CDT_CUST_CITY F_CDT_CUST_ZIP 6 + [0..1] Creditor Zip code Creditor address Zip Code Text {1,10} Mapped into the PDO F_CDT_CUST_ZIP F_CDT_CUST_STATE 6 + [0..1] Creditor address State [A-Z] {2,2} Mapped into the PDO F_CDT_CUST_STATE F_CDT_CUST_ADDRESS 1 6 + [0..1] Creditor Address Creditor address line 1 Line 1 Text {1,35} Mapped into the PDO F_CDT_CUST_ADDRESS1 F_CDT_CUST_ADDRESS 2 6 + [0..1] Creditor Address Creditor address line 2 Line 2 Text {1,35} Mapped into the PDO F_CDT_CUST_ADDRESS2 F_CDT_CUST_ADDRESS 3 6 + [0..1] Creditor Address Creditor address line 2 Line 2 Text {1,35} Mapped into the PDO F_CDT_CUST_ADDRESS3 F_CDT_CUST_ADDRESS 4 6 + [0..1] Creditor Address Creditor address line 4 Line 4 Text {1,35} Mapped into the PDO F_CDT_CUST_ADDRESS4 M_CONTACT_INFO 5 [0..1] Contact Information Contacts Details M_CONTACT_LINE 6 [0..n] Contact Line Details of a specific Contact F_ CONTACT_OF 7 [0..1] Contact Of The entity that this entry serves as its contact for advising. Values: DR_PARTY, CR_PARTY, DR_ACCT, CR_ACCT, DR_FEE, CR_FEE + + + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Creditor address state Mapped into the Object that would have contained details from the Contact profile, if Contacts were managed in GPP Text {1,10} Mapped into the PDO F_CONTACT_OF Page 28 Tag L F_ CONTACT_NAME 7 F_CONTACT_DESCRIPTI ON 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/Into GPP Table and Field + [0..1] Contact Name Name of the contact. Text {1,35} Mapped into the PDO F_CONTACT_NAME 7 + [0..1] Contact Description Description of the contact. Text {1,200} Mapped into the PDO F_CONTACT_DESCRIPTION F_CONTACT_PHONE 7 + [0..1] Contact Phone Phone number of the contact. Text {1,35} Mapped into the PDO F_CONTACT_PHONE F_CONTACT_FAX 7 + [0..1] Contact Fax Fax number of the contact. Text {1,35} Mapped into the PDO F_CONTACT_FAX F_CONTACT_EMAIL 7 + [0..1] Contact Email Email address of the contact. Text {1,128} Mapped into the PDO F_CONTACT_EMAIL F_CONTACT_ADDRESS1 7 + [0..1] Contact Address1 First line of the address of the contact. Text {1,35} Mapped into the PDO F_CONTACT_ADDRESS1 F_CONTACT_ADDRESS2 7 + [0..1] Contact Address2 Second line of the address of the contact. Text {1,35} Mapped into the PDO F_CONTACT_ADDRESS2 F_CONTACT_ADDRESS3 7 + [0..1] Contact Address3 Third line of the address of the contact. Text {1,35} Mapped into the PDO F_CONTACT_ADDRESS3 F_CONTACT_ADDRESS4 7 + [0..1] Contact Address4 Fourth line of the address of the contact. Text {1,35} Mapped into the PDO F_CONTACT_ADDRESS4 F_CONTACT_ADDRESS5 7 + [0..1] Contact Address5 Fifth line of the address of the contact. Text {1,35} Mapped into the PDO F_CONTACT_ADDRESS5 F_CONTACT_ADDRESS6 7 + [0..1] Contact Address6 Sixth line of the address of the contact. Text {1,35} Mapped into the PDO F_CONTACT_ADDRESS6 ResponseDetails 2 [1..1] Response Details returnCode 3 [1..1] Return Code The return code to indicate success (1) or failure (any other code) of Account Lookup. [0-9] {1, 5} + + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 29 Tag L description 3 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format + [0..1] Description The description of the return code. Relevant only for a failure (not 1) . Text {1,250} Mapped From/Into GPP Table and Field Note: Any failure can be marked with 0, but it is preferable to use more specific codes to distinguish between posting restriction failure and any other failure. Mapping between financial institution codes and GPP internal codes should be configured to allow usage of financial institution codes. errorsList 3 error 4 code 5 description 5 dataArray 3 data 4 + [0..n] Error List [1..1] Error + [1..1] Code The return code to indicate one of multiple failure codes of Account Lookup. [0-9] {1, n} + [0..1] Description The description of the failure code. Text {1,250} [0..n] Data Array List of additional information entries, if required. [0..1] Data Additional information entry. + + + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | List of errors for this response. Text {1,250} Page 30 2.2.2 Minimal Scope + Fees Information Option When the financial institution system reports fees to be charged for the specific account/customer, and it is required that GPP will include these fees in the posting for the applicable transaction, the following additional tags can be included in the response. This functionality is not available for Account Lookup invocation in file handling flows during PreProcessing Transactions stage (on Source side in Outgoing CTs or DDs). These additional tags include the section with the fee information. Notes: Only the additional extension (on top of the extension specified in the previous section) is included in the following table. The main tree tags are also included, to show the path where the additional extension should be added in the structure. These tags are marked with grey font. Again, the Pmnt section is optional, although within the Product default scope, and can be excluded from this minimal scope structure. When a sub-tree tag is marked with * - the elements underneath it can appear in any order. That is the XSD definition of the list of elements is ’all’ and not ’sequence.’ Level 1 Level 2 Level 3 Level 4 Level 5 Description FndtMsg Header General identifying attributes Msg Transaction message and extension Pmnt Pmnt quotes the transaction (whether it is ISO based pain/pacs a SWIFT message embedded within the Fndt XML structure) For more information, see GPP Technical Guide Fndt Message document. Extn* MsgFees GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Message Fees. Multiple transaction fee details. Page 31 2.2.2.1 Detailed Structure When Using Minimal Scope + Fees Information Option When the financial institution system reports fees to be charged for the specific account/customer, and it is required that GPP will include these fees in the posting for the applicable transaction, the following additional tags can be included in the response. These additional tags are included in the extension with the fee information. Notes: Only additional tags (on top of the tags specified in the previous section) are included in the following table. The main tree tags are also included, to show the path where the additional tags should be added in the structure. These tags are marked with grey font. When a sub-tree tag is marked with * - the elements underneath it can appear in any order. That is the XSD definition of the list of elements is ’all’ and not ‘sequence.’ For the conventions of the Presence and Format columns in this table, see Appendix B: Conventions (Including Format and Presence). Tag L FndtMsg 1 0 1 2 3 4 5 6 7 8 9 10 + Presence Element [1..1] Fndt (Funds Transfer) Message [1..1] Message Description Format Mapped From/ Into GPP Table and Field … Msg 2 + Pmnt 3 + [0..1] Payment Extn* 3 + [1..1] Extension MsgFees* 4 [0..n] Message Fees + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | ISO or SWIFT message text that is stored in an XML structure in the XML_MSG. Optionally can be populated with value in in the request, or omitted - will not be used in GPP. When the external system needs to report fees to GPP, to be used and handled as fees computed Page 32 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/ Into GPP Table and Field in GPP, this section should be populated. M_MSG_FEES_LINE F_MSG_FEES_MANUAL_ FEE 5 6 + [1..1] + [1..1] Message Fees Info Information on the fee. Manual Fee Indicates a fee manually selected by a user or from external system (CDB). For each occurrence of M_MSG_FEES_LINE a Msg_Fees entry will be created in GPP for the message. Note: Only one occurrence of CDB fees (fee reported by the Account Lookup interface can be reported in this response per Fee Type that is defined in GPP). [2,1,0] {1, 1} Mapped into MSG_FEES.MANUAL_FE E Note: When fees reported via this response always populate with 2 (CDB). F_MSG_FEES_DEDUCT_ FROM 6 + [1..1] Deduct From Text {1,1} Indicates whether it is the transaction or account from which the fee is deducted. One of the following: A = Account. Fees should be deducted from an account (either a separate fee account or principal account). Mapped into MSG_FEES.DEDUCT_FR OM P = Payment. Fees should be deducted from the transaction amount to be charged to the customer on the next financial institution (BEN fees in case of credit transfer). F_MSG_FEES_FEE_APPL 6 Y + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | [1..1] Fee Apply Indicates when fees are applied. One of the following: NOW, LATER, WAIVE. Text {1,10} Mapped into MSG_FEES.APPLY Page 33 Tag L F_MSG_FEES_PAYING_P 6 ARTY 0 1 2 3 4 5 6 7 8 9 10 + Presence Element Description Format Mapped From/ Into GPP Table and Field [1..1] Paying Party Indicates the party that its fee arrangement defines the fee amount and application. It is not necessarily the party that pays the fee. One of the following: DR - Debit party CR -Credit party Text {1,2} Mapped into MSG_FEES.PAYING_PAR TY fractionDigits 4 Mapped into MSG_FEES.FEE_ACC_A MOUNT AF - Agent fee F_MSG_FEES_FEE_ACC_ 6 AMOUNT + [0..1] Fee Account Amount Amount (in fee account currency) that is deducted from fee account. totalDigits 19 Note: Relevant only for scenarios a fee account is involved. F_MSG_FEES_FEE_AMO UNT 6 + [1..1] The fee amount (in fee currency). fractionDigits 4 Fee Amount in Payment Currency The fee amount (in transaction currency). fractionDigits 4 Fee in Base Currency The fee amount (in base currency). fractionDigits 4 Fee Amount totalDigits 19 Mapped into MSG_FEES.FEE_AMOUN T F_MSG_FEES_FEE_AMT_ 6 IN_PMT_CCY + F_MSG_FEES_FEE_BAS E_AMOUNT 6 + F_MSG_FEES_FEE_CUR RENCY 6 + [1..1] Fee Currency Currency in which the fee is calculated. [A-Z] {3, 3} Mapped into MSG_FEES.FEE_CURRE NCY F_MSG_FEES_FEE_PNL_ 6 ACC_CUR + [0..1] Fee P&L Account Currency Currency of the Fee Profit and Loss account. [A-Z] {3, 3} Mapped into MSG_FEES.FEE_PNL_AC COUNT_CURRENCY GPP PAYplus | Fndt Message Usage for Account Lookup Interface | [0..1] [0..1] Note: If not provided will be first derived from the Fee Type Profile configured in totalDigits 19 totalDigits 19 Mapped into MSG_FEES.FEE_AMOUN T_IN_PMT_CCY Mapped into MSG_FEES.FEE_BASE_A MOUNT Page 34 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/ Into GPP Table and Field Text {1,34} Mapped into MSG_FEES.FEE_PNL_AC C_NO GPP and then mapped as if received. F_MSG_FEES_FEE_PNL_ 6 ACC_NO + [0..1] Fee P&L The Fee Profit and Loss Account Number account number. Note: If not provided will be first derived from the Fee Type Profile configured in GPP and then mapped as if received. F_MSG_FEES_FEE_PNL_ 6 ACC_OFFICE + [0..1] Fee P&L Account Office Office of the Fee Profit and [A-Z,0-9] {3, 3} Loss account. Note: If not provided will be first derived from the Fee Type Profile configured in GPP and then mapped as if received. F_MSG_FEES_FEE_PNL_ 6 AMOUNT + TAX_AMOUNT + 6 F_MSG_FEES_TAX_ACC_ 6 AMOUNT + F_TAX_BASE_AMOUNT + 6 F_MSG_FEES_TAX_PNL_ 6 ACCT + GPP PAYplus | Fndt Message Usage for Account Lookup Interface | [0..1] [0..1] [0..1] [0..1] [0..1] Fee P&L Amount The fee amount (in P&L account currency). fractionDigits 4 Tax Amount The tax amount (in fee currency). fractionDigits 4 The tax amount in the currency of the account from which the tax is deducted. fractionDigits 4 Tax P&L Amount The tax amount (in P&L account currency). fractionDigits 4 Tax P&L The tax Profit and Loss Account Number account number. Text {1,34} Tax Account Amount totalDigits 19 totalDigits 19 totalDigits 19 totalDigits 19 Mapped into MSG_FEES.FEE_PNL_AC C_OFFICE Mapped into MSG_FEES.FEE_PNL_AM OUNT Mapped into MSG_FEES.TAX_AMOUN T Mapped into MSG_FEES.TAX_ACC_A MOUNT Mapped into MSG_FEES.TAX_BASE_A MOUNT Mapped into MSG_FEES.TAX_PNL_AC CT Page 35 Tag L 0 1 2 3 4 5 6 7 8 9 10 Presence Element Description Format Mapped From/ Into GPP Table and Field F_MSG_FEES_TAX_PNL_ 6 ACCT_CCY + [0..1] Tax P&L Account Currency Currency of the tax Profit and Loss account. [A-Z] {3, 3} Mapped into MSG_FEES.TAX_PNL_AC CT_CCY F_MSG_FEES_TAX_PNL_ 6 ACCT_OFFICE + [0..1] Tax P&L Account Office Office of the tax Profit and Loss account. [A-Z,0-9] {3, 3} Mapped into MSG_FEES.TAX_PNL_AC CT_OFFICE F_TAX_ON_TAX_AMOUN T 6 + [0..1] Tax on Tax Amount The tax on tax amount (in transaction currency). fractionDigits 4 Mapped into MSG_FEES.TAX_ON_TAX _AMOUNT F_TAX_ON_TAX_ACC_A MOUNT 6 + [0..1] Tax on Tax Account Amount The tax on tax amount (in fractionDigits 4 the currency of the account totalDigits 19 from which the tax on tax is deducted) Mapped into MSG_FEES.TAX_ON_TAX _ACC_AMOUNT F_TAX_ON_TAX_PNL_AM 6 OUNT + [0..1] Tax on Tax P&L Amount The tax on tax amount (in P&L account currency). fractionDigits 4 Mapped into MSG_FEES.TAX_ON_TAX _PNL_AMOUNT F_MSG_FEES_FEE_TYPE 6 _UID + Fee Type UID The Fee Type UID for the Fee in this entry. Values should be pre-defined in GPP via the Fee Types profile (Fee_Types table). Text {1,100} [1..1] totalDigits 19 totalDigits 19 Mapped into MSG_FEES.FEE_TYPE_U ID Note: Should be populated in the following structure: Office + ‘^’ + Fee type name. GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 36 Note: Although the interface supports receiving proprietary return codes for the various failure responses, as long as the appropriate mapping between financial institution’s codes and GPP internal codes is pre-configured. When using the Standard Fndt Message, the FI can also directly use the GPP internal numeric return codes as follows: 1 – to indicate a Success 990 – to indicate a Processing/technical error 996 – to indicate a Posting restriction 0 – to indicate any error when no specific error handling is required but routing transaction to Repair 3 Usage For more information on logic related to STP processing and invocation points of the Account Lookup request, usage of the information provided in the Account Lookup response interface, related manual handling and related configuration see Account Lookup Interface section in the GPP Business Guide System Integration – Single Payment document. GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 37 Appendix A: Glossary of Terms This table lists the terms used in this guide. Term Description Fndt Message The FuNDs Transfer message structure is a GPP specific XML structure that is comprising of the full set of information as received, enriched, computed or manually updated per message. This structure is used as part of the standard interfaces for interacting with financial institution systems. ISO International Organization for Standards The prefix convention for naming transaction attribute fields is described in this table: Prefix Meaning Explanation T_ Tree Place holder in the tree view that hold the relevant associated information. For example: T_PARTIES holds all of the transaction parties X_ XML ISO ( ) information that is stored in an XML structure in the XML_MSG OX_ Original XML Copy of the originally received XML transaction ( ) information that is stored in an XML structure in ORIG_XML_MSG OC_ Original Copy of XML field Prefix used if there is more than one way to receive specific data. Example: OX_CDTR_AGT_BIC_1OR or OX_CDTR_AGT_BIC_2AND. GPP copies the data into OC_CDTR_AGT_BIC to facilitate determining whether creditor agent BIC was provided or not. Relevant only for originally received attributes. P_ Process GPP extension field for transaction data that cannot be placed in the ISO standard format. Commonly used attributes: P_MID, P_OFFICE, etc. F_ GPP derived transaction Derived attribute that are taken from the static data profile that attribute is associated with transaction details. For example, after P_CDT_MOP is determined, the related credit MOP profile attributes are set in these fields. Examples: F_CDT_MOP_NM is the credit MOP name derived from the credit MOP value. F_MOP_NM is associated with the debit MOP. D_ Derived Derived attributes that are calculated ‘on the fly’ while the GPP service is calculating the information. Derived fields are not stored in the transaction after processing is completed, or stopped for manual handling or wait. Therefore, they usually cannot be used as a condition in business rules. MU MF MI User Monitor Flow (service) monitor Interface monitor Monitors are divided into three categories: User monitors that track the user action over the UI such as forcing a transaction out of the insufficient funds queue Workflow monitors are internal monitors in the code that track the payment processing flow GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 38 Prefix Meaning Explanation Interface monitors that monitor interface interactions These P_ field attributes hold the monitor statuses strings for every transaction. P_USER_STATE_MONITOR - for User Monitors – MU_ prefix P_SERVICE_STATE_MONITOR - for Flow Monitors – MF_ prefix P_INTERFACE_STATE_MONITOR - for Interface Monitors – MI_ prefix The location of each monitor in the field is defined by LOGICAL_FIELDS.LOCATION. The first location is 0 (zero). Example of a monitor string P_ field value: XXXXXXXXXXXXXXXXXXXT. The following SQL can be used to check the full list of monitors as per their monitor P_field and their location: select lf.obj_ref_data_id, lf.location, lf.* from logical_fields lf where lf.obj_ref_data_id like %MONITOR order by 1,2 Appendix B: Conventions (Including Format and Presence) This table details naming conventions (including explanation of the values in the format and presence) used in the interfacestructures in this document. Term Meaning Tag name in Bold Indicate Aggregates ISO Date Time Date Time formats defined as ISO Date Time will conform to ISO8601. Representation: ISO Date Time with milliseconds: YYYY-MM-DD [T] {0,1} HH:MM:SS.mmm [Z,-,+] {1,1} HH:MM {0,1} ISO Date Time without milliseconds: YYYY-MM-DD [T] {0,1} HH:MM:SS [Z,-,+] {1,1} HH:MM {0,1} Where: YYYY is the year MM is the month (01 - 12) DD is the day (01 - 31) T is a literal separator between the date and time portions (optional) HH is the hour in 24 hour time MM is the minutes SS is the seconds mmm is the milliseconds Z is the time zone designator: Z for when time is in UTC time, OR +HH:MM; OR or -HH:MM GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 39 Term Meaning ISO Date Date formats defined as ISO Date Time will conform to ISO8601. Representation: YYYY-MM-DD Where: YYYY is the year, MM is the month (01 - 12) DD is the day (01 - 31) ISO Decimal Values Decimal values defined as ISO Decimal Values will use the ISO format definition using fractionDigits and totalDigits Where: totalDigits defines the total number of digits in the number (on both sides of the decimal point) fractionDigits defines the number of digits to the right of the decimal point (the fraction) SWIFT Date Date formats defined as SWIFT Date will conform to SWIFT representation: YYMMDD Where: YY is the year MM is the month (01 - 12) DD is the day (01 - 31) SWIFT Decimal Values Decimal values defined as SWIFT Decimal Values will use the SWIFT representation of digits and a comma acting as the decimal separator between the fraction and the full number Presence (Cardinality) 0..1 means Optional 1..1 means Required 0..n means Optional and may have multiple occurrences (limited to specified n) 1..n means required and may have multiple occurrences (limited to specified n) String format [character set] {min length, max length] [A-Z] means only upper letter characters [a-z] means only lower letter characters [0-9] means only digits [A-Za-z] means upper and lower letter characters Text means all characters {1,6} means a string at least one character long and no longer than 6 characters GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 40 Appendix C: Examples of Requests and Responses This section provides a set of request and response type examples: C.1 Debit Account Lookup Request This is an example of an Account Lookup request on the debit account. C.2 Credit Account Lookup Request This is an example of an Account Lookup request on the credit account. DebitAccountLookup DRACCLOOK String String 0 String 11209G4837O30871 2001-12-17T09:30:47-05:00 GPP 1112223334445556 … 123456789 GBP XX1 C.3 Successful Debit Account Lookup Response This is an example of a successful Account Lookup response on the debit account. Response returned with debit customer and debit account information and with two associated contacts on the account level. CreditAccountLookup CRACCLOOK String String 0 String 11209G4837O30871 2001-12-17T09:30:47-05:00 GPP 1112223334445556 … 987654321 USD GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 41 XX1 C.4 Successful Credit Account Lookup Response This is an example of a successful Account Lookup response on the credit account. Response returned with credit customer and credit account information and with one associated contact on the account level. DebitAccountLookup DRACCLOOK String String String 11209G4837O30871 2001-12-17T09:30:57-05:00 HOST_XXX 123456789 GBP XX1 YYY Katota Inv Sector FZE ZZZZ BISFAEA1 211122232 2111 XXXYYYMMMTTT 2244667788 USD XX1 AE RAS AL KHAIMAH Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon 1 xxx VOS 1 DR_ACC Jack Wilson GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 42Relationship Manager 97254222334456 97254222334111 jack.wilson@katota.com Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon RAS AL KHAIMAH, AE DR_ACC Laora Adams Head Relationship Manager 97254222334666 97254222334111 laora.adams@katota.com Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon RAS AL KHAIMAH, AE 1 Account Lookup success C.5 Successful Debit Account Lookup Response with Fees This is an example of a successful Account Lookup response on the debit account. Response returned with credit customer and credit account information and with one fee for Processing Fee Type, which was pre-calculated in the HOST system and is required to be included in the processing and calculation of fees and later posting for the transaction. CreditAccountLookup CRACCLOOK String String String 11209G4837O30871 2001-12-17T09:30:57-05:00 HOST_XXX 123456789 GBP XX1 GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 43 YYY Katota Inv Sector FZE ZZZZ BISFAEA1 211122232 2111 XXXYYYMMMTTT 2244667788 USD XX1 AE RAS AL KHAIMAH Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon 1 xxx VOS 1 CR_ACC Jack Wilson Relationship Manager 97254222334456 97254222334111 jack.wilson@katota.com Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon RAS AL KHAIMAH, AE 1 Account Lookup success C.6 Failed Account Lookup Response This is an example of a failed Account Lookup response on the debit account. Response returned with debit customer and debit account information. The Debit customer information includes a StopFlag on debiting the customer, due to the customer being dormant. DebitAccountLookup DRACCLOOK String String String GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 4411209G4837O30871 2001-12-17T09:30:57-05:00 HOST_XXX 2 A NOW DR 16.7 10 10 10 GBP GBP 9988776655 XX1 10 1 1 1 112243434 GBP XX1 0.1 0.1 0.1 XX1^Processing 2233998877 GBP XX1 123456789 GBP XX1 YYY Katota Inv Sector FZE ZZZZ BISFAEA1 211122232 2111 XXXYYYMMMTTT 2244667788 USD XX1 AE RAS AL KHAIMAH Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 45 1 xxx VOS 1 DR_ACC Jack Wilson Relationship Manager 97254222334456 97254222334111 jack.wilson@katota.com Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon RAS AL KHAIMAH, AE DR_ACC Laora Adams Head Relationship Manager 97254222334666 97254222334111 laora.adams@katota.com Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon RAS AL KHAIMAH, AE 1 Account Lookup success GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 47 DebitAccountLookup DRACCLOOK String String String 11209G4837O30871 2001-12-17T09:30:57-05:00 HOST_XXX GPP PAYplus | Fndt Message Usage for Account Lookup Interface | Page 46 123456789 GBP XX1 YYY Katota Inv Sector FZE ZZZZ BISFAEA1 211122232 2111 XXXYYYMMMTTT 2244667788 USD XX1 1 Dormant 1 Dormant AE RAS AL KHAIMAH Business Center 04, Floor 6 Business Park, 610a, Free Trade Zon 1 xxx VOS 1 996 Posting Restriction
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Language : en-US Tagged PDF : Yes XMP Toolkit : Adobe XMP Core 5.2-c001 63.139439, 2010/09/27-13:37:26 Format : application/pdf Creator : Finastra Description : Fndt Message Usage for Account Lookup Interface Title : Technical Guide Create Date : 2018:01:08 16:05:12+02:00 Creator Tool : Microsoft® Word 2016 Modify Date : 2018:01:08 16:05:24+02:00 Metadata Date : 2018:01:08 16:05:24+02:00 Producer : Microsoft® Word 2016 Document ID : uuid:a15ebcc3-9f87-4a96-a725-107c9e027c5d Instance ID : uuid:920706e3-bbac-48a9-abbe-c8d8ec4ada77 Page Mode : UseOutlines Page Count : 47 Author : Finastra Keywords : Global, PAYplus Subject : Fndt Message Usage for Account Lookup InterfaceEXIF Metadata provided by EXIF.tools