UBS Implementation Guidelines

Transcription

1 UBS Implementation Guidelines Swiss Recommendations for Payment Report pain ch.02 - SR Version UBS Version 1.0 July 2016

2 UBS Implementation Guidelines Swiss Recommendations for Payment Report Table of ontents 1. Payment Report Scope of application of this document Flow of messages in accordance with Swiss Recommendations 3 2. Technical specifications UBS Implementation Structure of pain.002 message Explanation of statuses used in this chapter 4 2

3 UBS Implementation Guidelines Swiss Recommendations for Payment Report 1. Payment Report 1.1 Scope of application of this document This brochure is designed to inform you about technical aspects of using the credit transfer message pain.002 at UBS. The document is valid within the following scope of application: haracteristics Use of message Product Service Message type available to Recommendation Schema Implementation Guide Version Replaces old messages vailable through UBS electronic interfaces Scope of application Swiss Recommendations for credit transfers for domestic and international transfers Payment Report Payment order ebtor Swiss Recommendations pain ch na For clients of UBS Switzerland UBS KeyPort (planned as of 2 nd quarter 2017) 1.2 Flow of messages in accordance with Swiss Recommendations The message standard recommended by Swiss financial institutions is based on the ISO Payments Standard, the Swiss Recommendations. The chart below provides an overview of the flow of messages currently supported by UBS and shows the use of pain.002 in the context of the end-to-end message flow: 3

4 UBS Implementation Guidelines Swiss Recommendations for Payment Report 2. Technical specifications 2.1 UBS Implementation The UBS Implementation Guideline for Payment Report this document contains technical specifications and instructions for the technical and business implementation of Payment Report pain.002 message in accordance with the Swiss Recommendations (see section1.1) and consequently also the ISO Payments Standard. ll Payment Report messages transmitted form UBS are complying with ISO Payments Standard, Swiss Recommendations and the UBS Implementation as outlined in this document. The diagram beside shows the degree of concordance between the ISO Payments Standard, Swiss Recommendations and the UBS Implementation and contains links to the according implementation guidelines that must be adhered to. ISO Payments Standard Swiss Recommendations UBS Implementation Structure of pain.002 message The pain.002 XML message is essentially structured as follows: -Level: message level, "Group Header". This block must occur exactly once. B-Level: information about the original message level, "Original Group Information nd ". This block must be present exactly once. -Level: Information about the original order information, "Original Payment Information nd ". This block can be present up to n times. -Level: Information about the original transactions, "Transaction Information nd ". This block can be present up to n times. 2.3 Explanation of statuses used in this chapter The following statuses (information about usage) are permitted for individual XML elements according to the Swiss Recommendations (Implementation Guidelines V1.5.1 and Business Rules V2.5) based on the ISO Payments Standard. M = Mandatory R = Recommended (should be used) = ependent (depending on other elements) O = Optional 4

5 Level XML Element efinition : M ISO Index: 1.0 : M ISO Index: Name ISO Index: 1.3 : O Length: Identification UBS Implementation Guidelines Swiss Recommendations for Payment Report ustomer Payment Report V03 stmrpmtstsrpt ISO efinition: The ustomerpaymentreport message is sent by an instructed agent to the payment initiator. It is used to inform this party about the positive or negative status of an instruction (either single, group or file). It is also used to report on a pending instruction. Group Header GrpHdr ISO efinition: Set of characteristics shared by all individual transactions included in the status report message. Initiating Party InitgPty ISO efinition: Party that initiates the status message. H efinition: Sender of the message One or more sub-elements can be used to give details of the sender. Name Nm ISO efinition: Name by which a party is known and which is usually used to identify that party. H efinition: Name of the sender of the message, maximum 70 characters Identification Id ISO efinition: Unique and unambiguous identification of a party. H efinition: Identification of the sender of the message ISO Index: 1.3 : O Organisation Identification OrgId ISO efinition: Unique and unambiguous way to identify an organisation. ++++Identification H efinition: Only "BI Or BEI" or an element of "Other" +++++Organisation Identification permitted. If used, the "Private Identification" must not be ISO Index: 1.3 present. UBS only provides <OrgI> with <BIOrBEI>. BIOr BEI BIOrBEI ISO efinition: ode allocated to a financial institution or non financial institution by the ISO 9362 Registration ++++Identification uthority as described in ISO 9362 "Banking Organisation Identification Banking telecommunication messages - Business BIOrBEI identifier code (BI)". lways "UBSWHZH80" Other Othr ISO efinition: Unique identification of an organisation, as assigned 5

