Rest API Services User Guide

Oracle FLEXCUBE Universal Banking

Release 14.5.0.0.0
Part No. F42208-01
[May] [2021]
Rest API Services User Guide
[May] [2021]
Version 14.5.0.0.0

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
https://www.oracle.com/industries/financial-services/index.html

Copyright © 2007, 2021, 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
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.
 Table of Contents
1. PREFACE ........................................................................................................................................................ 1-1
1.1 INTRODUCTION ........................................................................................................................................... 1-1
1.2 AUDIENCE .................................................................................................................................................. 1-1
1.3 DOCUMENTATION ACCESSIBILITY .............................................................................................................. 1-1
1.4 ORGANIZATION .......................................................................................................................................... 1-1
2. REST API SERVICES - OVERVIEW .......................................................................................................... 2-1
2.1 INTRODUCTION ........................................................................................................................................... 2-1
2.1.1 Rest HTTP Headers ........................................................................................................................... 2-2
2.2 REST SERVICES CHANGES .......................................................................................................................... 2-2
 1. Preface
1.1 Introduction
This User Guide is intended to familiarize you with the light-weight REST based services of
Oracle FLEXCUBE. The manual gives you an overview of the services developed, input\request
parameters and the response of the each REST service.

1.2 Audience
The manual is intended for integrating external systems to Oracle FLEXCUBE using RESTFUL
framework.

1.3 Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility
Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

1.4 Organization
The manual is organized into the following chapters

Chapter Description

Chapter 1 Preface - Gives information on the intended audience. It also lists the
various chapters covered in this User Manual.

Chapter 2 Rest API - An Overview provides a snapshot of the features of the

entire module.

1-1
 2. Rest API Services - Overview
2.1 Introduction
Oracle FLEXCUBE Universal Banking has adopted the industry standard of providing light-weight
services through Representational State Transfer (popularly known as ReST) services. These
lightweight services support the current trend of mobile/tablet based applications. These services
help to improve the response time for tablet/mobile applications, as these applications are very
chatty, involves numerous hits to the server and the expected response time is minimal for each
of the requests.

The REST/Fine grain services using GET methods are listed below:
1. Customer, Customer Accounts
2. Loan accounts for a customer
3. Loan account balance
4. Loan instalment/EMI details
5. Loan account Principal balance
6. Loan guarantor details
7. Loan security details
8. Corporate deposit details
9. Foreign Exchange Details
10. Money Market Details
11. Securities Portfolio Details
12. Derivatives
13. OTC Options
14. Exchange Traded Derivatives Portfolio Details
15. Credit Card
16. Insurance
17. Mutual Funds
18. LC Details
19. Guarantee Details
20. Standing Instructions
21. Currency Exchange Rates

More information on the above listed services can be found in the respective sections of the User
manual.

Each of the services listed above will be a URL. These URLs can be tested using any of the
available browser plug-ins like Postman, RestEasy etc.. Also these services can be integrated
with an API manager depending on its use. Below is the format of a Get account balance service
example which will take the customer account number and branch code as the input

http://(IP):(Port)/AccountBalanceService/AccountBalance/QueryAcctBal/brhcode/{brhcode}/custA
cNo/{custAcNo}

2-1
 The input for the GET services is passed as a part of the URL and if more than one input needs
to be passed they should be separated by a forward slash (/). Apart from passing the customer
number as a part of the URL, the services also expect a few header parameters to be passed to
the service. The following are the header parameters passed:
1. userId : Flexcube UBS login user Id
2. branch : The bank branch to which the user belongs
3. msgId : A alphanumeric input from the consumer
4. source : Source of the request whether it is FCUBS or an external system
5. Content-Type: This mentions the format of the input /output. Since we are using the
JSON format we will give the content-type as application/json.
6. Entity : Entity ID

UserId, password and msgId are for authenticating the user accessing the service. More
information on authentication can be found under Section 2.

The list of services will be discussed in detail in the following chapters.

2.1.1 Rest HTTP Headers

The following are the headers that are expected in all the requests that are sent to the Rest API
application.
1. userId - Oracle FLEXCUBE UBS login user name.
2. password – Encrypted Oracle FLEXCUBE UBS login password.
3. msgId –This message id will be a unique id to identify the request.
4. branch – The branch code from where the request is sent.
5. source – The source code of the external system.

2.2 Rest Services Changes

Support for Rest Services are enhanced to all modules of FLEXCUBE through ODT. In ODT the
user can opt for selected Rest services, ODT shall generate rest artefacts for Function IDs opted
which can be deployed into application.

Fine grained services are introduced as part of the new release which caters to niche requests

2-2
List of services enabled

Rest_Services.xlsx

The document attached will have the services introduced newly along the existing services.

Rest Documentations

Rest
Documentation.zip

Please refer the attachment panel for Rest_Services.xlsx and Rest Documentaion.zip.

2-3