API Description Document Requestor Requestor: Arpitam Das Date: 23 – Aug – 2017 Designation Manager Department RBL-BSG Approvals Executive Sponsor: Sujatha Date: 23 – Aug – 2017 Business Program Manager: Abhijeet Davane Date: 23 – Aug – 2017 Project Manager BSG: Sudarshan Galipelli Date: 23 – Aug – 2017 Please add additional rows if you have additional stakeholders that need to approve this document. Comments: Revision History
API Name Bills – Trade API Inquiry Description This service does all the Inquiries of Inward/Outward bills related to Trade finance module in Finacle. Process flow, UML Diagram Please add detailed process flow, UML diagram where were necessary. Transport protocol (SOAP / REST) REST API Request URLs https://gateway.rblbank.com/prod/sb/rbl/api/trade/dotradeinquiry 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 Start_Date Bill Lodge date Start_Date Date MaxLength=10 End_Date Bill Lodge date End_Date Date MaxLength=10 CIF_Id Customer ID CIF_Id Numeric MaxLength=20 Number Inquiry_Action TF Module Inquiry_Action String Either ‘PC’,’BG’,’DC’, ‘LIMIT’,’BILL’,’REMIT’
2 BG – API Inquiry This service does all the Inquiries of Bank Guarantees related to Trade finance module in Finacle. API Name BG – Trade API Inquiry Description This service does all the Inquiries of Bank Guarantees related to Trade finance module in Finacle. 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//rbl/api/trade/dotradeinquiry 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 Start_Date BG Issue date Start_Date Date MaxLength=10 End_Date BG Issue date End_Date Date MaxLength=10 CIF_Id Customer ID CIF_Id Numeric MaxLength=20 Number Inquiry_Action TF Module Inquiry_Action String Either ‘PC’,’BG’,’DC’, ‘LIMIT’,’BILL’,’REMIT’
Documentary Credits (Letter of Credits) related to finance module in Finacle. API Name DC Inward – Trade API Inquiry Description This service does all the Inquiries of Inward Documentary Credits (Letter of Credits) related to Trade finance module in Finacle. 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//rbl/api/trade/dotradeinquiry 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 Start_Date LC Issue date Start_Date Date MaxLength=10 End_Date LC date End_Date Date MaxLength=10 CIF_Id Customer ID CIF_Id Numeric MaxLength=20 Number Inquiry_Action TF Module Inquiry_Action String Either ‘PC’,’BG’,’DC’, ‘LIMIT’,’BILL’,’REMIT’
Request Sample { "doTradeInquiryReq": { "Header": { "TranID": "ENQTRAD0706", "Corp_ID": "MC009", "Maker_ID": "AC001", "Checker_ID": "AD001", "Approver_ID": "AE001" }, "Body": { "Start_Date": "04-01-2017", "End_Date": "04-01-2017", "CIF_Id":"2080906", "Inquiry_Action":"DC" } } } Response Parameters Business Parameter Name Parameter Name Type Comments TranID Transaction Id TranID String Transaction ID generated by customer is unique Corp_ID Corporate Id Corp_ID String MaxLength=20 Unique ID assigned to each enrolled Corporate Maker_ID 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 Either Success or Failure SUCCESS/ FAILURE Error_Cde Code Error_Cde String NA If Error occurs provides error code Error_Desc Error Description Error_Desc String NA If Error occurs provides error description APPLICANT_NAME Applicant name APPLICANT_NAME String NA ISSUE_BANK_NAME LC Issuing Bank ISSUE_BANK_NAME String NA TYPE_OF_DC LC ype TYPE_OF_DC String NA I – Inland F – Foreign LC_ISSUE_DATE LC Issue date LC_ISSUE_DATE Date NA EXPIRY_DATE LC expiry date EXPIRY_DATE Date NA LC_AMOUNT LC amount LC_AMOUNT Numeric NA
API Name DC Inward – Trade API Inquiry Description This service does all the Inquiries of Outward Documentary Credits (Letter of Credits) related to Trade finance module in Finacle. 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 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 Start_Date LC Issue date Start_Date Date MaxLength=10 End_Date LC Issue date End_Date Date MaxLength=10 CIF_Id Customer ID CIF_Id Numeric MaxLength=20 Number Inquiry_Action TF Module Inquiry_Action String Either ‘PC’,’BG’,’DC’, ‘LIMIT’,’BILL’,’REMIT’ Request Sample
TranID Transaction Id TranID String 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 Either Success or Failure SUCCESS/ FAILURE Error_Cde Error Code Error_Cde String NA If Error occurs provides error code Error_Desc Error Description Error_Desc String NA If occurs provides error description TradeInqResponse Trade inquiry response TradeInqResponse String NA OUTWARD INWARD CCY Currency CCY String NA BILL_TENOR Tenor of the Bill BILL_TENOR String NA U-Usance M-Mixed/Multitenor D-Deferred O-Others BILL_STAUS Status of Bill BILL_STATUS String NA G-Lodged B-Proceeds Received P-Part Realized R-Realized O-Recovered N-Dishonored K-Delinked T-Transfer BILL_LODGE_DATE Lodge date BILL_LODGE_DATE Date NA Acceptance date of Bill Date NA BILL_ID Bill ID BILL_ID NA DUE_DATE Due date DUE_DATE Date NA OUTSTANDING_AMT Outstanding amount for the bill numeric NA Response Sample {"doTradeInquiryRes": { "Header": { "TranID": "ENQTRAD06758", "Corp_ID": "Maker_ID": "AC001", "Checker_ID": "AD001", "Approver_ID": "AE001" }, "Body": {
"LIABILITY_3": "12041895.00" } } }} Sr. No Name Description 7 PC_Preshipment- Trade API Inquiry This service does all the Inquiries of PC_Preshipment related to Trade finance module in Finacle. API Name LIMITS – Trade API Inquiry Description This service does all the Inquiries of PC_Preshipment related to finance module in Finacle.. 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//rbl/api/trade/dotradeinquiry 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 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 Start_Date PC Limit Sanction date Start_Date Date MaxLength=10 End_Date PC Sanction date End_Date Date MaxLength=10 CIF_Id Customer ID CIF_Id Numeric MaxLength=20 Number Inquiry_Action TF Module Inquiry_Action String Either ‘PC’,’BG’,’DC’, ‘LIMIT’,’BILL’,’REMIT’ Request Sample { "doTradeInquiryReq": { "Header": { "TranID": "ENQTRAD0692", "Corp_ID": "Maker_ID": "AC001", "Checker_ID": "Approver_ID": "AE001" }, "Body": { "Start_Date": "15-11-2016", "End_Date":"15-11-2016", "CIF_Id":"2451565", "Inquiry_Action":"PC" } } } Response Parameters Business Parameter Name Parameter Name Type Comments TranID Transaction Id TranID String 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 Either Success or Failure SUCCESS/ FAILURE Error_Cde Error Code Error_Cde String NA If Error occurs provides error code
"Approver_ID": "AE001" }, "Body": { "Start_Date": "01-01-2016", "End_Date":"01-01-2016", "CIF_Id":"418034", "Inquiry_Action":"REMIT" } } } Response Parameters Business Parameter Name Parameter Name Type Comments TranID Transaction Id TranID String 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 Either Success or Failure SUCCESS/ FAILURE Error_Cde Error Code Error_Cde String NA If Error occurs provides error code Error_Desc Description Error_Desc String NA If occurs provides error description TradeInqResponse Trade Inquiry Response TradeInqResponse String NA “INWARD” “OUTWARD” REMIT_CCY Currency of remittance REMIT_CCY String NA AMOUNT Remittance amount AMOUNT numeric NA LODGE_DATE Remittance Lodge date LODGE_DATE Date NA REALIZED_DATE Remittance realized date REALIZED_DATE Date NA REMIT_STATUS Status of remittance REMIT_STATUS String NA Only for Inward Remittances G-Lodged R-Realized P-Part Realized N-Dishonoured CLOSE_STATUS Remittance closed status CLOSE_STATUS String NA Only for Inward Remittances Y – Closed N- Not Closed Response Sample
{"doTradeInquiryRes": { "Header": { "TranID": "ENQTRAD0708", "Corp_ID": "TMW01", "Maker_ID": "AC001", "Checker_ID": "AD001", "Approver_ID": "AE001" }, "Body": { "Status": "Success", "TradeInqResponse": {"INWARD": { "REMIT_INSTRUMENT_1": {}, "REMIT_CCY_1": "USD", "AMOUNT_1": "7323.2", "LODGE_DATE_1": "01-01-2016", "REALIZED_DATE_1": "01-01-2016", "REMIT_STATUS_1": "R", "CLOSE_STATUS_1": "Y" }} } }} Response Codes Response Stage Response Code Response Message SUCCESS SUCCESS FAILURE FAILURE Codes Error Code 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 ER004 Technical Technical Failure Technical Failure ER006 Technical Timeout Exception Occurred Timeout Exception Occurred ER007 General Other FI Error Other FI Error ER017 General Error Occurred While Calling the Provider Service Error Occurred While Calling