6 UBS Implementation Guidelines Swiss Recommendations for Payment Report Level XML Element efinition ++++Identification +++++Organisation Identification Other by an institution, using an identification scheme. Identification Id ISO efinition: Identification assigned by an institution. UBS provides this information if sent in the incoming ++++Identification pain ch.02 file +++++Organisation Identification Other Identification : M Length: Identification +++++Private Identification ISO Index: ebtor gent ISO Index: reditor gent ISO Index: 1.6 Private Identification PrvtId ISO efinition: Unique and unambiguous identification of a person, eg, passport. H efinition: Only "ate nd Place Of Birth" or an element of "Other" permitted. If used, the "Organisation Identification" must not be present. ebtor gent btrgt ISO efinition: Financial institution servicing an account for the debtor. H efinition: Sender of the message an be used if the "ebtor gent" is the sender of the message. Only BI or the B number are permitted under "learing System Member Identification/Member Identification". Note: Element is only used for redit Transfer (original message "pain.001"). reditor gent dtrgt ISO efinition: Financial institution servicing an account for the creditor. H efinition: Sender of the message an be used if the "reditor gent" is the sender of the message. Only BI or the B number are permitted under "learing System Member Identification/Member Identification". Note: Element is only used for irect ebit (original message "pain.008"). B Original Group Information nd OrgnlGrpInfndSts ++OrgnlGrpInfndSts ISO efinition: Original group information concerning the group of transactions, to which the status report message ISO Index: 2.0 refers to. : M B Group 6

7 Level XML Element efinition B B B ++OrgnlGrpInfndSts +++Group ISO Index: OrgnlGrpInfndSts ISO Index: 2.7 ardinality: 0..unbounded ++OrgnlGrpInfndSts ++++Originator ISO Index: OrgnlGrpInfndSts ++++Reason UBS Implementation Guidelines Swiss Recommendations for Payment Report GrpSts ISO efinition: Specifies the status of a group of transactions. H efinition: The values "P", "W", "PRT" and "RJT" are sent in the status report. Reponses of a technical kind may also contain the status "T". epending on the financial institution and the delivery channel, the "Group " may not be required. eviating from the SEP recommendations, in Switzerland positive "Group " messages are also sent back. UBS provides the following status for redit Transfer (pain.001) files: P ccepted RJT Rejected PRT Partial rejection of the file W ccepted With hange UBS Example: <GrpSts>PRT</GrpSts> Reason Information StsRsnInf ISO efinition: Set of elements used to provide detailed information on the status reason. H efinition: Sent if there are errors/warnings at -Level. Note: " Reason Information" is used at no more than one level within a message, either in - "Original Group Information nd " or - "Original Payment Information nd " or - "Transaction Information nd ". If "Group " = "P" the " Reason Information" is not used. If "Group " = "PRT" the " Reason Information" is used either at the level "Original Payment Information nd " or "Transaction Information nd ". If "Group " = "RJT" because all B-Levels have been rejected, the " Reason Information" is used at the level "Original Payment Information and ". If "Group " = "RJT" because all -Levels have been rejected, the " Reason Information" is used at the level "Transaction Information nd ". Originator Orgtr ISO efinition: Party that issues the status. H efinition: Originator of the status information an be used if the originator of the status information is not the sender of the message ("Group Header/ Initiating Party" or "Group Header/reditor gent"). Reason Rsn ISO efinition: Specifies the reason for the status report. H efinition: Reason for the status B ISO Index: 2.9 : M ++OrgnlGrpInfndSts ++++Reason +++++ode ode d ISO efinition: Reason for the status, as published in an external reason code list. H efinition: ode as described in section " Reason odes" If used, then "Proprietary" must not be present. UBS supports all odes according to Swiss 7

