API Document

Payee Name Validation

API Specification Document

RBL - Internal Page 1 03/10/20

 API Document

Table of Contents

1. INTRODUCTION
2. LIST OF API
3. API NAME
4. DESCRIPTION
5. TRANSPORT PROTOCOL (SOAP / REST)
6. API REQUEST URLS
7. ACCESS REQUIREMENT
8. REQUEST PARAMETERS
9. REQUEST SAMPLE
10. RESPONSE PARAMETERS
11. RESPONSE SAMPLE
12. RESPONSE CODES
13. ERROR CODES

RBL - Internal Page 2 03/10/20

 API Document

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

Introduction
API for validating Beneficiary details basis account number and IFSC code.
A total amount of 1 rupee is transferred to Beneficiaries account as a part of
verification process. This API has commercials involved; Usage will be charged on
monthly basis for the consumer/client.
List of API

Sr. No Name Description

Payee Name Validation This service validates Beneficiaries
1 on the basis of their Account
Number and IFSC code.

API Name
Payee_Name_Validation.

Description
This service would validate Beneficiaries corresponding to every unique Ben
Account number and IFSC code.

Transport protocol (SOAP / REST)

REST

API Request URLs

https://apideveloper.rblbank.com/test/sb/rbl/api/payee-validation/validate

Request Parameters
Business
Parameter Descriptio Parameter Parameter Parameter
Name n Name Type Constraints Comments
 Transaction ID
generated by
Transaction Alphanumeric consumer which is
 TranID Id TranID String MaxLength=16 unique
 Unique ID assigned
Corporate Alphanumeric & to each enrolled
Corp_ID Id Corp_ID String MaxLength=16 Corporate
Alphanumeric &  Unique ID for
Maker_ID Maker Id Maker_ID String MaxLength=20 request creator
Alphanumeric &  Unique ID for
Checker_ID Checker Id Checker_ID String MaxLength=20 request checker

Approver Alphanumeric &   Unique ID for

Approver_ID Id Approver_ID String MaxLength=20 request approver
IfscCode IFSC Code ifscCode String Alphanumeric Beneficiary Account
Number Bank IFSC

RBL - Internal Page 3 03/10/20

 API Document

MaxLength=15 Code
Account Alphanumeric
Number Beneficiary Account
accountNumber accountNumber Number MaxLength=20 Number
Account
beneficiaryNam Holder beneficiaryNam Alphanumeric Beneficiary Account
e Name e String MaxLength=50 Holder Name

Beneficiari Beneficiary Account

BeneficiaryMo es Mobile beneficiaryMobi Holder's Mobile
bileNumber Number leNumber Number MaxLength=10 Number
Encrypted key for
Signature authenticating the
No max length request. Currently
Signature Signature String defined. not required.

Request Sample:

{
"beneficiaryAccValidationReq": {
"Header": {
"TranID": "20017",
"Corp_ID": "MC001",
"Maker_ID": "M001",
"Checker_ID": "C001",
"Approver_ID": "A001"
},
"Body": {
"beneficiaryName": "AritraSupport",
"beneficiaryMobileNumber": "9920433064",
"accountNumber": "109566016496",
"ifscCode": "DNSB0000021"
},
"Signature": {
"Signature": "Signature"
}
}
}
Response Parameters

Business Descriptio Parameter Parameter

Parameter Name n Parameter Name Type Constraints Comments
 Transaction
Transaction ID generated
Id by customer
Alphanumeric which is
TranID   TranID String MaxLength=16 unique
Corp_ID Corp_ID String Alphanumeric  Unique ID
Corporate Id MaxLength=16 assigned to each
enrolled

RBL - Internal Page 4 03/10/20

 API Document

Corporate
Alphanumeric  Unique ID for
Maker_ID Maker Id Maker_ID String MaxLength=20 request creator
Alphanumeric  Unique ID for
Checker_ID Checker Id Checker_ID String MaxLength=20 request checker
Alphanumeric   Unique ID for
Approver_ID Approver Id Approver_ID String MaxLength=20 request approver
 Success/
Status Status Status String NA Failure
If Error occurs
Error Code provides error
Error_Cde Error_Cde String NA code 
 If Error occurs
Error provides error
Error_Desc Description Error_Desc String NA description
Account Alphanumeric Beneficiary
Number Account
accountNumber accountNumber Number MaxLength=20 Number
IFSC Code Beneficiary
Alphanumeric Account
Number Bank
ifscCode IfscCode String MaxLength=15 IFSC Code
Beneficiary Alphanumeric Beneficiary
BeneName Name beneName String MaxLength=50 Name from GI
Remarks Transaction
Remarks Remarks String NA Notes/Remarks
Bank Beneficiary
Reference Bank
Number Reference
BankRefNo BankRefNo String NA Number
 Response
NPCI code of NPCI
NPCIResponseCod Response for every
e Code NPCIResponseCode String NA transaction.

Response Sample for status as ‘Success’

{
"beneficiaryAccValidationRes": {
"Header": {
"TranID": "20017",
"Corp_ID": "MC001",
"Maker_ID": "M001",
"Checker_ID": "C001",
"Approver_ID": "A001"
},
"Body": {
"status": "Success",
"accountNumber": "109566016496",
"ifscCode": " DNSB0000021",
"beneName": "VARSHA",
"remarks": "Transaction is successful and customer is successfully validated",
"bankRefNo": "629114449955",
"npciResponsecode": "00"
},
"Singnature": {

RBL - Internal Page 5 03/10/20

 API Document
"Singnature": "Signature"
}
}}

Response Sample for status as ‘Failed’

{
"beneficiaryAccValidationRes": {
"Header": {
"TranID": "1476860490613",
"Corp_ID": "MC009",
"Maker_ID": "M001",
"Checker_ID": "C001",
"Approver_ID": "A001"
},
"Body": {
"Status": "Failed",
"Error_Cde": "0",
"Error_Desc": "Transaction is rejected and customer is not validated with
reason:TRANSACTION FAILED "
},
"Signature": {
"Signature": "Signature"
}
}
}

Response Codes:

Response Stage Response Code Response Message

 SUCCESS     SUCCESS
FAILED   FAILED

RBL - Internal Page 6 03/10/20

 API Document

Error Codes
Error Type Correcting This
Error Code Short Message Long Message Error
 Improper JSON Improper JSON
 ER001 General Format Format
   
Validation Schema
Validation Schema
Failure Validation Failure
ER002
Invalid CorpId Invalid CorpId
ER003 Validation
Technical
Technical Failure Technical Failure
ER004
Timeout Timeout
Technical Exception Exception
Occurred Occurred
ER006
Validation Duplicate Duplicate
transaction Id transaction Id
ER013

Appendix
List of mandatory tags in request and response

TITLE
FIELDS TAGS MANDATORY VALUES MANDATORY
beneficiaryName Y Y
beneficiaryMobileNumbe
r Y Y
accountNumber Y Y
ifscCode Y Y

ERROR
TAGS VALUES
FIELDS MANDATORY MANDATORY
NA NA NA
NA NA NA
NA NA NA

RBL - Internal Page 7 03/10/20