Gateway Documentation - CASA Service Oracle FLEXCUBE Universal Banking Release FCUBS_12.0.3.0.0 [April] [2014]
Gateway Documentation - CASA Service
Oracle FLEXCUBE Universal Banking
Release FCUBS_12.0.3.0.0
[April][2014]
1. BACKGROUND ................................................... 12. FCUBSCAService ................................................... 2 2.1.QueryLodgementBook ................................................... 2 2.1.1. CA-QueryLodgementBook-Req-IO-MSG.xsd ............................................................ 2
2.1.2. CA-QueryLodgementBook-Res-Full-MSG.xsd ............................................................ 9
Table Of Contents_______________________
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 the Gateway as
follows:
1. Inbound application integration – used when any external system needs to add, modify or query information
within FLEXCUBE UBS
2. Outbound application integration– 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 FCUBSCAService ofCore-
Module
1
2.FCUBSCAService
CASA ServiceCASA Service
2.1.QueryLodgementBook
Query of Lodgement Book
2.1.1.CA-QueryLodgementBook-Req-IO-MSG.xsd
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
Catm-Lodgment-Book-IO
ACCOUNTNO
STARTNO
FCUBS_HEADER
TOP
SOURCE
Attribute DescriptionName FCUBS_HEADERDatatypeDescription
Attribute DescriptionName SOURCEDatatype String
2
TOP
UBSCOMP
TOP
MSGID
TOP
CORRELID
TOP
USERID
TOP
BRANCH
DescriptionRestrictions Restrictions Description
pattern [a-zA-Z_0-9]*
Attribute DescriptionName UBSCOMPDatatype StringDescriptionRestrictions Restrictions Description
enumeration FCUBS,FCIS
Attribute DescriptionName MSGIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName CORRELIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName USERIDDatatype StringDescriptionRestrictions Restrictions Description
maxLength 12pattern [A-Z_0-9]*
3
TOP
MODULEID
TOP
SERVICE
TOP
OPERATION
TOP
SOURCE_OPERATION
Attribute DescriptionName BRANCHDatatype StringDescriptionRestrictions Restrictions Description
length 3pattern [a-zA-Z_0-9]{3}
Attribute DescriptionName MODULEIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Attribute DescriptionName SERVICEDatatype StringDescriptionAttributes Attribute Description
nillable true
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName OPERATIONDatatype StringDescriptionAttributes Attribute Description
nillable true
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescription
4
TOP
SOURCE_USERID
TOP
DESTINATION
TOP
MULTITRIPID
TOP
FUNCTIONID
Attributes Attribute DescriptionminOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName SOURCE_USERIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Attribute DescriptionName DESTINATIONDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName MULTITRIPIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName FUNCTIONIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
5
TOP
ACTION
TOP
MSGSTAT
TOP
PASSWORD
TOP
ADDL
TOP
PARAM
Attribute DescriptionName ACTIONDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName MSGSTATDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionenumeration SUCCESS,WARNING,FAILURE
Attribute DescriptionName PASSWORDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 128pattern [a-zA-Z_0-9=+/]*
Attribute DescriptionName ADDLDatatypeDescriptionAttributes Attribute Description
minOccurs 0
Attribute Description
6
TOP
NAME
TOP
VALUE
TOP
FCUBS_BODY
TOP
Catm-Lodgment-Book-IO
TOP
ACCOUNTNO
TOP
Name PARAMDatatypeDescriptionAttributes Attribute Description
maxOccurs unboundedminOccurs 0
Attribute DescriptionName NAMEDatatype StringDescription
Attribute DescriptionName VALUEDatatype StringDescription
Attribute DescriptionName FCUBS_BODYDatatypeDescription This XSD Gives Information about IORequest
Attribute DescriptionName Catm-Lodgment-Book-IODatatypeDescription This gives the Lodgement Book IO request
Attribute DescriptionName ACCOUNTNODatatype StringDescription Indicates Account NumberAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 16
7
STARTNO
TOP
Attribute DescriptionName STARTNODatatype StringDescription Indicates Start NumberAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 16
8
2.1.2.CA-QueryLodgementBook-Res-Full-MSG.xsd
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
CHOICE
Catm-Lodgment-Book-IO
ACCOUNTNO
STARTNO
Catm-Lodgment-Book-Full
ACCOUNTNO
STARTNO
NOOFLEAVES
ORDERDATE
ISSUEDATE
ORDERDETAILS
INCLFORLODBOOKPRINTING
MAKERID
MAKERDTSTAMP
CHECKERID
CHECKERDTSTAMP
MODNO
AUTHSTAT
RECSTAT
9
ONCEAUTH
UDFDETAILS
FUNCTIONID
FIELD_NAME
DATATYPE
FIELD_VALUE
VAL_TYPE
FCUBS_ERROR_RESP
ERROR
ECODE
EDESC
FCUBS_WARNING_RESP
WARNING
WCODE
WDESC
FCUBS_HEADER
TOP
SOURCE
TOP
UBSCOMP
TOP
MSGID
Attribute DescriptionName FCUBS_HEADERDatatypeDescription
Attribute DescriptionName SOURCEDatatype StringDescriptionRestrictions Restrictions Description
pattern [a-zA-Z_0-9]*
Attribute DescriptionName UBSCOMPDatatype StringDescriptionRestrictions Restrictions Description
enumeration FCUBS,FCIS
Attribute DescriptionName MSGIDDatatype StringDescription
10
TOP
CORRELID
TOP
USERID
TOP
BRANCH
TOP
MODULEID
TOP
SERVICE
Attributes Attribute DescriptionminOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName CORRELIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName USERIDDatatype StringDescriptionRestrictions Restrictions Description
maxLength 12pattern [A-Z_0-9]*
Attribute DescriptionName BRANCHDatatype StringDescriptionRestrictions Restrictions Description
length 3pattern [a-zA-Z_0-9]{3}
Attribute DescriptionName MODULEIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
11
TOP
OPERATION
TOP
SOURCE_OPERATION
TOP
SOURCE_USERID
TOP
DESTINATION
Attribute DescriptionName SERVICEDatatype StringDescriptionAttributes Attribute Description
nillable true
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName OPERATIONDatatype StringDescriptionAttributes Attribute Description
nillable true
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName SOURCE_USERIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Attribute DescriptionName DESTINATIONDatatype StringDescription
12
TOP
MULTITRIPID
TOP
FUNCTIONID
TOP
ACTION
TOP
MSGSTAT
Attributes Attribute DescriptionminOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName MULTITRIPIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName FUNCTIONIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
Attribute DescriptionName ACTIONDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*
Attribute DescriptionName MSGSTATDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
13
TOP
PASSWORD
TOP
ADDL
TOP
PARAM
TOP
NAME
TOP
VALUE
Restrictions Restrictions Descriptionenumeration SUCCESS,WARNING,FAILURE
Attribute DescriptionName PASSWORDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 128pattern [a-zA-Z_0-9=+/]*
Attribute DescriptionName ADDLDatatypeDescriptionAttributes Attribute Description
minOccurs 0
Attribute DescriptionName PARAMDatatypeDescriptionAttributes Attribute Description
maxOccurs unboundedminOccurs 0
Attribute DescriptionName NAMEDatatype StringDescription
Attribute DescriptionName VALUEDatatype StringDescription
14
TOP
FCUBS_BODY
TOP
CHOICE
TOP
Catm-Lodgment-Book-IO
TOP
ACCOUNTNO
TOP
STARTNO
TOP
Catm-Lodgment-Book-Full
Attribute DescriptionName FCUBS_BODYDatatypeDescription This XSD Gives Information about FullResponse
Attribute DescriptionName CHOICEDatatypeDescription
Attribute DescriptionName Catm-Lodgment-Book-IODatatypeDescription This gives the Lodgement Book PK response type
Attribute DescriptionName ACCOUNTNODatatype StringDescription Indicates Account NumberAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 16
Attribute DescriptionName STARTNODatatype StringDescription Indicates Start NumberAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 16
Attribute Description
15
TOP
ACCOUNTNO
TOP
STARTNO
TOP
NOOFLEAVES
TOP
ORDERDATE
TOP
ISSUEDATE
Name Catm-Lodgment-Book-FullDatatypeDescription This gives the Lodgement Book Fullresponse type
Attribute DescriptionName ACCOUNTNODatatype StringDescription Indicates Account NumberAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 16
Attribute DescriptionName STARTNODatatype StringDescription Indicates Start NumberAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 16
Attribute DescriptionName NOOFLEAVESDatatype NumberDescription Indicates Number Of LeavesAttributes Attribute Description
minOccurs 0
Attribute DescriptionName ORDERDATEDatatype DateDescription Indicates Order DateAttributes Attribute Description
minOccurs 0
Attribute Description
16
TOP
ORDERDETAILS
TOP
INCLFORLODBOOKPRINTING
TOP
MAKERID
TOP
MAKERDTSTAMP
Name ISSUEDATEDatatype DateDescription Indicates Issue dateAttributes Attribute Description
minOccurs 0
Attribute DescriptionName ORDERDETAILSDatatype StringDescription Indicates Order DetailsAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 105
Attribute DescriptionName INCLFORLODBOOKPRINTINGDatatype StringDescription Indicates Included For Book PrintingAttributes Attribute Description
minOccurs 0
Restrictions Restrictions Descriptionenumeration N,Y
Attribute DescriptionName MAKERIDDatatype StringDescription Specifies the User Id who has created\last modified the record.Attributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 12
Attribute DescriptionName MAKERDTSTAMPDatatype StringDescription Indicates Date and Time when the User has created\last modified the
record.Attributes Attribute Description
minOccurs 0
17
TOP
CHECKERID
TOP
CHECKERDTSTAMP
TOP
MODNO
TOP
AUTHSTAT
Restrictions Restrictions DescriptionmaxLength 25
Attribute DescriptionName CHECKERIDDatatype StringDescription Indicates the User Id who has Authorized the creation\modification of the
record.Attributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 12
Attribute DescriptionName CHECKERDTSTAMPDatatype StringDescription Indicates the Date and Time, when the User has Authorized the
creation\modification of the record.Attributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 25
Attribute DescriptionName MODNODatatype NumberDescription Indicates Modification number i.e. the number of times the record has been
modified.Attributes Attribute Description
minOccurs 0
Attribute DescriptionName AUTHSTATDatatype StringDescription Specifies whether the record is authorized or notAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 1
18
TOP
RECSTAT
TOP
ONCEAUTH
TOP
UDFDETAILS
TOP
FUNCTIONID
Attribute DescriptionName RECSTATDatatype StringDescription Indicates the Record Status
O - OpenC - Close
Attributes Attribute DescriptionminOccurs 0
Restrictions Restrictions DescriptionmaxLength 1
Attribute DescriptionName ONCEAUTHDatatype StringDescription Indicates whether Contract Authorize details is atleast Authorized OnceAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 1
Attribute DescriptionName UDFDETAILSDatatypeDescription UDF DetailsAttributes Attribute Description
maxOccurs unboundedminOccurs 0
Attribute DescriptionName FUNCTIONIDDatatype StringDescriptionAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 8pattern [A-Z_0-9]*
19
TOP
FIELD_NAME
TOP
DATATYPE
TOP
FIELD_VALUE
TOP
VAL_TYPE
TOP
Attribute DescriptionName FIELD_NAMEDatatype StringDescription Indicates the User Defined Field Name.Restrictions Restrictions Description
maxLength 105minLength 1
Attribute DescriptionName DATATYPEDatatype StringDescription Indicates Data TypeAttributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 15
Attribute DescriptionName FIELD_VALUEDatatype StringDescription Indicates the User Defined Field Value.Attributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 255minLength 0
Attribute DescriptionName VAL_TYPEDatatype StringDescription Indicates Value type.Attributes Attribute Description
minOccurs 0
Restrictions Restrictions DescriptionmaxLength 2minLength 0
20
FCUBS_ERROR_RESP
TOP
ERROR
TOP
ECODE
TOP
EDESC
TOP
FCUBS_WARNING_RESP
TOP
WARNING
Attribute DescriptionName FCUBS_ERROR_RESPDatatypeDescriptionAttributes Attribute Description
maxOccurs unboundedminOccurs 0
Attribute DescriptionName ERRORDatatypeDescriptionAttributes Attribute Description
maxOccurs unbounded
Attribute DescriptionName ECODEDatatype StringDescription
Attribute DescriptionName EDESCDatatype StringDescription
Attribute DescriptionName FCUBS_WARNING_RESPDatatypeDescriptionAttributes Attribute Description
maxOccurs unboundedminOccurs 0
Attribute DescriptionName WARNINGDatatype
21
TOP
WCODE
TOP
WDESC
TOP
DescriptionAttributes Attribute Description
maxOccurs unbounded
Attribute DescriptionName WCODEDatatype StringDescription
Attribute DescriptionName WDESCDatatype StringDescription
22
Account Service
[April][2014]
Oracle Financial Services software Limited
Oracle Park
Off Western Express Highway
Goregaon (East)
Mumbai, Maharashtra 400 063
India
Worldwide Inquiries:
Phone: +91 22 6718 3000
Fax:+91 22 6718 3001
www.oracle.com/financialservices/
Copyright © [2007], [2013], 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 their
respective owners.
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs
installed on the hardware, and/or documentation, delivered to U.S. Government end users are commercial computer
software pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As
such, 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 and
license 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 not
developed or intended for use in any inherently dangerous applications, including applications that may create a risk of
personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all
appropriate failsafe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates
disclaim 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 and
disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or
allowed 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
of
this 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 any
errors, please report them to us in writing.
This software or hardware and documentation may provide access to or information on content, products and services
from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any
23
kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or
services.
24