8 Level XML Element efinition B B ISO Index: 2.10 Length: OrgnlGrpInfndSts ++++Reason +++++Proprietary ISO Index: 2.11 Length: OrgnlGrpInfndSts ++++dditional Information ISO Index: 2.12 ardinality: 0..unbounded : O Length: ISO Index: 3.0 ardinality: 0..unbounded +++Payment Information ISO Index: 3.4 ISO Index: 3.5 ardinality: 0..unbounded UBS Implementation Guidelines Swiss Recommendations for Payment Report recommendations. In case of a scheme error (e.g. delivered ode not covered by the scheme) the whole file is rejected with status code FF01. For individual status information, the ISO-ode NRR is sent in the ode element and the relevant information is entered in the dditional Information element. Proprietary Prtry ISO efinition: Reason for the status, in a proprietary form. H efinition: Swiss financial institutions will, wherever possible, abide by ISO standards ("ode" element). If used, then "ode" must not be present. dditional Information ddtlinf ISO efinition: Further details on the status reason. Usage: dditional information can be used for several purposes such as the reporting of repaired information. H efinition: an be used optionally to provide additional information about the "Reason". Used by UBS to provide additional information, if applicable. Original Payment Information nd OrgnlPmtInfndSts ISO efinition: Information concerning the original payment information, to which the status report message refers. H efinition: Is sent if there are errors/warnings at B-/-Level of the original "pain.001" or "pain.008" message. Payment Information PmtInfSts ISO efinition: Specifies the status of the payment information group. H efinition: This element is sent if there are errors/warnings at B- Level of the order (pain.001). Only "W", "PRT", "RJT" are sent, no other interim status. eviating from SEP, positive "Payment Information-" messages are also sent back. dditional status messages may include other values, such as "T" for instance (after a purely technical validation of the received message) or "P" (status message due to a status change of an order or as a response to individual B-Levels). UBS provides the status W, PRT and RJT. UBS Example: <PmtInfSts>PRT</PmtInfSts> Reason Information StsRsnInf ISO efinition: Set of elements used to provide detailed information on the status reason. H efinition: Is sent if there are errors/warnings at B-Level. Note: " Reason Information is used at no more than one level within a message, either in - "Original Group Information nd " or - "Original Payment Information nd " or - "Transaction Information nd ". If "PmtInfSts" = "W" because warnings at - Level have occurred, the " Reason Information" is used at the level "Transaction Information nd 8

9 Level XML Element efinition ++++Originator ISO Index: Reason UBS Implementation Guidelines Swiss Recommendations for Payment Report ". If "PmtInfSts" = "PRT" the " Reason Information" is used at the level "Transaction Information nd ". If "PmtInfSts" = "RJT" because all -Levels have been rejected, the " Reason Information" is used at the level "Transaction Information nd ". Originator Orgtr ISO efinition: Party that issues the status. H efinition: Originator of the status information an be used if the originator of the status information is not the sender of the message ("Group Header/ Initiating Party" or "Group Header/reditor gent"). Reason Rsn ISO efinition: Specifies the reason for the status report. H efinition: Reason for the status Must be used if " Reason Information" is used. ISO Index: 3.7 : M ++++Reason +++++ode ISO Index: 3.8 Length: Reason +++++Proprietary ISO Index: 3.9 Length: dditional Information ISO Index: 3.10 ardinality: 0..unbounded : O Length: ode d ISO efinition: Reason for the status, as published in an external reason code list. H efinition: ode as described in section " Reason odes" If this is used, "Proprietary" must not be present. UBS supports all odes according to Swiss recommendations. For individual status information, the ISO-ode NRR is sent in the ode element and the relevant information is entered in the dditional Information element. UBS Example: <StsRsnInf> <Rsn> <d>01</d> </Rsn> <ddtlinf>(reditor ccount IBN) Invalid IBN check digit</ddtlinf> </StsRsnInf> Proprietary Prtry ISO efinition: Reason for the status, in a proprietary form. H efinition: Swiss financial institutions will, wherever possible, abide by ISO standards ("ode" element). If used, then "ode" must not be present. dditional Information ddtlinf ISO efinition: Further details on the status reason. Usage: dditional information can be used for several purposes such as the reporting of repaired information. H efinition: an be used optionally to provide additional information about the "Reason". Used by UBS to provide additional information, if 9

