This Document Needs to Be Completed by BSG & IT/Vendor for Each Application /API

APIMASTER DATA API Specification Document Table of Contents

1.SCOPE AND BUSINESS CASE OVERVIEW ...... 4

1.1 PROJECT OVERVIEW...... 4 1.2 CURRENT PROCESS & OPPORTUNITY ...... 4 1.3 HIGH-LEVEL BUSINESS REQUIREMENTS ...... 4 1.3.1 Functional Requirement ...... 4 1.3.2 Non- Functional Requirement...... 4 1.4 BUSINESS BENEFIT CASE ...... 4 1.4.1 Financial Benefit ...... 4 1.4.2 Non-Financial Benefit...... 4 2.ACCEPTANCE CRITERIA & PROJECT PLAN ...... 5 This document needs to be completed by BSG & IT/Vendor for each Application /API.

Introduction This API is used for synchronizing Finacle master with Vendor database.

List of API List down the ………. Sr. No Name Description 1 APIMASTER DATA API for synchronizing Finacle master with Vendor database

API Name APIMASTER_DATA

Description API for synchronizing Finacle master with Vendor database

Transport protocol (SOAP / REST)

API Request URLs https://gateway.rblbank.com/prod/sb/rbl/v1/data/fetch-master https://gateway.rblbank.com/prod/sb/rbl/v1/data/master

Access Requirement

Request Parameters for requesting for LST files: Business Parameter Parameter Parameter Description Parameter Constraints Comments Name Type Name

Transaction ID MinLength = 2 generated Transaction Pattern allowed[a-zA-Z0- by consumer TranID ID TranID String 9_]+ of service

Field to specify Date DATE_FLAG Date Flag DATE_FLAG String Values allowed: [Y, N] Flag Field to specify date Pattern allowed: [dd-MM- of file to be DATE Date DATE dateTime yyyy] generated.

Request Sample for requesting for LST files: With Date: { "API_MASTER_DATA_Req": { "Header":{ "TranID":"123" } , "Body":{ "DATE_FLAG": "Y", "DATE": "01-01-2016" } } }

Without Date: { "API_MASTER_DATA_Req": { "Header":{ "TranID":"${ =System.currentTimeMillis() + ((int)(Math.random()*1000))}" }, "Body":{ "DATE_FLAG": "N" } } } Response Parameters Business Descriptio Parameter Paramete Parameter Parameter Comments n Name r Type Constraints Name

MinLength = 1 Pattern Transaction allowed:[a-zA- Field shows the Transaction TranID ID TranID String Z0-9_]+ ID of the request.

Status SUCCESS/FAILU Field shows the status of the Status Status String RE request. Field shows the Error Code of Error Code the request if any error Error_Cde Error_Cde String occurred Field shows the Error Error Description of the request if Error_Desc Description Error_Desc String any error occurred Field shows the Remarks for User only in case of Success Remarks Remarks Remarks String scenario.

Response Sample Success Scenario: { "API_MASTER_DATA_Resp": { "Header": { "TranID": "123", "Status": "SUCCESS", "Error_Cde": "", "Error_Desc": "" }, "Body": {"Remarks": "Request Submitted for LST generation" } } } Response Sample Error Scenario:

{ "API_MASTER_DATA_Resp": { "Header": { "TranID": "1480486612489", "Status": "FAILURE", "Error_Cde": "W0205", "Error_Desc": "Script [masterdata] does not exist" }}}

Request Parameters for fetching Master Details: Business Parameter Parameter Parameter Description Parameter Constraints Comments Name Type Name This filed should contain name of the file which Master Type needs to be MASTER_TYPE File Name MASTER_TYPE String fetched. This field should contain date of the file which needs to be DATE DATE DATE Date Format – [yyyy-MM-dd] fetched.

Request Sample:

MASTER_TYPE=RETAIL_DOCUMENT&DATE=2016-11-18

Response Parameters Business Parameter Parameter Parameter Parameter Description Comments Name Type Constraints Name Field shows the status of the Status Status Status String Success/Failed request. MASTER_TY Master Type MASTER_TYP This field shows master type of PE E String the file which was fetched Date This field shows date of the file DATE DATE String yyyyMMdd which was fetched MASTER_DA Master Data MASTER_DAT This field shows master data of TA A String the file which was fetched This field shows file name of FILENAME File Name FILENAME String the file which was fetched

Response Sample Success Scenario:

{"Fetch_Master_Details_Resp": { "Header": {"Status": "SUCCESS"}, "Body": {"MasterDetails": [ { "MASTER_TYPE": "RETAIL_DOCUMENT", "DATE": "20161129", "MASTER_DATA": "Retail|INDIVIDUAL KYC DOCUMENTS|ADDRESS CARD ISSUED BY DEPT OF POST|ADCRD|INDIVIDUAL KYC DOCUMENTS|N", "FILENAME": "RETAIL_DOCUMENT" }, { “MASTER_TYPE": "RETAIL_DOCUMENT", “DATE": "20161129", “MASTER_DATA": "Retail|INDIVIDUAL KYC DOCUMENTS|WATER TAX BILL|WTBIL|INDIVIDUAL KYC DOCUMENTS|N", "FILENAME": "RETAIL_DOCUMENT"

} ]} }}

Response Sample Error Scenario: { "Fetch_Master_Details_Resp": { "Header":{ "Status":"FAILURE" }, "Body":{ "Remarks":"No Records Found" } } }

Response Codes Response Stage Response Code Response Message SUCCESS SUCCESS FAILURE FAILURE

Error Codes Error Code Error Type Short Long Message Correcting Error Type Message This Error ER001 Validation Improper Improper JSON Format Failure JSON Format ER002 Validation Schema Schema Validation Failure Failure Validation Failure ER003 Technical Error Error Occurred While Failure Occurred Calling the Provider Service While Calling the Provider Service ER004 Technical Timeout Error Timeout Error Occurred Failure Occurred While Calling the Provider While Calling Service the Provider Service ER006 Technical Timeout Timeout Exception Failure Exception Occurred Occurred ER007 Technical Technical Technical Failure Failure Failure

Appendix List of mandatory tags in request and response:

List_Optional_Manda tory_Tags.xlsx