API Document

API Description Document

Requestor

Requestor:
Arpitam Das / Date:
27 – Feb – 2017
Designation
Manager / Department
RBL-BSG

Approvals

Executive Sponsor:
Sujatha Mohan / Date:
27 – Feb – 2017
Business Program Manager:
Abhijeet Davane / Date:
27 – Feb – 2017
Project Manager BSG:
Sudarshan Galipelli / Date:
27 – Feb – 2017
Please add additional rows if you have additional stakeholders that need to approve this document.
Comments:

Revision History

Document/Dept. Owner: / BSG
Created By: / Arpitam Das / Date: / 27 – Feb – 2017
Revised By / Date Revised / New Version #
Arpitam Das / 15-May-17 / 1.1
Arpitam Das / 3-July-17 / 1.2

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

Introduction

Project – RBL API Banking

Single Payment API with BeneID for facilitating corporate payments with registered beneficiaries.

List of API

List down the APIs part of the projects:

Sr. No / Name / Description
1 / Single Payment Corp with BeneID / This service does all the single payment transactions with registered beneficiaries.

API Name

doSinglePayment_BenID

Description

This service does all the single payment transactions with the registered beneficiaries.

Process flow, UML Diagram

Please add detailed process flow, UML diagram where were necessary.

Transport protocol (SOAP / REST)

REST

API Request URLs

Request Parameters

Business Parameter Name / Description / Parameter Name / Parameter Type / Parameter Constraints / Comments
TranID / Transaction Id / TranID / String / MinLength=1
MaxLength=16
Alphanumeric & ‘_’ / Transaction ID generated by consumer which is unique
Corp_ID / Corporate Id / Corp_ID / String / MinLength=1
MaxLength=20
Alphanumeric & ‘_’ / Unique ID assigned to each enrolled Corporate
Maker_ID / Maker Id / Maker_ID / String / MaxLength=20
Alphanumeric & ‘_’ / Unique ID for request creator
Checker_ID / Checker Id / Checker_ID / String / MaxLength=20
Alphanumeric & ‘_’ / Unique ID for request checker
Approver_ID / Approver Id / Approver_ID / String / MaxLength=20
Alphanumeric & ‘_’ / Unique ID for request approver
Amount / Amount / Amount / String / MaxLength=20
Values allowed:[0-9]+ / Amount for which payment has to be done
Debit_Acct_No / Account Number / Debit_Acct_No / String / MinLength=1
MaxLength=16
Alphanumeric & ‘_’ / Debit Account Number
Debit_Acct_Name / Account Holder Name / Debit_Acct_Name / String / MaxLength=50 / Debit Account Holder Name
Debit_IFSC / IFSC Code / Debit_IFSC / String / MaxLength=15
Alphanumeric & ‘_’ / IFSC Code of debit account bank
Debit_Mobile / Mobile Number / Debit_Mobile / Numeric / MinLength=10
MaxLength=10
Values allowed:[0-9]+ / Debit Account Holder's Mobile Number
Debit_TrnParticulars / Debit_TrnParticulars / Debit_TrnParticulars / String / MaxLength=50
Debit_PartTrnRmks / Debit_TrnParticulars / Debit_PartTrnRmks / String / MaxLength=50 / details of the part transaction
Mode_of_Pay / Mode of Payment / Mode_of_Pay / String / NEFT/RTGS/FT/DD/IMPS / Specified channel of payment
RptCode / RptCode / String / MaxLength=20
Alphanumeric & ‘_’ / Report Code maintained for transaction auditing at Finacle
Remarks / Remarks / Remarks / String / MaxLength=50 / Transaction Notes/Remarks
Ben_ID / Bene ID / Beneficiary ID / String / MinLength=1
MaxLength=50
Alphanumeric & ‘_’ / Registered Beneficiary ID
Signature / Signature / Signature / String / No max length defined. / Encrypted key for authenticating the request. Currently not required.

Request Sample

{

"Single_Payment_Corp_Req" : {

"Header" :{

"TranID" : "${=System.currentTimeMillis() + ((int)(Math.random()*1000))}",

"Corp_ID" : "MC009",

"Maker_ID" : "M001",

"Checker_ID" : "C001",

"Approver_ID" : "A001"

},

"Body" :{

"Amount" : "1",

"Debit_Acct_No" : "405405405405",

"Debit_Acct_Name" : "GabrialaDcosta",

"Debit_IFSC" : "RATN",

"Debit_Mobile" : "7023923603",

"Debit_TrnParticulars" : "",

"Debit_PartTrnRmks":"",

"Mode_of_Pay" : "NEFT",

"Remarks" : "WE",

"RptCode" : "",

"Ben_ID" : "BENMC009bhel67845"

},

"Signature" :{

"Signature" : "Signature"

}

}

}