10 Level XML Element efinition ISO Index: 3.15 ardinality: 0..unbounded ++++ Identification ISO Index: 3.16 : O Length: Original Instruction Identification ISO Index: 3.17 Length: Original End To End Identification ISO Index: 3.18 Length: Transaction UBS Implementation Guidelines Swiss Recommendations for Payment Report applicable. Transaction Information nd TxInfndSts ISO efinition: Set of elements used to provide information on the original transactions to which the status report message refers. H efinition: Is sent if there are errors/warnings at -Level of the original "pain.001" or "pain.008" message. Identification StsId ISO efinition: Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the reported status. Usage: The instructing party is the party sending the status message and not the party that sent the original instruction that is being reported on. H efinition: Unique identification, set by the originator of this message. UBS does not provide this element. Original Instruction Identification OrgnlInstrId ISO efinition: Unique identification, as assigned by the original instructing party for the original instructed party, to unambiguously identify the original instruction. H efinition: "Instruction Identification" (-Level) from the original message. Is always sent if there are errors/warnings at -Level (if not available, then "NOTPROVIE" is sent). UBS reports this element on pain.002 -Level if the original pain.001 contains error(s) on -Level. If Instruction I is not delivered in pain.001, this element is filled with NOTPROVIE. Original End To End Identification OrgnlEndToEndId ISO efinition: Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction. H efinition: "End To End Identification" (-Level) from the original message. Is always sent if there are errors/warnings at -Level (if not available or empty, then "NOTPROVIE" is sent). ISO Index: 3.19 UBS Example: + UBS reports this element on pain.002 -Level if the original pain.001 contains error(s) on -Level. If the EndToEndId is not delivered, then respectively -Level of the pain.001 will be rejected and 'NOTPROVIE' is mapped in the pain.002 message. Transaction TxSts ISO efinition: Specifies the status of a transaction, in a coded form. H efinition: Is sent if there are errors/warnings at -Level. Only "W" and "RJT" are sent, no other interim status. "P" is not sent explicitly. UBS provides the status W and RJT. <TxSts>RJT</TxSts> Reason Information StsRsnInf ISO efinition: Set of elements used to provide detailed information on the status reason. H efinition: Is sent if there are errors/warnings at -Level. Note: " Reason Information" is used at no more than one level within a message, either in - "Original Group Information nd " or 10

11 Level XML Element efinition ISO Index: 3.20 ardinality: 0..unbounded Originator ISO Index: Reason UBS Implementation Guidelines Swiss Recommendations for Payment Report - "Original Payment Information nd " or - "Transaction Information nd ". Originator Orgtr ISO efinition: Party that issues the status. H efinition: Originator of the status information an be used if the originator of the status information is not the sender of the message ("Group Header/ Initiating Party" or "Group Header/reditor gent"). UBS does not provide this element. Reason Rsn ISO efinition: Specifies the reason for the status report. H efinition: Reason for the status Must be used if " Reason Information" is used. ISO Index: 3.22 : M Reason ode ISO Index: 3.23 Length: Reason Proprietary ode d ISO efinition: Reason for the status, as published in an external reason code list. H efinition: ode as described in section " Reason odes" If this is used, "Proprietary" must not be present. UBS Example: UBS supports all odes according to Swiss recommendations. For individual status information, the ISO-ode NRR is sent in the ode element and the relevant information is entered in the dditional Information element. <StsRsnInf> <Rsn> <d>01</d> </Rsn> <ddtlinf>(reditor ccount IBN) Invalid IBN check digit</ddtlinf> </StsRsnInf> Proprietary Prtry ISO efinition: Reason for the status, in a proprietary form. H efinition: Swiss financial institutions will, wherever possible, abide by ISO standards ("ode" element). If used, then "ode" must not be present. ISO Index: 3.24 Length: dditional Information ddtlinf ISO efinition: Further details on the status reason. Usage: dditional information can be used for several + purposes such as the reporting of repaired +++++dditional Information information. H efinition: an be used optionally to provide additional ISO Index: 3.25 information about the " Reason". 11

