API Document
API Description Document
Requestor
Requestor:[ Aditya Padwal] / Date:
30 – Aug – 2016
Designation
[ Manager] / Department
[ RBL-BSG]
Approvals
Executive Sponsor:[ Sujatha Mohan ] / Date:
dd – Mmm – yy
Business Program Manager:
[ Abhijeet Davane ] / Date:
dd – Mmm – yy
Project Manager BSG:
[ Sudarshan Galipelli ] / Date:
dd – Mmm – yy
Please add additional rows if you have additional stakeholders that need to approve this document.
Comments:
Revision History
Document/Dept. Owner: / [ BSG ]Created By: / [ Aditya Padwal ] / Date: / 16 – Sep – 16
Revised By / Date Revised / New Version #
[Aditya Padwal] / 16 – Sep – 16 / 01.09
[Arpitam Das] / 03 – Apr – 17 / 01.10
[Arpitam Das] / 15 – May – 17 / 01.11
[Arpitam Das] / 03 – Aug – 17 / 01.12
[Arpitam Das] / 05 – Aug – 17 / 01.13
[Arpitam Das] / 12 – Dec – 17 / 01.14
Table of Contents
Introduction 2
List of API 3
API Name 3
Description 3
Transport protocol (SOAP / REST) 3
API Request URLs 3
https://apideveloper.rblbank.com/test/sb/rbl/v1/payments/corp/payments 3
FT Request Sample: 6
FT Response Sample 6
Error Codes 11
Appendix 11
Introduction
Project – RBL API Banking
List of API
List down the APIs part of the projects:
Sr. No / Name / Description1 / Single Payment Corp / This service does all the single payment transactions.
API Name
doSinglePaymentCorp.
Description
This service does all the single payment transactions.
Process flow, UML Diagram
Please add detailed process flow, UML diagram where were necessary.
Transport protocol (SOAP / REST)
REST
API Request URLs
https://apideveloper.rblbank.com/test/sb/rbl/v1/payments/corp/payment
Request Parameters
Business Parameter Name / Description / Parameter Name / Parameter Type / Parameter Constraints / CommentsTranID / 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 / Float / 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
Ben_IFSC / IFSC Code / Ben_IFSC / String / MaxLength=15
Alphanumeric & ‘_’ / Beneficiary Account Number Bank IFSC Code
Ben_Acct_No / Account Number / Ben_Acct_No / String / MaxLength=50
Alphanumeric & ‘_’ / Beneficiary Account Number
Ben_Name / Account Holder Name / Ben_Name / String / MaxLength=50 / Beneficiary Account Holder Name
Ben_Address / Address / Ben_Address / String / MaxLength=50 / Beneficiary Account Holder's Address
Ben_BankName / Bank Name / Ben_BankName / String / MaxLength=20
Values allowed: [\w*([\s,-]\w+)*] / Beneficiary Account Bank Address1. All numbers and letters, space, Underscore( _ ) only allowed
Ben_BankCd / Bank Code / Ben_BankCd / String / MaxLength=20
Alphanumeric & ‘_’ / Beneficiary Account Bank Code
Ben_BranchCd / Bank Bracnh Code / Ben_BranchCd / String / MaxLength=20
Alphanumeric & ‘_’ / Beneficiary Account Bank Branch Code
Ben_Email / Email Id / Ben_Email / String / MaxLength=50 / Beneficiary Account Holder's Email Id
Ben_Mobile / Mobile Number / Ben_Mobile / Numeric / MinLength=10
MaxLength=10
Values allowed:[0-9]+ / Beneficiary Account Holder's Mobile Number
Ben_TrnParticulars / Ben_TrnParticulars / Ben_TrnParticulars / String / MaxLength=50
Ben_PartTrnRmks / Ben_PartTrnRmks / Ben_PartTrnRmks / String / MaxLength=50 / details of the part transaction
Issue_BranchCd / Branch Code / Issue_BranchCd / String / MaxLength=20
Alphanumeric & ‘_’ / Issue Bank's Branch Code
Mode_of_Pay / Mode of Payment / Mode_of_Pay / String / NEFT/RTGS/FT/DD/IMPS / Specified channel of payment
RptCode / RptCode / RptCode / String / MaxLength=20
Alphanumeric & ‘_’ / Report Code maintained for transaction auditing at Finacle
Remarks / Remarks / Remarks / String / MaxLength=50 / Transaction Notes/Remarks
Signature / Signature / Signature / String / No max length defined. / Encrypted key for authenticating the request. Currently not required.
Response Parameters
Business Parameter Name / Description / Parameter Name / Parameter Type / Parameter Constraints / CommentsTranID / 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.
Ben_Acct_No / Beneficiary Account Number / Ben_Acct_No / String / MaxLength=20 / Beneficiary Account Number
TxnTime / Transaction Time / TxnTime / Timestamp / 2015-10-21 13:19:42.344823
Signature / Signature / Signature / String / No max length defined. / Encrypted key for authenticating the request. Currently not required.
FT Request Sample:
{
"Single_Payment_Corp_Req":{
"Header":{
"TranID":"1234",
"Corp_ID":"MC009",
"Maker_ID":"M001",
"Checker_ID":"C001",
"Approver_ID":"A001"
},
"Body":{
"Amount":"5",
"Debit_Acct_No":"409000433157",
"Debit_Acct_Name":"RBLBANK",
"Debit_IFSC":"RBLB1122123",
"Debit_Mobile":"0000000000",
"Debit_TrnParticulars":"NARRATION_1",
"Debit_PartTrnRmks":"NARRATION_2",
"Ben_IFSC":"CBIN0R10001",
"Ben_Acct_No":"1256905",
"Ben_Name":"RBLBANKOOL",
"Ben_Address":"MUMBAI",
"Ben_BankName":"BenBankName",
"Ben_BankCd":"BenBankCd",
"Ben_BranchCd":"BenBranchCd",
"Ben_Email":"Ben_Email",
"Ben_Mobile":"0000000000",
"Ben_TrnParticulars":"TranPrt_1",
"Ben_PartTrnRmks":"TrnRmkrs",
"Issue_BranchCd":"Issue_BranchCd",
"Mode_of_Pay":"FT",
"Remarks":"DMR",
"RptCode":"HSBA"
},
"Signature":{
"Signature":"Signature"
}
}
}
FT Response Sample
{
"Single_Payment_Corp_Resp":{
"Header":{
"TranID":"1474009343136",
"Corp_ID":"MC009",
"Maker_ID":"M001",
"Checker_ID":"C001",
"Approver_ID":"A001",
"Status":"Success",
"Error_Cde":{},
"Error_Desc":{}
},
"Body":{
"RefNo":"SPMC0091474009343136",
"Ben_Acct_No":"1256905",
"Amount":"5",
"BenIFSC":"CBIN0R10001",
"Txn_Time":"2016-09-1612:33:32.034551"
},
"Signature":{
"Signature":"Signature"
}
}
}
NEFT Request Sample:
{
"Single_Payment_Corp_Req":{
"Header":{
"TranID":"1511951616081",
"Corp_ID":"MC009",
"Maker_ID":"M003",
"Checker_ID":"C003",
"Approver_ID":"A003"
},
"Body":{
"Amount":"1",
"Debit_Acct_No":"409000147861",
"Debit_Acct_Name":"TEJUMAHTO",
"Debit_IFSC":"RBLB1122123",
"Debit_Mobile":"9895527234",
"Debit_TrnParticulars":"FARIDA",
"Debit_PartTrnRmks":"SURESH",
"Ben_IFSC":"DNSB0000021",
"Ben_Acct_No":"109566016481",
"Ben_Name":"\tVibeesh",
"Ben_Address":"MUMBAI",
"Ben_BankName":"BenBankName",
"Ben_BankCd":"ABPB",
"Ben_BranchCd":"TEST1",
"Ben_Email":"BenEmail",
"Ben_Mobile":"9895527234",
"Ben_TrnParticulars":"VIBEESH",
"Ben_PartTrnRmks":"ABHIJEET",
"Issue_BranchCd":"IssueBranchCd",
"Mode_of_Pay":"NEFT",
"Remarks":"NEFTREQUEST",
"RptCode":""
},
"Signature":{
"Signature":"Signature"
}
}
}
NEFT Sample Response:
{
"Single_Payment_Corp_Resp":{
"Header":{
"TranID":"1511951616081",
"Corp_ID":"MC009",
"Maker_ID":"M003",
"Checker_ID":"C003",
"Approver_ID":"A003",
"Status":"Initiated",
"Error_Cde":{},
"Error_Desc":{}
},
"Body":{
"RefNo":"SPMC0091511951616081",
"UTRNo":"RATNN17333426553",
"PONum":"000019186223",
"Ben_Acct_No":"109566016481",
"Amount":"1",
"BenIFSC":"DNSB0000021",
"Txn_Time":"2017-11-2916:03:40.574511"
},
"Signature":{
"Signature":"Signature"
}
}
}
RTGS Sample Request:
{
"Single_Payment_Corp_Req":{
"Header":{
"TranID":"DSP0158RDWy216",
"Corp_ID":"TESTUAT",
"Maker_ID":"M003",
"Checker_ID":"C003",
"Approver_ID":"A003"
},
"Body":{
"Amount":"200000.99",
"Debit_Acct_No":"409000150281",
"Debit_Acct_Name":"TEJUMAHTO",
"Debit_IFSC":"RBLB1122123",
"Debit_Mobile":"7023923603",
"Debit_TrnParticulars":"FARIDA",
"Debit_PartTrnRmks":"SURESH",
"Ben_IFSC":"BKID0002513",
"Ben_Acct_No":"0000004271",
"Ben_Name":"Customer3",
"Ben_Address":"MUMBAI",
"Ben_BankName":"BenBankName",
"Ben_BankCd":"BenBankCd",
"Ben_BranchCd":"BenBranchCd",
"Ben_Email":"BenEmail",
"Ben_Mobile":"7023923603",
"Ben_TrnParticulars":"ALPANA",
"Ben_PartTrnRmks":"ABHIJEET",
"Issue_BranchCd":"IssueBranchCd",
"Mode_of_Pay":"RTGS",
"Remarks":"RTGSREQUEST",
"RptCode":""
},
"Signature":{
"Signature":"Signature"
}
}
}
Sample RTGS Response:
{
"Single_Payment_Corp_Resp":{
"Header":{
"TranID":"DSP0158RDWy216",
"Corp_ID":"TESTUAT",
"Maker_ID":"M003",
"Checker_ID":"C003",
"Approver_ID":"A003",
"Status":"Initiated",
"Error_Cde":{},
"Error_Desc":{}
},
"Body":{
"RefNo":"SPTESTUATDSP0158RDWy216",
"UTRNo":"RATNH17311306833",
"PONum":"000019059483",
"Ben_Acct_No":"0000004271",
"Amount":"200000.99",
"BenIFSC":"BKID0002513",
"Txn_Time":"2017-11-0715:13:11.043724",
"CBSTrnID":"S549032"
},
"Signature":{
"Signature":"Signature"
}
}
}
Sample IMPS Request:
{
"Single_Payment_Corp_Req":{
"Header":{
"TranID":"1511944295627",
"Corp_ID":"MC009",
"Maker_ID":"M003",
"Checker_ID":"C003",
"Approver_ID":"A003"
},
"Body":{
"Amount":"1.01",
"Debit_Acct_No":"405405405405",
"Debit_Acct_Name":"SACHINRTENDULKAR",
"Debit_IFSC":"RATN0000999",
"Debit_Mobile":"9920433064",
"Ben_IFSC":"SBIN0012345",
"Ben_Acct_No":"33017400905",
"Ben_Name":"DLXB",
"Ben_BankName":"DHANALAKSHMIBANK",
"Ben_Mobile":"9696969696",
"Mode_of_Pay":"IMPS",
"Remarks":"IMPSREQUEST"
},
"Signature":{
"Signature":"Signature"
}
}
}
Sample IMPS Response:
{
"Single_Payment_Corp_Resp":{
"Header":{
"TranID":"1511944295627",
"Corp_ID":"MC009",
"Maker_ID":"M003",
"Checker_ID":"C003",
"Approver_ID":"A003",
"Status":"Success",
"Resp_cde":"91",
"Error_Desc":""
},
"Body":{
"RefNo":"SPMC0091511944295627",
"channelpartnerrefno":"IMPSMC0091511944295627",
"RRN":"733314573138",
"Ben_Acct_No":"33017400905",
"Amount":"1.01",
"BenIFSC":"SBIN0012345",
"Txn_Time":"2017-11-2914:03:23.607778"
},
"Signature":{
"Signature":"Signature"
}
}
}
Response Codes
Response Stage / Response Code / Response MessageSUCCESS / SUCCESS
FAILURE / FAILURE
Error Codes
Error Code / Error Type / Short Message / Long Message / Correcting This Error / Error TypeER001 / General / Improper JSON Format / Improper JSON Format
ER002 / Validation / Schema Validation Failure / Schema Validation Failure
ER003 / Validation / Invalid CorpId / Invalid CorpId
ER004 / Technical / Technical Failure / Technical Failure
ER006 / Technical / Timeout Exception Occurred / Timeout Exception Occurred
ER007 / Business / Other FI Error / Other FI Error
ER008 / Validation / Invalid Corporate Hierarchy / Invalid Corporate Hierarchy
ER012 / Validation / Transaction Amount greater than Approver Amount limit. / Transaction Amount greater than Approver Amount limit.
ER013 / Validation / Duplicate transaction Id / Duplicate transaction Id
Appendix
Schema Validation scenarios
Mandatory and Non- Mandatory fields/tags
RBL - Internal Page 6 12/12/17