Response Parameters

Business Parameter Name / Description / Parameter Name / Parameter Type / Parameter Constraints / Comments
TranID / Transaction Id / TranID / String / MaxLength=20 / Transaction ID generated by customer which is unique
Corp_ID / Corporate Id / Corp_ID / String / MaxLength=20 / Unique ID assigned to each enrolled Corporate
Maker_ID / Maker Id / Maker_ID / String / MaxLength=20 / Unique ID for request creator
Checker_ID / Checker Id / Checker_ID / String / MaxLength=20 / Unique ID for request checker
Approver_ID / Approver Id / Approver_ID / String / MaxLength=20 / Unique ID for request approver
Status / Status / Status / String / SUCCESS/ FAILURE
Error_Cde / Error Code / Error_Cde / String / If Error occurs provides error code
Error_Desc / Error Description / Error_Desc / String / If Error occurs provides error description
RefNo / Reference Number / RefNo / String / MaxLength=20 / Unique reference number provided for each transaction (Same as TranID in request)
UTRNo / UTR Number / UTRNo / String / MaxLength=20 / UTR No is generated for each initiated NEFT/RTGS payment.
RRN No / RRN Number / RRN No / String / MaxLength=20 / RRN No is generated for each successful IMPS payment.
PO No. / PO No. / PO No. / String / MaxLenghth:20 / PO No. generated in CBS
Ben_Acct_No / Beneficiary Account Number / Ben_Acct_No / String / MaxLength=20 / Beneficiary Account Number
Amount / Amount / Amount / String / MaxLength=20 / Amount for which payment has to be done
TxnTime / Transaction Time / TxnTime / Timestamp / 2015-10-21 13:19:42.344823 / Date and time stamp
Ben_ID / Bene ID / Beneficiary ID / String / MaxLength=50 / Registered Beneficiary ID
Signature / Signature / Signature / String / No max length defined. / Encrypted key for authenticating the request. Currently not required.

Response Sample

{"Single_Payment_Corp_Resp": {

"Header": {

"TranID": "1474009343136",

"Corp_ID": "MC009",

"Maker_ID": "M001",

"Checker_ID": "C001",

"Approver_ID": "A001",

"Status": "Initiated",

"Error_Cde": {},

"Error_Desc": {}

},

"Body": {

"RefNo": "SPMC00927022017NEFT1",

"UTRNo": "RATNN17058682912",

"PONum": "000007504772",

"Ben_Acct_No": "409000180680",

"Amount": "10",

"Txn_Time": "2017-02-27 15:43:01.796068",

"Ben_ID": " BENMC009bhel67845" },

"Signature": {"Signature": "Signature"}

}

}

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 / Error Type
ER001 / Technical / Improper JSON Format / Improper JSON Format
ER002 / Technical / Schema Validation Failure / Schema Validation Failure
ER003 / General / Invalid CorpId / Invalid CorpId
ER004 / Technical / Technical Failure / Technical Failure
ER006 / Technical / Timeout Exception Occurred / Timeout Exception Occurred
ER008 / General / Invalid Corporate Hierarchy / Invalid Corporate Hierarchy
ER012 / General / Transaction amount greater than Approver Amount Limit / Transaction amount greater than Approver Amount Limit
ER013 / General / Duplicate Transaction Id / Duplicate Transaction Id
ER017 / General / Error Occurred While Calling the Provider Service / Error Occurred While Calling the Provider Service
ER018 / Technical / Error Occurred While Accessing The ESB Database / Error Occurred While Accessing The ESB Database
ER020 / General / Request not valid for the given Debit Acct No / Request not valid for the given Debit Acct No
ER038 / General / Ben ID is not registered / Ben ID is not registered
ER045 / General / Ben ID Provided is Deactivated / Ben ID Provided is Deactivated
ER046 / General / Ben Id provided does not map to the CorpID / Ben Id provided does not map to the CorpID
ER047 / Technical / 'DATABASE EXCEPTION' / 'DATABASE EXCEPTION'
ER049 / General / The amount limits are not set for the entered Mode of Pay / The amount limits are not set for the entered Mode of Pay

Mandatory Tags according to mode of payment.

RBL - InternalPage 123/09/18