Single Payment Status API

API Document

RBL bANK lTD.
Single payment Status API /

Version: 1.01

**** Version History ****

Date / Version / Amendment Comments
(relating to version being introduced) / Owner
16-Sep-16 / 01.01 / Single Payment StatusAPI / Richa Gupta

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

Project – RBL API Banking

List of API

List down the APIs part of the projects:

Sr. No / Name / Description
1 / Single Payment Status Corp / Fetches the status of the required transaction

API Name

getSinglePaymentStatusCorp

Description

Fetches the status of the required transaction.

Process flow, UML Diagram

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

Transport protocol (SOAP / REST)

REST

API Request URLs

Request Parameters

Request Sample

Using Ref No.:

{

"get_Single_Payment_Status_Corp_Req": {

"Header": {

"TranID": "123098",

"Corp_ID": "MC005",

"Maker_ID": "M001",

"Checker_ID": "C001",

"Approver_ID": "A001"

"Body": {

"RefNo": "SPMC005SK898356"

"Signature": {

"Signature": "12345"

}

Using OrgTransactionID:

{

"get_Single_Payment_Status_Corp_Req": {

"Header": {

"TranID": "123098",

"Corp_ID": " MC005",

"Maker_ID": "M001",

"Checker_ID": "C001",

"Approver_ID": "A001"

"Body": {

"OrgTransactionID": "SK898356"

"Signature": {

"Signature": "12345"

}

Response Parameters

Business Parameter Name / Description / Parameter Name / Parameter Type / Parameter Constraints / Comments
TranID / Transaction Id / TranID / String / Alphanumeric & ‘_’
MaxLength=16 / Transaction ID generated by consumer which is unique
Corp_ID / Corporate Id / Corp_ID / String / Alphanumeric & ‘_’
MaxLength=20 / Unique ID assigned to each enrolled Corporate
Maker_ID / Maker Id / Maker_ID / String / Alphanumeric & ‘_’
MaxLength=20 / Unique ID for request creator
Checker_ID / Checker Id / Checker_ID / String / Alphanumeric & ‘_’
MaxLength=20 / Unique ID for request checker
Approver_ID / Approver Id / Approver_ID / String / Alphanumeric & ‘_’
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
ORGTRANSACTIONID / Original Transaction ID / ORGTRANSACTIONID / String / Alphanumeric & ‘_’ / This will show the exact Transaction ID
Amount / Transaction Amount / AMOUNT / Numeric / Transaction Amount
RefNo / Reference Number / RefNo / String / Alphanumeric & ‘_’
MaxLength=40 / RefNo of the transaction for which the details are required
UTRNo / UTRNo / UTRNo / String / Alphanumeric & ‘_’
MaxLength=20 / UTR of the transaction for which the details are required (Only incase of NEFT/RTGS)
PONUM / PO Number / PONUM / Numeric / PONUM of the transaction for which the details are required (Only in case of NEFT/RTGS)
RRN / RRN / RRN / Numeric / minInclusive =1 maxInclusive = 99999999999999999999 / RefNo of the transaction for which the details are required (Only in case of IMPS)
PAYMENTSTATUS / PAYMENTSTATUS / PAYMENTSTATUS / String / Values allowed[7/8/9] / 7 – Confirmed Success
8 – Confirmed Failure
9 – Awaiting Confirmation(Only in case of IMPS)
REMITTERNAME / Debit Account Name / REMITTERNAME / String / Debit Account Name(Only in case of IMPS)
REMITTERMBLNO / Debit Mobile Number / REMITTERMBLNO / Number / Max Length = 10 / Debit Mobile Number(Only in case of IMPS)
BENEFICIARYNAME / BENEFICIARY NAME / BENEFICIARYNAME / String / Beneficiary Name(Only in case of IMPS)
BANK / Bank Name / BANK / String / Beneficiary bank name(Only in case of IMPS)
IFSCCODE / Beneficiary IFSC code / BENIFSC / String / Beneficiary IFSC Code(Only in case of IMPS)
BEN_ACCT_NO / Beneficiary Account Number / Ben_Acct_No / String / MaxLength=20 / Account number of the beneficiary of the transactions
BENIFSC / Beneficiary IFSC code / BENIFSC / String / Beneficiary IFSC Code
TXNSTATUS / Transaction
Status / TxnStatus / String / SUCCESS/ FAILURE / Status of the transactions
STATUSDESC / Status Description / StatusDesc / String / Failure reason provided in case of a failed transaction
BEN_CONF_RECEIVED / BENEFICIARY CONFIRMATION RECEIVED / BEN_CONF_RECEIVED / Char / Y/N / Flag value showing if Beneficiary confirmation is received or not. (only in case of NEFT)
CREDIT_DATETIME / CREDIT DATETIME / CREDIT_DATETIME / Timestamp / DD-MM-YYYY HH:MM:SS / Time specifying the credit happened at beneficiary end. (only in case of NEFT)
TXNTIME / Transaction Time / TXNTIME / Timestamp / DD-MM-YYYY HH:MM:SS / 2015-10-21 13:19:42.34
Signature / Signature / Signature / String / No max length defined. / Encrypted key for authenticating the request. Currently not required.

Response Sample

{

"get_Single_Payment_Status_Corp_Res": {

"Header": {

"TranID": "123098",

"Corp_ID": "MC005",

"Maker_ID": "M001",

"Checker_ID": "C001",

"Approver_ID": "A001",

"Status": "SUCCESS",

"Error_Cde": "",

"Error_Desc": ""

"Body": {

"ORGTRANSACTIONID": "SK898356",

"AMOUNT": "1",

"REFNO": "SPMC005SK898356",

"UTRNO": "RATNN17186896311",

"PONUM": "000017536221",

"BEN_ACCT_NO": "1006211030035980",

"BENIFSC": "CBIN0R10001",

"TXNSTATUS": "Success",

"STATUSDESC": "",

"BEN_CONF_RECEIVED": "Y",

"CREDIT_DATETIME": "23-06-2017 09:00:48",

"TXNTIME": "2017-07-05 17:05:11.40"

"Signature": {

"Signature": "12345"

}

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 / 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
ER005 / Validation / Please provide RefNo/UTR No/RRN / Please provide RefNo/UTR No/RRN
ER006 / Technical / Timeout Exception Occurred / Timeout Exception Occurred
ER007 / Business / Other FI Error / Other FI Error
ER008 / Validation / Invalid Corporate Hierarchy / Invalid Corporate Hierarchy
ER009 / Validation / RefNo does not exist / RefNo does not exist
ER010 / Validation / UTRNo does not exist / UTRNo does not exist
ER011 / Validation / RRN No does not exist / RRN No does not exist
ER017 / Technical / Error Occurred While Calling the Provider Service / Error Occurred While Calling the Provider Service
ER018 / DB Error / Error Occurred While Accessing The ESB Database / Error Occurred While Accessing The ESB Database
ER019 / Validation / UTR No and Ref No in the request do not map to each other / UTR No and Ref No in the request do not map to each other
ER021 / Validation / Request not valid for the given CorpId / Request not valid for the given CorpId
ER023 / Validation / RRN No and Ref No in the request do not map to each other / RRN No and Ref No in the request do not map to each other

Appendix

List of mandatory tags for request and response

RBL - InternalPage 130/09/18