API Specification Document

IFSC Validator

API Specification Document

Table of Contents

1.Scope and Business Case Overview...... 4

1.1Project Overview...... 4

1.2Current process & opportunity...... 4

1.3High-level business requirements...... 4

1.3.1Functional Requirement...... 4

1.3.2Non- Functional Requirement...... 4

1.4Business Benefit Case...... 4

1.4.1Financial Benefit...... 4

1.4.2Non-Financial Benefit...... 4

2.Acceptance Criteria & Project Plan...... 5

This document needs to be completed by BSG & IT/Vendor for each Application /API.

Introduction

Currency rates API makes it easy to get the currency rate of various currencies and also the exchange

List of API

List down the ……….

Sr. No / Name / Description
1 / IFSC Validator / This API gets IFSC code of various branches.

API Name:

IFSCVal

Description:

The API would create a virtual account for every current account present in the corporate.

Transport protocol (SOAP / REST)

REST

API Request URLs

Access Requirement

Request Parameters

Request Sample

{
"IFSCCodeValReq": {
"ReqID": "1",
"IFSCCode": "DCBL0000002",
"ChlID": "HSB",
"Type": "NEFTRIB"
}

Response Parameters

Business Parameter Name / Description / Parameter Name / Parameter Type / Parameter Constraints / Comments
ReqID / Request Id / ReqID / String / - / Request ID for each request made
ChlID / Channel Id / ChlID / String / - / Channel ID for each request made
Operation / Operation / Operation / String / - / The operation/functionality to be performed
IFSCCode / IFSC Code / IFSCCode / String / - / The Unique Bank IFSC Code
Type / Transaction Type / Type / String / - / The Type of Transaction
BANK_IFSC_CODE / Bank IFSC Code / BANK_IFSC_CODE / String / - / Bank IFSC Code
BANK_CODE / Bank Code / BANK_CODE / String / - / Unique Bank Code
BANK_NAME / Bank Name / BANK_NAME / String / - / Bank Name
BRANCH_NAME / Bank Branch Name / BRANCH_NAME / String / - / Bank Branch Name
BANK_DISTRICT_NAME / Bank District Name / BANK_DISTRICT_NAME / String / - / Bank District Name
BANK_STATE_NAME / State Name / BANK_STATE_NAME / String / - / State Name of the Bank
TRANSACTION_TYPE / Transaction Type / TRANSACTION_TYPE / String / - / Transaction Mode Specified
IFSC_STATUS / IFSC Status / IFSC_STATUS / String / - / Status of IFSC
ADDRESS / Address / ADDREESS / String / - / Address of the Bank
CITY_NAME / City Name / City Name / String / - / Name of the city of the bank branch.

Response Sample

{"IFSCCodeValResp": {"Response": {
"Details": {
"ReqID": "1",
"IFSCCode": "DCBL0000002",
"Operation": "IFSCCDVAL",
"ChlID": "HSB",
"Type": "NEFTRIB"
},
"Data": {"Item": {
"BANK_IFSC_CODE": "DCBL0000002",
"BANK_CODE": null,
"BANK_NAME": "DEVELOPMENT CREDIT BANK",
"BRANCH_NAME": "KALBADEVI",
"BANK_DISTRICT_NAME": null,
"BANK_STATE_NAME": null,
"TRANSACTION_TYPE": "NFT",
"IFSC_STATUS": "A",
"ADDRESS": null,
"CITY_NAME": "MUMBAI"
}}

Response Codes

Response Stage / Response Code / Response Message
SUCCESS / SUCCESS
FAILURE / FAILURE

Error Codes

Error Code / Error Type / Short Message / Long Message / Correcting This Error
Validation / Please enter ifsc code / Please enter ifsc code / Enter the IFSC Code
Validation / Please enter valid values / Please enter valid values / Enter valid Transaction Type
Validation / Invalid IFSC Code / Invalid IFSC Code / Enter Valid IFSC Code
Validation / Please enter a valid currency code / Please enter a valid currency code / Enter a Valid Currency Code
Json Parsing / A JSON parsing error has occurred whilst parsing the JSON document / A JSON parsing error has occurred whilst parsing the JSON document / Enter Proper JSON Format

Appendix

List of mandatory tags in request and response

MANDATORY REQUEST FIELDS
FIELDS / TAGS MANDATORY / VALUES MANDATORY
ReqID / N / N
ChlID / N / N
Operation / N / N
Type / Y / Y
IFSCCode / Y / Y
MANDATORY RESPONSE FIELDS
FIELDS / TAGS MANDATORY / VALUES MANDATORY
ReqID / N / N
ChlID / N / N
Operation / N / N
IFSCCode / Y / Y
Type / Y / Y
BANK_IFSC_CODE / Y / Y
BANK_CODE / Y / Y
BANK_NAME / Y / Y
BRANCH_NAME / Y / Y
BANK_DISTRICT_NAME / Y / Y
BANK_STATE_NAME / Y / Y
TRANSACTION_TYPE / Y / Y
IFSC_STATUS / Y / Y