12 Level XML Element efinition ardinality: 0..unbounded : O Length: ISO Index: Interbank Settlement ate ISO Index: Requested ollection ate UBS Implementation Guidelines Swiss Recommendations for Payment Report Used by UBS to provide the additional information, if necessary. Original Transaction OrgnlTxRef ISO efinition: Set of key elements used to identify the original transaction that is being referred to. H efinition: Original elements from the original message Generally only those elements are sent back which caused warnings or errors. Optionally, other fields can be sent back, including complete transactions that have been submitted. Used by UBS to report back the -Level element, where the error occurred. Interbank Settlement ate IntrBkSttlmt ISO efinition: ate 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. H efinition: Effective settlement date Sent if the required settlement date has been set for the next banking business/post Office working day. UBS does not provide this element in the pain.002 when a redit Transfer (pain.001) is sent. Requested ollection ate Reqdolltnt ISO efinition: ate and time at which the creditor requests that the amount of money is to be collected from the debtor. H efinition: Information from the original message Element is only used for irect ebit (original message "pain.008"). UBS does provide this element in the pain.002 only when a irect ebit (pain.008) is sent. ISO Index: 3.40 : O reditor Scheme Identification dtrschmeid ISO efinition: redit party that signs the mandate. H efinition: Information from the original message Element is only used for irect ebit (original message "pain.008") reditor Scheme Identification ISO Index: 3.42 : O Payment Type Information PmtTpInf ISO efinition: Set of elements used to further specify the type of transaction. H efinition: Information from the original message UBS provides this element if sent in the original pain Payment Type Information ISO Index: 3.55 : O Payment Method PmtMtd 12

13 Level XML Element efinition +++++Payment Method UBS Implementation Guidelines Swiss Recommendations for Payment Report ISO efinition: Specifies the means of payment that will be used to move the amount of money. H efinition: Information from the original message ISO Index: 3.68 : O +++++Ultimate ebtor Ultimate ebtor Ultmtbtr ISO efinition: Ultimate party that owes an amount of money to the (ultimate) creditor. H efinition: Information from the original message UBS provides this element if sent in the original pain ISO Index: : O +++++ebtor ebtor btr ISO efinition: Party that owes an amount of money to the (ultimate) creditor. H efinition: Information from the original message UBS provides the name and address for this element ISO Index: : O +++++reditor gent reditor gent dtrgt ISO efinition: Financial institution servicing an account for the creditor. H efinition: Information from the original message UBS does provide this element in the pain.002 if sent in the original redit Transfer (pain.001) ISO Index: : O reditor dtr ISO efinition: Party to which an amount of money is due. H efinition: Information from the original message UBS provides the name and address for this element reditor ISO Index: : O Ultimate reditor Ultmtdtr ISO efinition: Ultimate party to which an amount of money is due. H efinition: Information from the original message 13

14 UBS Implementation Guidelines Swiss Recommendations for Payment Report Level XML Element efinition +++++Ultimate reditor ISO Index: : O 14

15 UBS Implementation Guidelines Swiss Recommendations for Payment Report UBS Switzerland G P.O. Box 8098 Zurich Switzerland sh-keydirect@ubs.com This publication is intended for information only and is not intended as a recommendation, an offer or a solicitation of an offer. Before making a decision, you should obtain relevant professional advice. Please note that UBS reserves the right to alter its services, products or prices at any time without prior notice. ertain products and services are subject to legal restrictions and cannot be offered worldwide on an unrestricted basis. Reproduction in whole or part is prohibited without prior permission from UBS. UBS The key symbol and UBS are among the registered and unregistered trademarks of UBS. ll rights reserved. 15