gateway documentation - fcubscustomeradditionalservice ......2. fcubscustomeradditionalservice...
TRANSCRIPT
Gateway Documentation - FCUBSCustomerAdditionalServiceOracle FLEXCUBE Universal Banking
Release 12.87.02.0.0[Febraury][2016]
Table Of Contents
1. Background ......................................................................... 1
2. FCUBSCustomerAdditionalService ......................................................................... 2
2.1.QueryConsolEnq ......................................................................... 2
2.1.1.ST-QueryConsolEnq-Req-IO-MSG.xsd ......................................................................... 2
2.1.2.ST-QueryConsolEnq-Res-Full-MSG.xsd ......................................................................... 11
2.2.QueryCustPIDInfo ......................................................................... 34
2.2.1.ST-QueryCustPIDInfo-Req-IO-MSG.xsd ......................................................................... 34
2.2.2.ST-QueryCustPIDInfo-Res-Full-MSG.xsd ......................................................................... 41
2.3.QueryValidateCustName ......................................................................... 54
2.3.1.ST-QueryValidateCustName-Req-IO-MSG.xsd ......................................................................... 54
2.3.2.ST-QueryValidateCustName-Res-Full-MSG.xsd ......................................................................... 61
1. Background
Integration of different applications and solutions is a key area in today's systems.A variety of specialized applications deployed on disparate platforms and using different infrastructure need to be able to communicate and integrate seamlessly with FLEXCUBE UBS in order to exchange data.The FLEXCUBE UBS Integration Gateway (referred to as Gateway) will cater to these integration needs.The integration needs supported by the Gateway can be broadly categorized from the perspective of Gateway as follows
1. Inbound application integration :
This is used when any external system needs to add, modify or query information within FLEXCUBE UBS
2. Outbound application integration :
This is used when any external system needs to be notified of the various events that occur within FLEXCUBE UBS
The following sections provide detailed XSD documentation of all operations available in FCUBSCustomerAdditionalService of Core Module
1
2. FCUBSCustomerAdditionalService
2.1.QueryConsolEnq
2.1.1.ST-QueryConsolEnq-Req-IO-MSG.xsd
QUERYCONSOLENQ_IOFS_REQ
FCUBS_HEADER
SOURCE
UBSCOMP
MSGID
CORRELID
USERID
BRANCH
MODULEID
SERVICE
OPERATION
SOURCE_OPERATION
SOURCE_USERID
DESTINATION
MULTITRIPID
FUNCTIONID
ACTION
MSGSTAT
PASSWORD
ADDL
PARAM
NAME
VALUE
FCUBS_BODY
Master-IO
BENEFIT_FOR
CUSTMERNO
CUSTSERVICEMODEL
BRN_CODE 2
ACC_CCY
AC_CLASS
ACCNO1
CCY_PAIR
CCY1
CCY2
DE_RATE_TYPE
QUERYCONSOLENQ_IOFS_REQ
Attribute DescriptionName QUERYCONSOLENQ_IOFS_REQDatatypeDescription
FCUBS_HEADER
Attribute DescriptionName FCUBS_HEADERDatatypeDescription
SOURCE
Attribute DescriptionName SOURCEDatatype StringDescription This is the code for the system which has sourced this message.
For request messages, this field has to contain the source code for the partner system as maintained within FLEXCUBE UBS. In case of response messages this field will contain "FLEXCUBE".
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
UBSCOMP
Attribute DescriptionName UBSCOMPDatatype StringDescription This is the component of FLEXCUBE for which this message is
meant. Gateway supports both FLEXCUBE UBS and FLEXCUBE Investor Services. If the message is for FLEXCUBE UBS then this field should contain "FCUBS" and "FCIS" if meant for FLEXCUBE Investor Services. This field is case-sensitive.
Restrictions
Restrictions Descriptionenumeration FCUBS,FCIS
MSGID
Attribute Description
3
Name MSGIDDatatype StringDescription This is the "unique" message ID for this message. In inbound
messages, if this field is present then Gateway would perform technical duplicate recognition using this field. For all messages going out from Gateway, Gateway will populate a unique message ID in this field.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
CORRELID
Attribute DescriptionName CORRELIDDatatype StringDescription This is the correlation ID for the message. Gateway supports 2
correlation patterns, namely "Message ID to Correlation ID" (M2C) and "Correlation ID to Correlation ID" (C2C). While using asynchronous means of communication (like a JMS queue), the partner system can correlate the response received from Gateway to the request message sent by it using this field. If the correlation pattern is M2C then this field will contain the MSGID of the request message. If the correlation pattern is C2C then this field will contain the CORRELID of the request message.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
USERID
Attribute DescriptionName USERIDDatatype StringDescription This is the user id which will be used within FLEXCUBE to record
the transaction. This needs to be a valid user id as maintained within FLEXCUBE.
Restrictions
Restrictions DescriptionmaxLength 12pattern [A-Z_0-9]*
BRANCH
Attribute DescriptionName BRANCHDatatype StringDescription This is the Branch of FLEXCUBE where the transaction would be
recorded. This needs to be a valid Branch code as maintained in FLEXCUBE.
4
Restrictions
Restrictions Descriptionlength 3pattern [a-zA-Z_0-9]{3}
MODULEID
Attribute DescriptionName MODULEIDDatatype StringDescription This field is applicable only if messages are being sent to FCIS
using Gateway. This is the module id of FCIS where the transaction will be recorded.
Attribute
Attribute DescriptionminOccurs 0
SERVICE
Attribute DescriptionName SERVICEDatatype StringDescription This field should contain the code of the Service of FLEXCUBE which
is being requested. This field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
OPERATION
Attribute DescriptionName OPERATIONDatatype StringDescription This is the operation of the service which is being invoked. This
field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_OPERATION
Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescription This is the code for the operation being invoked in the Source
system. The code of Source Operation being sent needs to be maintained as a valid Source Operation for the Source within FLEXCUBE.
5
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_USERID
Attribute DescriptionName SOURCE_USERIDDatatype StringDescription This is the user id in the Source system who is performing the action.Attribute
Attribute DescriptionminOccurs 0
DESTINATION
Attribute DescriptionName DESTINATIONDatatype StringDescription This the system for which this message is destined. In case of
request messages to FLEXCUBE, it should be "FLEXCUBE". In case of response, the SOURCE from the request message is reproduced here.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MULTITRIPID
Attribute DescriptionName MULTITRIPIDDatatype StringDescription In response messages, this is the ID sent by FLEXCUBE in case
any overrides are encountered. In request messages, the source system is expected to reproduce the MULTITRIPID from the earlier received response if the source system accepts the overrides.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
FUNCTIONID
Attribute DescriptionName FUNCTIONID
6
Datatype StringDescription This is the function in FLEXCUBE which is being invoked. For
integration scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
ACTION
Attribute DescriptionName ACTIONDatatype StringDescription This is the action on the function being invoked. For integration
scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MSGSTAT
Attribute DescriptionName MSGSTATDatatype StringDescription In response messages, FLEXCUBE will indicate the status of the
request in this field. The various values are "SUCCESS", "WARNING" and "FAILURE".
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionenumeration SUCCESS,WARNING,FAILURE
PASSWORD
Attribute DescriptionName PASSWORDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
7
Restrictions
Restrictions DescriptionmaxLength 128pattern [a-zA-Z_0-9=+/]*
ADDL
Attribute DescriptionName ADDLDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0
PARAM
Attribute DescriptionName PARAMDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
NAME
Attribute DescriptionName NAMEDatatype StringDescription
VALUE
Attribute DescriptionName VALUEDatatype StringDescription
FCUBS_BODY
Attribute DescriptionName FCUBS_BODYDatatypeDescription
Master-IO
Attribute DescriptionName Master-IODatatypeDescription
BENEFIT_FOR
Attribute Description
8
Name BENEFIT_FORDatatype StringDescriptionRestrictions
Restrictions Descriptionenumeration A,Z,E
CUSTMERNO
Attribute DescriptionName CUSTMERNODatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 9
CUSTSERVICEMODEL
Attribute DescriptionName CUSTSERVICEMODELDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 35
BRN_CODE
Attribute DescriptionName BRN_CODEDatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
ACC_CCY
Attribute DescriptionName ACC_CCYDatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
AC_CLASS
Attribute DescriptionName AC_CLASS
9
Datatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 6
ACCNO1
Attribute DescriptionName ACCNO1Datatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 20
CCY_PAIR
Attribute DescriptionName CCY_PAIRDatatype StringDescriptionRestrictions
Restrictions Descriptionenumeration S,L,N,
CCY1
Attribute DescriptionName CCY1Datatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
CCY2
Attribute DescriptionName CCY2Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 3
DE_RATE_TYPE
Attribute DescriptionName DE_RATE_TYPEDatatype String
10
DescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8
2.1.2.ST-QueryConsolEnq-Res-Full-MSG.xsd
QUERYCONSOLENQ_IOFS_RES
FCUBS_HEADER
SOURCE
UBSCOMP
MSGID
CORRELID
USERID
BRANCH
MODULEID
SERVICE
OPERATION
SOURCE_OPERATION
SOURCE_USERID
DESTINATION
MULTITRIPID
FUNCTIONID
ACTION
MSGSTAT
PASSWORD
ADDL
PARAM
NAME
VALUE
FCUBS_BODY
Master-IO
BENEFIT_FOR
11
CUSTMERNO
CUSTSERVICEMODEL
BRN_CODE
ACC_CCY
AC_CLASS
ACCNO1
CCY_PAIR
CCY1
CCY2
DE_RATE_TYPE
Master-Full
PIDNUMBER
BENEFIT_FOR
CUSTMERNO
CUSTNM
CUSTSERVICEMODEL
BRN_CODE
ACC_CCY
AC_CLASS
ACCOUNT_CLASS_DESC
ACCLSTYP
ACCNO1
CCY_PAIR
CCY1
CCY2
DE_RATE_TYPE
INTRATEA
RP_VARIANCE
RATE_INCL_VAR
Cust-Query-Dtl
DFLT_IC_PROD
AMOUNT_UDE_ID12
AMNT
TENOR_TO
RATE_UDE_ID
RATE_UDE_VALUE
BEN_PLAN_ID
PRICE_COMP
VAR_VALUE
CA_RT_WITH_VARIANCE
Zn-Chrgs
ZN_BEN_PLAN_ID
ZN_BEN_DESC
ZN_PROD_TYPE
TOTAL_FREE_TXN
UTL_TXN
REM_TXN
Ex-Rate
CY_CCY1
CY_CCY2
MID_RATE
CY_BEN_PLAN
CY_RATE
SPREAD_APPLIED
CY_BUY_RATE
CY_BUY_SPREAD
CY_SELL_RATE
CY_SELL_SPREAD
FCUBS_ERROR_RESP
ERROR
ECODE
EDESC
FCUBS_WARNING_RESP
WARNING13
WCODE
WDESC
QUERYCONSOLENQ_IOFS_RES
Attribute DescriptionName QUERYCONSOLENQ_IOFS_RESDatatypeDescription
FCUBS_HEADER
Attribute DescriptionName FCUBS_HEADERDatatypeDescription
SOURCE
Attribute DescriptionName SOURCEDatatype StringDescription This is the code for the system which has sourced this message.
For request messages, this field has to contain the source code for the partner system as maintained within FLEXCUBE UBS. In case of response messages this field will contain "FLEXCUBE".
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
UBSCOMP
Attribute DescriptionName UBSCOMPDatatype StringDescription This is the component of FLEXCUBE for which this message is
meant. Gateway supports both FLEXCUBE UBS and FLEXCUBE Investor Services. If the message is for FLEXCUBE UBS then this field should contain "FCUBS" and "FCIS" if meant for FLEXCUBE Investor Services. This field is case-sensitive.
Restrictions
Restrictions Descriptionenumeration FCUBS,FCIS
MSGID
Attribute DescriptionName MSGIDDatatype StringDescription This is the "unique" message ID for this message. In inbound
messages, if this field is present then Gateway would perform technical duplicate recognition using this field. For all messages going out from Gateway, Gateway will populate a unique message ID in this field.
14
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
CORRELID
Attribute DescriptionName CORRELIDDatatype StringDescription This is the correlation ID for the message. Gateway supports 2
correlation patterns, namely "Message ID to Correlation ID" (M2C) and "Correlation ID to Correlation ID" (C2C). While using asynchronous means of communication (like a JMS queue), the partner system can correlate the response received from Gateway to the request message sent by it using this field. If the correlation pattern is M2C then this field will contain the MSGID of the request message. If the correlation pattern is C2C then this field will contain the CORRELID of the request message.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
USERID
Attribute DescriptionName USERIDDatatype StringDescription This is the user id which will be used within FLEXCUBE to record
the transaction. This needs to be a valid user id as maintained within FLEXCUBE.
Restrictions
Restrictions DescriptionmaxLength 12pattern [A-Z_0-9]*
BRANCH
Attribute DescriptionName BRANCHDatatype StringDescription This is the Branch of FLEXCUBE where the transaction would be
recorded. This needs to be a valid Branch code as maintained in FLEXCUBE.
Restrictions
Restrictions Descriptionlength 3pattern [a-zA-Z_0-9]{3}
MODULEID15
Attribute DescriptionName MODULEIDDatatype StringDescription This field is applicable only if messages are being sent to FCIS
using Gateway. This is the module id of FCIS where the transaction will be recorded.
Attribute
Attribute DescriptionminOccurs 0
SERVICE
Attribute DescriptionName SERVICEDatatype StringDescription This field should contain the code of the Service of FLEXCUBE which
is being requested. This field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
OPERATION
Attribute DescriptionName OPERATIONDatatype StringDescription This is the operation of the service which is being invoked. This
field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_OPERATION
Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescription This is the code for the operation being invoked in the Source
system. The code of Source Operation being sent needs to be maintained as a valid Source Operation for the Source within FLEXCUBE.
Attribute
Attribute DescriptionminOccurs 0
16
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_USERID
Attribute DescriptionName SOURCE_USERIDDatatype StringDescription This is the user id in the Source system who is performing the action.Attribute
Attribute DescriptionminOccurs 0
DESTINATION
Attribute DescriptionName DESTINATIONDatatype StringDescription This the system for which this message is destined. In case of
request messages to FLEXCUBE, it should be "FLEXCUBE". In case of response, the SOURCE from the request message is reproduced here.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MULTITRIPID
Attribute DescriptionName MULTITRIPIDDatatype StringDescription In response messages, this is the ID sent by FLEXCUBE in case
any overrides are encountered. In request messages, the source system is expected to reproduce the MULTITRIPID from the earlier received response if the source system accepts the overrides.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
FUNCTIONID
Attribute DescriptionName FUNCTIONIDDatatype StringDescription This is the function in FLEXCUBE which is being invoked. For
integration scenarios this need not be sent. This is used by FLEXCUBE native user interface.
17
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
ACTION
Attribute DescriptionName ACTIONDatatype StringDescription This is the action on the function being invoked. For integration
scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MSGSTAT
Attribute DescriptionName MSGSTATDatatype StringDescription In response messages, FLEXCUBE will indicate the status of the
request in this field. The various values are "SUCCESS", "WARNING" and "FAILURE".
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionenumeration SUCCESS,WARNING,FAILURE
PASSWORD
Attribute DescriptionName PASSWORDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 128pattern [a-zA-Z_0-9=+/]*
ADDL18
Attribute DescriptionName ADDLDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0
PARAM
Attribute DescriptionName PARAMDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
NAME
Attribute DescriptionName NAMEDatatype StringDescription
VALUE
Attribute DescriptionName VALUEDatatype StringDescription
FCUBS_BODY
Attribute DescriptionName FCUBS_BODYDatatypeDescription
Master-IO
Attribute DescriptionName Master-IODatatypeDescription
BENEFIT_FOR
Attribute DescriptionName BENEFIT_FORDatatype StringDescriptionRestrictions
Restrictions Descriptionenumeration A,Z,E
19
CUSTMERNO
Attribute DescriptionName CUSTMERNODatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 9
CUSTSERVICEMODEL
Attribute DescriptionName CUSTSERVICEMODELDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 35
BRN_CODE
Attribute DescriptionName BRN_CODEDatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
ACC_CCY
Attribute DescriptionName ACC_CCYDatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
AC_CLASS
Attribute DescriptionName AC_CLASSDatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 6
ACCNO1
20
Attribute DescriptionName ACCNO1Datatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 20
CCY_PAIR
Attribute DescriptionName CCY_PAIRDatatype StringDescriptionRestrictions
Restrictions Descriptionenumeration S,L,N,
CCY1
Attribute DescriptionName CCY1Datatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
CCY2
Attribute DescriptionName CCY2Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 3
DE_RATE_TYPE
Attribute DescriptionName DE_RATE_TYPEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8
21
Master-Full
Attribute DescriptionName Master-FullDatatypeDescription
PIDNUMBER
Attribute DescriptionName PIDNUMBERDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 15
BENEFIT_FOR
Attribute DescriptionName BENEFIT_FORDatatype StringDescriptionRestrictions
Restrictions Descriptionenumeration A,Z,E
CUSTMERNO
Attribute DescriptionName CUSTMERNODatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 9
CUSTNM
Attribute DescriptionName CUSTNMDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 255
CUSTSERVICEMODEL
22
Attribute DescriptionName CUSTSERVICEMODELDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 35
BRN_CODE
Attribute DescriptionName BRN_CODEDatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
ACC_CCY
Attribute DescriptionName ACC_CCYDatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
AC_CLASS
Attribute DescriptionName AC_CLASSDatatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 6
ACCOUNT_CLASS_DESC
Attribute DescriptionName ACCOUNT_CLASS_DESCDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 255
23
ACCLSTYP
Attribute DescriptionName ACCLSTYPDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 255
ACCNO1
Attribute DescriptionName ACCNO1Datatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 20
CCY_PAIR
Attribute DescriptionName CCY_PAIRDatatype StringDescriptionRestrictions
Restrictions Descriptionenumeration S,L,N,
CCY1
Attribute DescriptionName CCY1Datatype StringDescriptionRestrictions
Restrictions DescriptionmaxLength 3
CCY2
Attribute DescriptionName CCY2Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
24
Restrictions
Restrictions DescriptionmaxLength 3
DE_RATE_TYPE
Attribute DescriptionName DE_RATE_TYPEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8
INTRATEA
Attribute DescriptionName INTRATEADatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
RP_VARIANCE
Attribute DescriptionName RP_VARIANCEDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
RATE_INCL_VAR
Attribute DescriptionName RATE_INCL_VARDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
25
Restrictions
Restrictions DescriptiontotalDigits 22
Cust-Query-Dtl
Attribute DescriptionName Cust-Query-DtlDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
DFLT_IC_PROD
Attribute DescriptionName DFLT_IC_PRODDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 4
AMOUNT_UDE_ID
Attribute DescriptionName AMOUNT_UDE_IDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 35
AMNT
Attribute DescriptionName AMNTDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
26
Restrictions
Restrictions DescriptiontotalDigits 22
TENOR_TO
Attribute DescriptionName TENOR_TODatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
RATE_UDE_ID
Attribute DescriptionName RATE_UDE_IDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 35
RATE_UDE_VALUE
Attribute DescriptionName RATE_UDE_VALUEDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
BEN_PLAN_ID
Attribute DescriptionName BEN_PLAN_IDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
27
Restrictions
Restrictions DescriptionmaxLength 35
PRICE_COMP
Attribute DescriptionName PRICE_COMPDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 35
VAR_VALUE
Attribute DescriptionName VAR_VALUEDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
CA_RT_WITH_VARIANCE
Attribute DescriptionName CA_RT_WITH_VARIANCEDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
Zn-Chrgs
Attribute DescriptionName Zn-ChrgsDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
28
ZN_BEN_PLAN_ID
Attribute DescriptionName ZN_BEN_PLAN_IDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 35
ZN_BEN_DESC
Attribute DescriptionName ZN_BEN_DESCDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 105
ZN_PROD_TYPE
Attribute DescriptionName ZN_PROD_TYPEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 2
TOTAL_FREE_TXN
Attribute DescriptionName TOTAL_FREE_TXNDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
UTL_TXN29
Attribute DescriptionName UTL_TXNDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
REM_TXN
Attribute DescriptionName REM_TXNDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
Ex-Rate
Attribute DescriptionName Ex-RateDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
CY_CCY1
Attribute DescriptionName CY_CCY1Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 3
CY_CCY2
Attribute DescriptionName CY_CCY2
30
Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 3
MID_RATE
Attribute DescriptionName MID_RATEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8
CY_BEN_PLAN
Attribute DescriptionName CY_BEN_PLANDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 35
CY_RATE
Attribute DescriptionName CY_RATEDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
SPREAD_APPLIED
Attribute DescriptionName SPREAD_APPLIED
31
Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1
CY_BUY_RATE
Attribute DescriptionName CY_BUY_RATEDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
CY_BUY_SPREAD
Attribute DescriptionName CY_BUY_SPREADDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
CY_SELL_RATE
Attribute DescriptionName CY_SELL_RATEDatatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
CY_SELL_SPREAD
Attribute DescriptionName CY_SELL_SPREAD
32
Datatype DecimalDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptiontotalDigits 22
FCUBS_ERROR_RESP
Attribute DescriptionName FCUBS_ERROR_RESPDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
ERROR
Attribute DescriptionName ERRORDatatypeDescriptionAttribute
Attribute DescriptionmaxOccurs unbounded
ECODE
Attribute DescriptionName ECODEDatatype StringDescription
EDESC
Attribute DescriptionName EDESCDatatype StringDescription
FCUBS_WARNING_RESP
Attribute DescriptionName FCUBS_WARNING_RESPDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
WARNING33
Attribute DescriptionName WARNINGDatatypeDescriptionAttribute
Attribute DescriptionmaxOccurs unbounded
WCODE
Attribute DescriptionName WCODEDatatype StringDescription
WDESC
Attribute DescriptionName WDESCDatatype StringDescription
2.2.QueryCustPIDInfo
2.2.1.ST-QueryCustPIDInfo-Req-IO-MSG.xsd
QUERYCUSTPIDINFO_IOFS_REQ
FCUBS_HEADER
SOURCE
UBSCOMP
MSGID
CORRELID
USERID
BRANCH
MODULEID
SERVICE
OPERATION
SOURCE_OPERATION
SOURCE_USERID
DESTINATION
MULTITRIPID
FUNCTIONID
ACTION
MSGSTAT34
PASSWORD
ADDL
PARAM
NAME
VALUE
FCUBS_BODY
Main-IO
PID_NO
ENTITY_2
ENTITY_3
QUERYCUSTPIDINFO_IOFS_REQ
Attribute DescriptionName QUERYCUSTPIDINFO_IOFS_REQDatatypeDescription
FCUBS_HEADER
Attribute DescriptionName FCUBS_HEADERDatatypeDescription
SOURCE
Attribute DescriptionName SOURCEDatatype StringDescription This is the code for the system which has sourced this message.
For request messages, this field has to contain the source code for the partner system as maintained within FLEXCUBE UBS. In case of response messages this field will contain "FLEXCUBE".
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
UBSCOMP
Attribute DescriptionName UBSCOMPDatatype StringDescription This is the component of FLEXCUBE for which this message is
meant. Gateway supports both FLEXCUBE UBS and FLEXCUBE Investor Services. If the message is for FLEXCUBE UBS then this field should contain "FCUBS" and "FCIS" if meant for FLEXCUBE Investor Services. This field is case-sensitive.
35
Restrictions
Restrictions Descriptionenumeration FCUBS,FCIS
MSGID
Attribute DescriptionName MSGIDDatatype StringDescription This is the "unique" message ID for this message. In inbound
messages, if this field is present then Gateway would perform technical duplicate recognition using this field. For all messages going out from Gateway, Gateway will populate a unique message ID in this field.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
CORRELID
Attribute DescriptionName CORRELIDDatatype StringDescription This is the correlation ID for the message. Gateway supports 2
correlation patterns, namely "Message ID to Correlation ID" (M2C) and "Correlation ID to Correlation ID" (C2C). While using asynchronous means of communication (like a JMS queue), the partner system can correlate the response received from Gateway to the request message sent by it using this field. If the correlation pattern is M2C then this field will contain the MSGID of the request message. If the correlation pattern is C2C then this field will contain the CORRELID of the request message.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
USERID
Attribute DescriptionName USERIDDatatype StringDescription This is the user id which will be used within FLEXCUBE to record
the transaction. This needs to be a valid user id as maintained within FLEXCUBE.
Restrictions
Restrictions DescriptionmaxLength 12pattern [A-Z_0-9]*
36
BRANCH
Attribute DescriptionName BRANCHDatatype StringDescription This is the Branch of FLEXCUBE where the transaction would be
recorded. This needs to be a valid Branch code as maintained in FLEXCUBE.
Restrictions
Restrictions Descriptionlength 3pattern [a-zA-Z_0-9]{3}
MODULEID
Attribute DescriptionName MODULEIDDatatype StringDescription This field is applicable only if messages are being sent to FCIS
using Gateway. This is the module id of FCIS where the transaction will be recorded.
Attribute
Attribute DescriptionminOccurs 0
SERVICE
Attribute DescriptionName SERVICEDatatype StringDescription This field should contain the code of the Service of FLEXCUBE which
is being requested. This field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
OPERATION
Attribute DescriptionName OPERATIONDatatype StringDescription This is the operation of the service which is being invoked. This
field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_OPERATION
37
Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescription This is the code for the operation being invoked in the Source
system. The code of Source Operation being sent needs to be maintained as a valid Source Operation for the Source within FLEXCUBE.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_USERID
Attribute DescriptionName SOURCE_USERIDDatatype StringDescription This is the user id in the Source system who is performing the action.Attribute
Attribute DescriptionminOccurs 0
DESTINATION
Attribute DescriptionName DESTINATIONDatatype StringDescription This the system for which this message is destined. In case of
request messages to FLEXCUBE, it should be "FLEXCUBE". In case of response, the SOURCE from the request message is reproduced here.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MULTITRIPID
Attribute DescriptionName MULTITRIPIDDatatype StringDescription In response messages, this is the ID sent by FLEXCUBE in case
any overrides are encountered. In request messages, the source system is expected to reproduce the MULTITRIPID from the earlier received response if the source system accepts the overrides.
Attribute
Attribute DescriptionminOccurs 0
38
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
FUNCTIONID
Attribute DescriptionName FUNCTIONIDDatatype StringDescription This is the function in FLEXCUBE which is being invoked. For
integration scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
ACTION
Attribute DescriptionName ACTIONDatatype StringDescription This is the action on the function being invoked. For integration
scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MSGSTAT
Attribute DescriptionName MSGSTATDatatype StringDescription In response messages, FLEXCUBE will indicate the status of the
request in this field. The various values are "SUCCESS", "WARNING" and "FAILURE".
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionenumeration SUCCESS,WARNING,FAILURE
PASSWORD
Attribute Description
39
Name PASSWORDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 128pattern [a-zA-Z_0-9=+/]*
ADDL
Attribute DescriptionName ADDLDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0
PARAM
Attribute DescriptionName PARAMDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
NAME
Attribute DescriptionName NAMEDatatype StringDescription
VALUE
Attribute DescriptionName VALUEDatatype StringDescription
FCUBS_BODY
Attribute DescriptionName FCUBS_BODYDatatypeDescription
Main-IO
Attribute Description
40
Name Main-IODatatypeDescription
PID_NO
Attribute DescriptionName PID_NODatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 15
ENTITY_2
Attribute DescriptionName ENTITY_2Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 20
ENTITY_3
Attribute DescriptionName ENTITY_3Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 20
2.2.2.ST-QueryCustPIDInfo-Res-Full-MSG.xsd
QUERYCUSTPIDINFO_IOFS_RES
FCUBS_HEADER
SOURCE
UBSCOMP
MSGID
CORRELID41
USERID
BRANCH
MODULEID
SERVICE
OPERATION
SOURCE_OPERATION
SOURCE_USERID
DESTINATION
MULTITRIPID
FUNCTIONID
ACTION
MSGSTAT
PASSWORD
ADDL
PARAM
NAME
VALUE
FCUBS_BODY
Main-IO
PID_NO
ENTITY_2
ENTITY_3
Main-Full
CUST_AC_NO
ACCTYPE
BRANCH_CODE
AC_DESC
FLAG_STATUS
PID_NO
ENTITY_2
ENTITY_3
CUSTOMER_NO42
FULL_NAME
SHORT_NAME
Detail
PID_NO
ORDER_NO
MULTICUSTNAME
FCUBS_ERROR_RESP
ERROR
ECODE
EDESC
FCUBS_WARNING_RESP
WARNING
WCODE
WDESC
QUERYCUSTPIDINFO_IOFS_RES
Attribute DescriptionName QUERYCUSTPIDINFO_IOFS_RESDatatypeDescription
FCUBS_HEADER
Attribute DescriptionName FCUBS_HEADERDatatypeDescription
SOURCE
Attribute DescriptionName SOURCEDatatype StringDescription This is the code for the system which has sourced this message.
For request messages, this field has to contain the source code for the partner system as maintained within FLEXCUBE UBS. In case of response messages this field will contain "FLEXCUBE".
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
UBSCOMP
Attribute DescriptionName UBSCOMPDatatype String
43
Description This is the component of FLEXCUBE for which this message is meant. Gateway supports both FLEXCUBE UBS and FLEXCUBE Investor Services. If the message is for FLEXCUBE UBS then this field should contain "FCUBS" and "FCIS" if meant for FLEXCUBE Investor Services. This field is case-sensitive.
Restrictions
Restrictions Descriptionenumeration FCUBS,FCIS
MSGID
Attribute DescriptionName MSGIDDatatype StringDescription This is the "unique" message ID for this message. In inbound
messages, if this field is present then Gateway would perform technical duplicate recognition using this field. For all messages going out from Gateway, Gateway will populate a unique message ID in this field.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
CORRELID
Attribute DescriptionName CORRELIDDatatype StringDescription This is the correlation ID for the message. Gateway supports 2
correlation patterns, namely "Message ID to Correlation ID" (M2C) and "Correlation ID to Correlation ID" (C2C). While using asynchronous means of communication (like a JMS queue), the partner system can correlate the response received from Gateway to the request message sent by it using this field. If the correlation pattern is M2C then this field will contain the MSGID of the request message. If the correlation pattern is C2C then this field will contain the CORRELID of the request message.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
USERID
Attribute DescriptionName USERIDDatatype StringDescription This is the user id which will be used within FLEXCUBE to record
the transaction. This needs to be a valid user id as maintained within FLEXCUBE.
44
Restrictions
Restrictions DescriptionmaxLength 12pattern [A-Z_0-9]*
BRANCH
Attribute DescriptionName BRANCHDatatype StringDescription This is the Branch of FLEXCUBE where the transaction would be
recorded. This needs to be a valid Branch code as maintained in FLEXCUBE.
Restrictions
Restrictions Descriptionlength 3pattern [a-zA-Z_0-9]{3}
MODULEID
Attribute DescriptionName MODULEIDDatatype StringDescription This field is applicable only if messages are being sent to FCIS
using Gateway. This is the module id of FCIS where the transaction will be recorded.
Attribute
Attribute DescriptionminOccurs 0
SERVICE
Attribute DescriptionName SERVICEDatatype StringDescription This field should contain the code of the Service of FLEXCUBE which
is being requested. This field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
OPERATION
Attribute DescriptionName OPERATIONDatatype StringDescription This is the operation of the service which is being invoked. This
field is case-sensitive.Attribute
Attribute Descriptionnillable true
45
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_OPERATION
Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescription This is the code for the operation being invoked in the Source
system. The code of Source Operation being sent needs to be maintained as a valid Source Operation for the Source within FLEXCUBE.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_USERID
Attribute DescriptionName SOURCE_USERIDDatatype StringDescription This is the user id in the Source system who is performing the action.Attribute
Attribute DescriptionminOccurs 0
DESTINATION
Attribute DescriptionName DESTINATIONDatatype StringDescription This the system for which this message is destined. In case of
request messages to FLEXCUBE, it should be "FLEXCUBE". In case of response, the SOURCE from the request message is reproduced here.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MULTITRIPID
Attribute DescriptionName MULTITRIPIDDatatype StringDescription In response messages, this is the ID sent by FLEXCUBE in case
any overrides are encountered. In request messages, the source system is expected to reproduce the MULTITRIPID from the earlier received response if the source system accepts the overrides.
46
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
FUNCTIONID
Attribute DescriptionName FUNCTIONIDDatatype StringDescription This is the function in FLEXCUBE which is being invoked. For
integration scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
ACTION
Attribute DescriptionName ACTIONDatatype StringDescription This is the action on the function being invoked. For integration
scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MSGSTAT
Attribute DescriptionName MSGSTATDatatype StringDescription In response messages, FLEXCUBE will indicate the status of the
request in this field. The various values are "SUCCESS", "WARNING" and "FAILURE".
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionenumeration SUCCESS,WARNING,FAILURE
47
PASSWORD
Attribute DescriptionName PASSWORDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 128pattern [a-zA-Z_0-9=+/]*
ADDL
Attribute DescriptionName ADDLDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0
PARAM
Attribute DescriptionName PARAMDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
NAME
Attribute DescriptionName NAMEDatatype StringDescription
VALUE
Attribute DescriptionName VALUEDatatype StringDescription
FCUBS_BODY
Attribute DescriptionName FCUBS_BODYDatatypeDescription
Main-IO48
Attribute DescriptionName Main-IODatatypeDescription
PID_NO
Attribute DescriptionName PID_NODatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 15
ENTITY_2
Attribute DescriptionName ENTITY_2Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 20
ENTITY_3
Attribute DescriptionName ENTITY_3Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 20
Main-Full
Attribute DescriptionName Main-FullDatatypeDescription
CUST_AC_NO
Attribute Description49
Name CUST_AC_NODatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 20
ACCTYPE
Attribute DescriptionName ACCTYPEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1
BRANCH_CODE
Attribute DescriptionName BRANCH_CODEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 3
AC_DESC
Attribute DescriptionName AC_DESCDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 105
FLAG_STATUS
Attribute Description
50
Name FLAG_STATUSDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1
PID_NO
Attribute DescriptionName PID_NODatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 15
ENTITY_2
Attribute DescriptionName ENTITY_2Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 20
ENTITY_3
Attribute DescriptionName ENTITY_3Datatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 20
CUSTOMER_NO
Attribute Description
51
Name CUSTOMER_NODatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 9
FULL_NAME
Attribute DescriptionName FULL_NAMEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 105
SHORT_NAME
Attribute DescriptionName SHORT_NAMEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 20
Detail
Attribute DescriptionName DetailDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
PID_NO
Attribute DescriptionName PID_NODatatype StringDescription
52
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 15
ORDER_NO
Attribute DescriptionName ORDER_NODatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 4
MULTICUSTNAME
Attribute DescriptionName MULTICUSTNAMEDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 105
FCUBS_ERROR_RESP
Attribute DescriptionName FCUBS_ERROR_RESPDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
ERROR
Attribute DescriptionName ERRORDatatypeDescription
53
Attribute
Attribute DescriptionmaxOccurs unbounded
ECODE
Attribute DescriptionName ECODEDatatype StringDescription
EDESC
Attribute DescriptionName EDESCDatatype StringDescription
FCUBS_WARNING_RESP
Attribute DescriptionName FCUBS_WARNING_RESPDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
WARNING
Attribute DescriptionName WARNINGDatatypeDescriptionAttribute
Attribute DescriptionmaxOccurs unbounded
WCODE
Attribute DescriptionName WCODEDatatype StringDescription
WDESC
Attribute DescriptionName WDESCDatatype StringDescription
2.3.QueryValidateCustName
2.3.1.ST-QueryValidateCustName-Req-IO-MSG.xsd
QUERYVALIDATECUSTNAME_IOFS_REQ54
FCUBS_HEADER
SOURCE
UBSCOMP
MSGID
CORRELID
USERID
BRANCH
MODULEID
SERVICE
OPERATION
SOURCE_OPERATION
SOURCE_USERID
DESTINATION
MULTITRIPID
FUNCTIONID
ACTION
MSGSTAT
PASSWORD
ADDL
PARAM
NAME
VALUE
FCUBS_BODY
Master-IO
PID
BENFNM
QUERYVALIDATECUSTNAME_IOFS_REQ
Attribute DescriptionName QUERYVALIDATECUSTNAME_IOFS_REQDatatypeDescription
FCUBS_HEADER
Attribute Description
55
Name FCUBS_HEADERDatatypeDescription
SOURCE
Attribute DescriptionName SOURCEDatatype StringDescription This is the code for the system which has sourced this message.
For request messages, this field has to contain the source code for the partner system as maintained within FLEXCUBE UBS. In case of response messages this field will contain "FLEXCUBE".
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
UBSCOMP
Attribute DescriptionName UBSCOMPDatatype StringDescription This is the component of FLEXCUBE for which this message is
meant. Gateway supports both FLEXCUBE UBS and FLEXCUBE Investor Services. If the message is for FLEXCUBE UBS then this field should contain "FCUBS" and "FCIS" if meant for FLEXCUBE Investor Services. This field is case-sensitive.
Restrictions
Restrictions Descriptionenumeration FCUBS,FCIS
MSGID
Attribute DescriptionName MSGIDDatatype StringDescription This is the "unique" message ID for this message. In inbound
messages, if this field is present then Gateway would perform technical duplicate recognition using this field. For all messages going out from Gateway, Gateway will populate a unique message ID in this field.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
CORRELID
Attribute DescriptionName CORRELIDDatatype StringDescription This is the correlation ID for the message. Gateway supports 2
correlation patterns, namely "Message ID to Correlation ID" (M2C) and "Correlation ID to Correlation ID" (C2C). While using asynchronous means of communication (like a JMS queue), the partner system can correlate the response received from Gateway to the request message sent by it using this field. If the correlation pattern is M2C then this field will contain the MSGID of the request message. If the correlation pattern is C2C then this field will contain the CORRELID of the request message.
56
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
USERID
Attribute DescriptionName USERIDDatatype StringDescription This is the user id which will be used within FLEXCUBE to record
the transaction. This needs to be a valid user id as maintained within FLEXCUBE.
Restrictions
Restrictions DescriptionmaxLength 12pattern [A-Z_0-9]*
BRANCH
Attribute DescriptionName BRANCHDatatype StringDescription This is the Branch of FLEXCUBE where the transaction would be
recorded. This needs to be a valid Branch code as maintained in FLEXCUBE.
Restrictions
Restrictions Descriptionlength 3pattern [a-zA-Z_0-9]{3}
MODULEID
Attribute DescriptionName MODULEIDDatatype StringDescription This field is applicable only if messages are being sent to FCIS
using Gateway. This is the module id of FCIS where the transaction will be recorded.
Attribute
Attribute DescriptionminOccurs 0
SERVICE
Attribute DescriptionName SERVICEDatatype StringDescription This field should contain the code of the Service of FLEXCUBE which
is being requested. This field is case-sensitive.
57
Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
OPERATION
Attribute DescriptionName OPERATIONDatatype StringDescription This is the operation of the service which is being invoked. This
field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_OPERATION
Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescription This is the code for the operation being invoked in the Source
system. The code of Source Operation being sent needs to be maintained as a valid Source Operation for the Source within FLEXCUBE.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_USERID
Attribute DescriptionName SOURCE_USERIDDatatype StringDescription This is the user id in the Source system who is performing the action.Attribute
Attribute DescriptionminOccurs 0
DESTINATION
Attribute DescriptionName DESTINATIONDatatype StringDescription This the system for which this message is destined. In case of
request messages to FLEXCUBE, it should be "FLEXCUBE". In case of response, the SOURCE from the request message is reproduced here.
58
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MULTITRIPID
Attribute DescriptionName MULTITRIPIDDatatype StringDescription In response messages, this is the ID sent by FLEXCUBE in case
any overrides are encountered. In request messages, the source system is expected to reproduce the MULTITRIPID from the earlier received response if the source system accepts the overrides.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
FUNCTIONID
Attribute DescriptionName FUNCTIONIDDatatype StringDescription This is the function in FLEXCUBE which is being invoked. For
integration scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
ACTION
Attribute DescriptionName ACTIONDatatype StringDescription This is the action on the function being invoked. For integration
scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
59
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MSGSTAT
Attribute DescriptionName MSGSTATDatatype StringDescription In response messages, FLEXCUBE will indicate the status of the
request in this field. The various values are "SUCCESS", "WARNING" and "FAILURE".
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionenumeration SUCCESS,WARNING,FAILURE
PASSWORD
Attribute DescriptionName PASSWORDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 128pattern [a-zA-Z_0-9=+/]*
ADDL
Attribute DescriptionName ADDLDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0
PARAM
Attribute DescriptionName PARAMDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
60
NAME
Attribute DescriptionName NAMEDatatype StringDescription
VALUE
Attribute DescriptionName VALUEDatatype StringDescription
FCUBS_BODY
Attribute DescriptionName FCUBS_BODYDatatypeDescription
Master-IO
Attribute DescriptionName Master-IODatatypeDescription
PID
Attribute DescriptionName PIDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1000
BENFNM
Attribute DescriptionName BENFNMDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1000
2.3.2.ST-QueryValidateCustName-Res-Full-MSG.xsd
QUERYVALIDATECUSTNAME_IOFS_RES61
FCUBS_HEADER
SOURCE
UBSCOMP
MSGID
CORRELID
USERID
BRANCH
MODULEID
SERVICE
OPERATION
SOURCE_OPERATION
SOURCE_USERID
DESTINATION
MULTITRIPID
FUNCTIONID
ACTION
MSGSTAT
PASSWORD
ADDL
PARAM
NAME
VALUE
FCUBS_BODY
Master-IO
PID
BENFNM
Master-Full
PID
BENFNM
VALIDTBENEFCRY
FCUBS_ERROR_RESP
ERROR62
ECODE
EDESC
FCUBS_WARNING_RESP
WARNING
WCODE
WDESC
QUERYVALIDATECUSTNAME_IOFS_RES
Attribute DescriptionName QUERYVALIDATECUSTNAME_IOFS_RESDatatypeDescription
FCUBS_HEADER
Attribute DescriptionName FCUBS_HEADERDatatypeDescription
SOURCE
Attribute DescriptionName SOURCEDatatype StringDescription This is the code for the system which has sourced this message.
For request messages, this field has to contain the source code for the partner system as maintained within FLEXCUBE UBS. In case of response messages this field will contain "FLEXCUBE".
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
UBSCOMP
Attribute DescriptionName UBSCOMPDatatype StringDescription This is the component of FLEXCUBE for which this message is
meant. Gateway supports both FLEXCUBE UBS and FLEXCUBE Investor Services. If the message is for FLEXCUBE UBS then this field should contain "FCUBS" and "FCIS" if meant for FLEXCUBE Investor Services. This field is case-sensitive.
Restrictions
Restrictions Descriptionenumeration FCUBS,FCIS
MSGID
Attribute DescriptionName MSGIDDatatype String
63
Description This is the "unique" message ID for this message. In inbound messages, if this field is present then Gateway would perform technical duplicate recognition using this field. For all messages going out from Gateway, Gateway will populate a unique message ID in this field.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
CORRELID
Attribute DescriptionName CORRELIDDatatype StringDescription This is the correlation ID for the message. Gateway supports 2
correlation patterns, namely "Message ID to Correlation ID" (M2C) and "Correlation ID to Correlation ID" (C2C). While using asynchronous means of communication (like a JMS queue), the partner system can correlate the response received from Gateway to the request message sent by it using this field. If the correlation pattern is M2C then this field will contain the MSGID of the request message. If the correlation pattern is C2C then this field will contain the CORRELID of the request message.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
USERID
Attribute DescriptionName USERIDDatatype StringDescription This is the user id which will be used within FLEXCUBE to record
the transaction. This needs to be a valid user id as maintained within FLEXCUBE.
Restrictions
Restrictions DescriptionmaxLength 12pattern [A-Z_0-9]*
BRANCH
Attribute DescriptionName BRANCHDatatype StringDescription This is the Branch of FLEXCUBE where the transaction would be
recorded. This needs to be a valid Branch code as maintained in FLEXCUBE.
64
Restrictions
Restrictions Descriptionlength 3pattern [a-zA-Z_0-9]{3}
MODULEID
Attribute DescriptionName MODULEIDDatatype StringDescription This field is applicable only if messages are being sent to FCIS
using Gateway. This is the module id of FCIS where the transaction will be recorded.
Attribute
Attribute DescriptionminOccurs 0
SERVICE
Attribute DescriptionName SERVICEDatatype StringDescription This field should contain the code of the Service of FLEXCUBE which
is being requested. This field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
OPERATION
Attribute DescriptionName OPERATIONDatatype StringDescription This is the operation of the service which is being invoked. This
field is case-sensitive.Attribute
Attribute Descriptionnillable true
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_OPERATION
Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescription This is the code for the operation being invoked in the Source
system. The code of Source Operation being sent needs to be maintained as a valid Source Operation for the Source within FLEXCUBE.
65
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
SOURCE_USERID
Attribute DescriptionName SOURCE_USERIDDatatype StringDescription This is the user id in the Source system who is performing the action.Attribute
Attribute DescriptionminOccurs 0
DESTINATION
Attribute DescriptionName DESTINATIONDatatype StringDescription This the system for which this message is destined. In case of
request messages to FLEXCUBE, it should be "FLEXCUBE". In case of response, the SOURCE from the request message is reproduced here.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MULTITRIPID
Attribute DescriptionName MULTITRIPIDDatatype StringDescription In response messages, this is the ID sent by FLEXCUBE in case
any overrides are encountered. In request messages, the source system is expected to reproduce the MULTITRIPID from the earlier received response if the source system accepts the overrides.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
FUNCTIONID
Attribute DescriptionName FUNCTIONID
66
Datatype StringDescription This is the function in FLEXCUBE which is being invoked. For
integration scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
ACTION
Attribute DescriptionName ACTIONDatatype StringDescription This is the action on the function being invoked. For integration
scenarios this need not be sent. This is used by FLEXCUBE native user interface.
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionpattern [a-zA-Z_0-9]*
MSGSTAT
Attribute DescriptionName MSGSTATDatatype StringDescription In response messages, FLEXCUBE will indicate the status of the
request in this field. The various values are "SUCCESS", "WARNING" and "FAILURE".
Attribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions Descriptionenumeration SUCCESS,WARNING,FAILURE
PASSWORD
Attribute DescriptionName PASSWORDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
67
Restrictions
Restrictions DescriptionmaxLength 128pattern [a-zA-Z_0-9=+/]*
ADDL
Attribute DescriptionName ADDLDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0
PARAM
Attribute DescriptionName PARAMDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
NAME
Attribute DescriptionName NAMEDatatype StringDescription
VALUE
Attribute DescriptionName VALUEDatatype StringDescription
FCUBS_BODY
Attribute DescriptionName FCUBS_BODYDatatypeDescription
Master-IO
Attribute DescriptionName Master-IODatatypeDescription
PID
Attribute Description
68
Name PIDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1000
BENFNM
Attribute DescriptionName BENFNMDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1000
Master-Full
Attribute DescriptionName Master-FullDatatypeDescription
PID
Attribute DescriptionName PIDDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1000
BENFNM
Attribute DescriptionName BENFNMDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
69
Restrictions
Restrictions DescriptionmaxLength 1000
VALIDTBENEFCRY
Attribute DescriptionName VALIDTBENEFCRYDatatype StringDescriptionAttribute
Attribute DescriptionminOccurs 0
Restrictions
Restrictions DescriptionmaxLength 1000
FCUBS_ERROR_RESP
Attribute DescriptionName FCUBS_ERROR_RESPDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
ERROR
Attribute DescriptionName ERRORDatatypeDescriptionAttribute
Attribute DescriptionmaxOccurs unbounded
ECODE
Attribute DescriptionName ECODEDatatype StringDescription
EDESC
Attribute DescriptionName EDESCDatatype StringDescription
FCUBS_WARNING_RESP
Attribute Description
70
Name FCUBS_WARNING_RESPDatatypeDescriptionAttribute
Attribute DescriptionminOccurs 0maxOccurs unbounded
WARNING
Attribute DescriptionName WARNINGDatatypeDescriptionAttribute
Attribute DescriptionmaxOccurs unbounded
WCODE
Attribute DescriptionName WCODEDatatype StringDescription
WDESC
Attribute DescriptionName WDESCDatatype StringDescription
Gateway Documentation - FCUBSCustomerAdditionalService[Febraury] [2016]
Oracle Financial services Software Limited Oracle ParkOff western Express HighwayGoregaon(East)Mumbai,Maharashtra 400 063India
Worldwide Inquiries:Phone: +91 22 6718 3000Fax:+91 22 6718 3001www.oracle.com/financialservices/
Copyright © [2013], [2016], Oracle and/or its affiliates. All rights reserved.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of theirrespective owners
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programsinstalled on the hardware, and/or documentation, delivered to U.S. Government end users are commercial computersoftware pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. Assuch, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system,integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms andlicense restrictions applicable to the programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is notdeveloped or intended for use in any inherently dangerous applications, including applications that may create a risk ofpersonal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take allappropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliatesdisclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
This software and related documentation are provided under a license agreement containing restrictions on use anddisclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement orallowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit,perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation ofthis software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find anyerrors, please report them to us in writing.
This software or hardware and documentation may provide access to or information on content, products and servicesfrom third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of anykind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not beresponsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, orservices.
72