State Bank of India

Project Name-Yono Business –API Banking

Service Document
for
yono business_API Based ERP Integration Aggregator Model
Version No.: 0.4

Tech Mahindra

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 1 of 65

Project Confidential
 Version History

Version No Date Author Changes Made

0.1 07-Sept-2021 Nilesh Londhe  Initial Draft

0.2 13-Oct-2021 Nilesh Londhe  Review comments incorporated

0.3 22-Oct-2021 Nilesh Londhe  Error message correction
0.4 25-Oct-2021 Nilesh Londhe  Removed duplications in error
messages.

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 2 of 65

Project Confidential
 Contents
1. Introduction.......................................................................................................................................................4
2. Transaction/ Enquiry APIs................................................................................................................................5
2.1 Authentication Service.................................................................................................................................5
Corp Sec Params string generation...................................................................................................................7
Encryption/Decryption steps............................................................................................................................8
2.2 OTP Service...............................................................................................................................................11
2.3 File Based Payment..................................................................................................................................16
2.4 Cancel Transaction...................................................................................................................................26
2.5 Check Payment Status..............................................................................................................................30
2.6 Get Balance...............................................................................................................................................36
2.7 MIS............................................................................................................................................................ 41
3. API’s for Data Synchronization........................................................................................................................55
3.1 Corporate Validation Service...................................................................................................................55
3.2 Corporate Details Service........................................................................................................................57
3.3 Token Generation Service........................................................................................................................60
3.4 Token Revocation Service........................................................................................................................62

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 3 of 65

Project Confidential
1. Introduction
This document covers details of services/APIs required for integration with SBI’s API Banking system.
APIs are categorized in following 2 groups.

A. Transaction/ Enquiry APIs:

SBI’s API Banking system will host these API’s using IBM Developer portal and
Aggregator system can call these APIs as required

B. API’s for Data Synchronization:

This set of APIs will be hosted by Aggregator as per given format and SBI’s system will
consume these APIs for data sharing with the Aggregator.

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 4 of 65

Project Confidential
2. Transaction/ Enquiry APIs
SBI’s API Banking system will host these API’s using IBM Developer portal and Aggregator system
can call these APIs as required

2.1 Authentication Service

Token service will be called every time to get a new Oauth Token, which will be sent along with every service
call from ERP to SBI services

Access to backend service via API Gateway

https://uatapibanking.yonobusiness.sbi/erpuat/uat/corp/
authenticationService
Headers:
X-IBM-Client-Secret: 1e1c67f1ca982d22c40e22df459ed92f
X-IBM-Client-Id: 6242c02cf39e02b3eea3ac4f4a3b56ed

Request Parameter: -
Header

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono business. This ID

will be generated by yono business during
Aggregator Onboarding and will be communicated
to the Aggregator

client ID String Y Client id of the Aggregator generated during

subscription of the product in developer portal

client Secret String Y Secret key of the Aggregator generated during

subscription of the product in developer portal

key String (500) Y RSA encrypted AES 256 dynamic encryption key.

Request Body

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono business. This ID

will be generated by yono business during
Aggregator Onboarding

corporateAlias String (11) Y Corporate id for the customer, Yono business to

create an alias of the corporate id and share with
aggregator.
Aggregator should use the Corporate ID (alias)

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 5 of 65

Project Confidential
 provided by yono business in all the service calls

corpToken String (300) Y Token generated in yono business; this is

alphanumeric randomly generated string
This token will be generated by Corporate in
yonobusiness post login onboarding with an expiry
period. And token will be unique for the corporate.

corpSecParams String (300) Y Authentication token is generated using PAN #,

TIN #, TAN#, GSTIN, Corporate CIN, and Corporate
ID.
CorpSec Parameter generated for Aggregator to be
passed in service call
Refer Corp Sec Params string generation for steps
to generated CorpSec Parameter.

aPIReqRefNo String (26) Y This will be a reference number generated by

corporate’s ERP system
Format (YBAPIREQDDMMYYYYHHMMSSFFFF)
NOTE :
This parameter "aPIReqRefNo" is meant for audit
logging purpose for all incoming API request from
Corporate's ERP system for future reference.
We are expecting the parameter with specific
format and Corporate ERP to maintain uniqueness
while sending the aPIReqRefNo.
As per the reference number format
"YBAPIREQDDMMYYYYHHMMSSFFFF", we are
only validating starting 8 char "YBAPIREQ" in the
format followed by datestamp "DDMMYYYY".
Any details or time fractions after this format is not
being validated.

salt String (32) Y Randomly generated string by Aggregator

Response Parameter

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono business. This ID

will be generated by yono business during
Aggregator Onboarding
Value received in Request will be part of Response
parameters

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 6 of 65

Project Confidential
 corporateAlias String (11) Y Corporate id for the customer, Yono business to
create an alias of the corporate id and share with
aggregator.
Value received in Request will be part of Response
parameters

accessToken String (2000) Y Oauth access token used for service authorization.

validity String (20) Y Validity of access token.

aPIReqRefNo String (26) Y This will be a reference number generated by

corporate’s ERP system
The value received in Request will be shared as
part of Response

aPIResRefNo String (26) Y This will be a reference number generated by

Yonob
Format (YBAPIRESDDMMYYYYHHMMSSFFFF)

statusCode String (6) Y Status codes are maintained in separate

document ,

status String (10) Y Success or Failure

message String (100) Y "Token Generated Successfully"

Corp Sec Params string generation

Corporates / Aggregators are required to specify security parameter in the API banking onboarding form.
These security parameters are PAN #, TIN #, TAN#, GSTIN, Corporate CIN, Corporate ID.

Corporates / Aggregators are required to fill in mandatorily 4 out of the 6 parameters. SBI’s API Banking
platform will be generating a hash of the parameters as explained below:

For example, Corporate / Aggregator has provided following values in the form

1. PAN: AJBPW1981Y
2. GSTIN: 29AJBPW1981Y1Z5
3. TIN: 12658902432
4. TAN:
5. Corporate ID: SBI10008765
6. Corporate CIN:
Basis on the parameters provided above , hash-value(corporate security parameter) will be generated as
below

Step 1: Generate Hash using SHA 512 algorithm of (PAN#GSTIN#TIN#CorporateID) (Separated by #)

SHA512(AJBPW1981Y#29AJBPW1981Y1Z5#12658902432#SBI10008765)=X

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 7 of 65

Project Confidential
This hash will be stored in SBI API Banking Database. Corporate / Aggregator is also expected to generate the
hash in similar fashion.

Step 2: Generate random ALPHANUMERIC string of 20 characters as D12CSAEW2943R3F34F9C=Y, this

randomly generated key has to be shared with SBI during service call.

Step 3: Generate HASH of (Hash generated in step 1 + alphanumeric string generated in step 2) using SHA
512 algorithm
SHA512(X+Y)=Z
Corporate / Aggregator need to send the hash generated in Step 3 as CorpSecParams in service call and
alphanumeric string generated in Step 2 as SALT in the request.
Note: Parameter sequence for generating hash value should be in the same sequence of parameter selection at
the time of onboarding (e.g. if PAN No is selected , followed by TIN and then TAN , while hashing sequence
should be PAN >GSTIN >TIN>TAN > Corporate ID.)

Encryption/Decryption steps
i. Corporate / Aggregator System Request Initiation

 Generate dynamic 256 bit key

 Encrypt payload using AES256 algorithm
 Encrypt key in above step using RSA public key of YONOB
 Add key generated in above step in header as key
 Add client id, secret key and Oauth token to header for authentication (Oauth token is not
applicable for Authentication service only).
 Generate Hash of encrypted payload using SH 512 and add it in request as digital
Signature.

ii. Yono API Banking Request Layer

 Client IP Whitelist check

 API Authentication using Client ID and Secret key
 API Authorization using Oauth Token (this is not applicable for Authentication service
only).
 RSA decryption using private key of YONOB to retrieve AES256 key
 Generate Hash of encrypted payload using SH 512 and compare it with hash received in
request i.e. digital Signature
 Payload Decryption using AES256 dynamic key

iii. Yono API Banking Response Layer

 Encrypt response payload using AES key received in request.

iv. Corporate / Aggregator System Response Layer

 Decrypt response payload using AES key received in request .

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 8 of 65

Project Confidential
 A. Request String:-
Header:-
{
" AggregatorID ": "A6223234234R2B2V42”
"ClientID": "AJEHDBSEFWVEHJR6223234234R2B2V42",
"ClientSecret":"SDXAHWDCQYWD17E612E712E",
"Key":"SJSEHFIEFWEFWJ1287312WEE2ZFVD1EX7A0SOx8hpEgPCKArkZRhokaXgR7+oSici59t/
bQvNy+3iIhfO5mZYIr2KtdEDh8CdYZjjUZAqRlTo5dzrqVSi2PuYsgTo5/
PXvY2UWA0duZrJG2+XSUJvFxDEHI97MIz7IQnn2uRnOBlfZee”
}

Payload: -
a. Plaintext
{
"aggregatorID": "1234",
"corporateAlias": "656154C",
"corpToken": "abcersddff12345",
"salt": "266lbam9y2k",
"corpSecParams":
"783aa532be4dbde81c112d46b4bd71a9c0429163c7ac061855d1165dafc5ed3b3b156300cd5059fe
bdab9a9ae40ecce673ec51f302e1c76afab2fae0d0cbd2ae",
"aPIReqRefNo": "YBAPIREQ211020211105130199"
}

b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service

for encryption/decryption logic to be followed for request/response.)
{
    "payload":
"FWS4eUvVeN0V8gswiAebJSjFRtMpt1bO/pO3kIa8yC60FHi9bKOGBEPjPMpLsxACRaHVMQ7wPTMk
QKm2WOh8QM47OCyzpTWXIbx4WXj3PsdWGeBqKbkGDzBCmoNypWDRpjfF+gEKlLtQJBcZX1Xw61x
Xl6ZwkN7Yas4KuECe6JnmJ0df1wEs2mWnCTEce/H//
cYVhG0bHJhCj8sHVlERcxVZOalkBgTiTRXLyT47R3QGQ9d4SQoH8xMibtlxx8S0aB2K8kH+UbdTfZ1FS
+nQN9+Gf/Lf2xjLV/DSu8QWJWDjhINZBZ51lIXok0KKKxTaV4tXz2hyOsXQ5zra3VXTgT/
aOkRUu2Ux+Uim2ZGQL1kWyKfGoSVuZmTJZnJvfiTGvgB7CA+qhGV5BgcW8z5P/g==", "hashValue":
"74dd2f95700ca29a989edd6a58a69e5b25a72a06950198bea34ad3ff1461777b12913516f8d7fec90
a9b432595a8ed0aaa3acf8c66fd03f4d55aa19e0b9d99fa"
}

B. Response String:
a. Plaintext
{
"TokenType": "Bearer",
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 9 of 65

Project Confidential
 "AccessToken":"AAIgM2JkNjExZjdhNmFhMDMxMWI4OTRkODYwZjIyZmE0ZmOUctIddzpjTTYszf67w
aNfi15EXb4bWP_KUAOr_HjJgeNzmjwQgBNvBDxOPFpKT3jIflpYGFV5qa5KMJ4e5YXd",
"Validity": 900,
"aPIResRefNo": "YBAPIRES211020211629100003",
"aPIReqRefNo": "YBAPIREQ211020211105130199",
"aggregatorID": "1234",
"corporateAlias": "656154C",
"Status": "Success",
"StatusCode": "S0001",
"Message": "Token Generated Successfully"
}
b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service
for encryption/decryption logic to be followed for request/response.)
{"message":"Token Generated
Successfully","data":"RWGXmUifmya0mgjSJ4wCs2CT6mUtOj+TNXRDdqyNsj59WywrjQv9D1pRCp+Xi
w/9CnQCgdiZU5W/zoX/j7T/
rO4Ry9vk1rDBDNKYEF8CwrnwKd68ETkiBeBxzUQALTeqSKoA+wG+CM3LkPL+fmFUvGHp60eUTHE
RARTplkWJNtcPhnA+9i/
rYQbmWDZdjxay","status":"Success","statusCode":"S0001","corporateAlias":"656154C"}

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 10 of 65

Project Confidential
 2.2 OTP Service
This API is used for generate and validate OTP for 2nd factor authorization.

Access to backend service via API Gateway

https://uatapibanking.yonobusiness.sbi/erpuat/uat/corp/
sendOtp
host (10.189.98.100) Port (443)
Headers:
X-IBM-Client-Id: 6242c02cf39e02b3eea3ac4f4a3b56ed
X-IBM-Client-Secret: 1e1c67f1ca982d22c40e22df459ed92f
Authorization: Bearer <Access Token>

Request Parameter: -
Header

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono business. This ID

will be generated by Yonob during Aggregator
Onboarding.

client ID String Y Client id of the Aggregator generated during

subscription of the product in developer portal

client Secret String Y Secret key of the Aggregator generated during

subscription of the product in developer portal

key String (500) Y RSA encrypted AES 256 dynamic encryption key.

Y Token generated using PAN #, TIN #, TAN#, GSTIN,

Corporate CIN, and Corporate ID.
Token should be generated for Aggregator . (Using
O-auth parameters of Aggregator)
oauthToken String (3000)

Request Body

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono business. This ID

will be generated by Yonob during Aggregator
Onboarding.

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 11 of 65

Project Confidential
 corporateAlias String (11) Y Corporate id for the customer, Yono business to
create an alias of the corporate id and share with
aggregator.
Aggregator should use the Corporate ID (alias)
provided by yono business in all the service calls

corpToken String (300) Y Token generated in yono business; this is

alphanumeric randomly generated string

aPIReqRefNo String (26) Y This will be a reference number generated by

corporate’s ERP system
Format (YBAPIREQDDMMYYYYHHMMSSFFFF)
NOTE :
This parameter "aPIReqRefNo" is meant for audit
logging purpose for all incoming API request from
Corporate's ERP system for future reference.
We are expecting the parameter with specific format
and Corporate ERP to maintain uniqueness while
sending the aPIReqRefNo.
As per the reference number format
"YBAPIREQDDMMYYYYHHMMSSFFFF", we are only
validating starting 8 char "YBAPIREQ" in the format
followed by datestamp "DDMMYYYY".
Any details or time fractions after this format is not
being validated.

corpOTPRefNo String (20) Y This will be unique reference number generated by

corporate’s ERP system
We expect Corporate ERP to provide a string of 20
character , the string can be only number or only
alphabets or combination of both.
Y Mobile no specified during Corporate onboarding for
API Banking will be used to send OTP.
In case mobile no in OTP request is not matching with
the mobile no’s specified in onboarding form , OTP
request will be rejected.
e.g.
91|1234512345 (Domestic Mobile Numbers are only
mobileNumber String (15) allowed)

Response Parameter

Parameter Name Data Type Mandatory Description

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 12 of 65

Project Confidential
 aggregatorID String (20) Y Aggregator ID maintained in yono business.
This ID will be generated by Yonob during
Aggregator Onboarding.
Value received in Request will be part of
Response parameters
corporateAlias String (11) Y Corporate id for the customer, Yono
business to create an alias of the corporate
id and share with aggregator.
Value received in Request will be part of
Response parameters
Y This will be unique reference number
generated by corporate’s ERP system.
CorpOTPRefNo received as part of Request
to be shared as part of Response parameters
corpOTPRefNo String (20)
Y Unique OTP reference number.
Format
OTP0009009987(start with OTP then  10
yBAPIOTPRefNum String (20) digits no )
aPIReqRefNo String (26) Y This will be a reference number generated
by corporate’s ERP system
The value received in Request will be shared
as part of Response
aPIResRefNo String (26) Y This will be unique reference number
generated by Yonob
Format
(YBAPIRESDDMMYYYYHHMMSSFFFF)
statusCode String (6) Y Status codes are maintained in separate
document ,
status String (10) Y Success or Failure

message String (100) Y "OTP Generated Successfully"

A. Request String: -
Header:
{
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 13 of 65

Project Confidential
 " X-IBM-Client-Id”: " 3bd611f7a6aa0311b894d860f22fa4fc ",
" X-IBM-Client-Secret":" f3b5bcd32768bc620980332ff318700e",
"Key":"
NgPP2Kjac+6olZaaqcg0f/eDbtwZL9EL+INjqXs/bX7gKKTu2kHhDAGy5rEqqeKBrECs5ulLAQYoPF7neEl0wKzUIeKO+E
xMysLr+8rtbXBuSAGds5gbemXFTzvuQpn02ludiUnjAmM7i4maKAOoSBH3V0mRVMh3U3gpzNiVprNpJMWy84o0j3No
ZBdd1vKc2nwnHyRKXhtYzOQfcLbaJKhbAlBHiU4qO5ArS6o6G5pGoaQQX+AKdypvocK4kJQdg/
tDAtpCHe7C9KLvExptDuEP98p9NTR5p6i12OLx1GtBnRWF556s285gSBrzvdO/UqQEjhU0rYgK5LRL2dfBPQ==",
“Authorization”: “Bearer
AAIgM2JkNjExZjdhNmFhMDMxMWI4OTRkODYwZjIyZmE0ZmMHiN0RriCTOwkn77kdT0oY8e3zKugto_bpXM86HYlJU
kA5lh-TuwntRF3a-iypdPnaJ5GwlHN_JYV6hOQq11cK”
}
Payload:
a. Plaintext
{
"aggregatorID": "1234",
"corporateAlias": "656154C",
"corpToken": "abcersddff12345",
"corpOTPRefNo": "iB199991",
"aPIReqRefNo": "YBAPIREQ211020211105130199",
"corpMobileNo": "91|8103674451",
"currentTimeStamp": "1596018892687"
}

b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service

for encryption/decryption logic to be followed for request/response.)
{
"payload":
"tzQjpVlebB4NaeFpduP6WhXyLXtldYQIHFiu6AyLbspvL1RoC/W9FfrZgwXfOVPnsqq7pX30h03paqP/
lIYoqZrDMQSil0ta+Br6rR7RvzSwTQSHAXFT8ReoAUyHvOSAGqDC8c/
GoAoeuJAk3+ptVO0u8kwnWrsbnFJT2t+TiNtryXVp3vKJelFYvB/lxXF4dlV/N9fCJOhS1Z6b/
JvraTMavx8AsFGGLAXjdEnap8S01Tm1qIGMHtOijFyXE/f97MIhoQyOe/
0i5uIrrE94wkUAxuA6adhtZapMbBmNTn4=",
"hashValue":
"97f48d2ff6c2bfd372330f91a0e9f65b7e9c4e2ab683eba84d9b8e700e4f3098cdbefee340d3c07ef698
8f385bb97b0cb1ca580c7bc80362792d0c6a7c14345e"
}
B. Response String:-
a. Plaintext
{
"message": "OTP Generated Succesfully",
"data":
"{\"corporateAlias\":\"656154C\",\"corpOTPRefNo\":\"iB199991\",\"yBAPIOTPRefNum\":\"OTP00
00004587\",\"aPIResRefNo\":\"YBAPIRES211020211556260003\",\"aPIReqRefNo\":\"YBAPIREQ2
11020211105130199\",\"aggregatorID\":\"1234\"}",
"status": "Success",
"statusCode": "S0001"

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 14 of 65

Project Confidential
 }
b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service
for encryption/decryption logic to be followed for request/response.)
{"message":"OTP Generated
Succesfully","data":"gwHsaxh4kMO/C7maAYcg1hOLgz0s8vITjgBHO6cn7b37Lm9ZanOsoYNqWze35P
P2ZVo3g1vkYixycnlm3d1+DUtqDt9NwaIs+ocGkRR9WNgO5GDnuqoGFd1nFgO5SM8wACvSjh6eDpO
Ohdtpykbye1frt4exfoNav8honJWUEBUxiUEGleWWT8IICasAaPXwFhbgtuXogpTZdiQU0YtwQ1LIk3O
RmH5rXW7nvmrVuzFtgPI0pLq4Mytrt3YuT/N/
Lp3b660JZoQHP2fd3h3XnA==","status":"Success","statusCode":"S0001"}

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 15 of 65

Project Confidential
 2.3 File Based Payment
Using this API, Corporate can initiate or schedule bulk payment transaction. Bulk payment can be form based
or API with file attachment

Access to backend service via API Gateway

https://uatapibanking.yonobusiness.sbi/erpuat/uat/corp/
sendOtp
host (10.189.98.100) Port (443)
Headers:
X-IBM-Client-Id: 6242c02cf39e02b3eea3ac4f4a3b56ed
X-IBM-Client-Secret: 1e1c67f1ca982d22c40e22df459ed92f
Authorization: Bearer <Access Token>

Request Parameter: -
Header

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.

client ID String Y Client id of the Aggregator generated

during subscription of the product in
developer portal

client Secret String Y Secret key of the Aggregator generated

during subscription of the product in
developer portal

Y RSA encrypted AES 256 dynamic

aES Dynamic Key String (500) encryption key.

Y Token generated using PAN #, TIN #,

TAN#, GSTIN, Corporate CIN, and
Corporate ID.
O-Auth token generated for the
oaut Token String (3000) Aggregator

Request Body

Parameter Name Data Type Mandatory Description

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 16 of 65

Project Confidential
 Y File Object
file BLOB

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.

corporateAlias String (11) Y Corporate id for the customer, Yono

business to create an alias of the
corporate id and share with aggregator.
Aggregator should use the Corporate ID
(alias) provided by yono business in all
the service calls

corpToken String (300) Y Token generated in yono business; this

is alphanumeric randomly generated
string

Y This will be a reference number

generated by corporate’s ERP system
Format
(YBAPIREQDDMMYYYYHHMMSSFFFF)
NOTE :
This parameter "aPIReqRefNo" is meant
for audit logging purpose for all
incoming API request from Corporate's
ERP system for future reference.
We are expecting the parameter with
specific format and Corporate ERP to
maintain uniqueness while sending the
APIReqRefNo.
As per the reference number format
"YBAPIREQDDMMYYYYHHMMSSFFFF",
we are only validating starting 8 char
"YBAPIREQ" in the format followed by
datestamp "DDMMYYYY".
String (26)
Any details or time fractions after this
aPIReqRefNo format is not being validated.

Conditional Unique OTP reference number for the

corporate for this transaction. (As per
corpOTPRefNo String (20) OTP Service)

transaction Type String Y NEFT/RTGS/IMPS/SBI

Values should be any one of the above ,
in case payload contains any other
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 17 of 65

Project Confidential
 values (like rtgs/Neft,) payload will be
rejected.

Conditional Unique OTP reference number.

Format
OTP0009009987(start with OTP then 
yBAPIOTPRefNum String (20) 10 digits number )
M OTP Value
OTP Value received from yono business
( in OTP service response) is required to
oTP Numeric be passed here
Y Mobile no used for OTP generation; this
should be the mobile no provided in
onboarding.
corpOTPMobNo String (15) E.g. : 91|1234567890
Y Value to be passed as Y (uppercase) by
oTPEnabled Sting(1) default

Response Parameter

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.
Value received in Request will be part
of Response parameters
corporateAlias String (11) Y Corporate id for the customer, Yono
business to create an alias of the
corporate id and share with
aggregator.
Value received in Request will be part
of Response parameters
Y This will be a reference number
generated by corporate’s ERP system
The value received in Request will be
aPIReqRefNo String (26) shared as part of Response

aPIResRefNo String (26) This will be unique reference number

generated by Yonob
Format

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 18 of 65

Project Confidential
 (YBAPIRESDDMMYYYYHHMMSSFFFF)

Y Status codes are maintained in

statusCode String (6) separate document ,

status String (10) Y Success or Failure

message String (100) Y "File uploaded successfully"

fileAckRefNo Number (10) Y Unique reference number generated by

API platform for this file.

transaction Status String (10) Y Pending,

A. Request String: -
Header
{
" X-IBM-Client-Id”: " 3bd611f7a6aa0311b894d860f22fa4fc ",
" X-IBM-Client-Secret":" f3b5bcd32768bc620980332ff318700e",
"Key":"
NgPP2Kjac+6olZaaqcg0f/eDbtwZL9EL+INjqXs/bX7gKKTu2kHhDAGy5rEqqeKBrECs5ulLAQYoPF7neEl0wKzUIeKO+E
xMysLr+8rtbXBuSAGds5gbemXFTzvuQpn02ludiUnjAmM7i4maKAOoSBH3V0mRVMh3U3gpzNiVprNpJMWy84o0j3No
ZBdd1vKc2nwnHyRKXhtYzOQfcLbaJKhbAlBHiU4qO5ArS6o6G5pGoaQQX+AKdypvocK4kJQdg/
tDAtpCHe7C9KLvExptDuEP98p9NTR5p6i12OLx1GtBnRWF556s285gSBrzvdO/UqQEjhU0rYgK5LRL2dfBPQ==",
“Authorization”: “Bearer
AAIgM2JkNjExZjdhNmFhMDMxMWI4OTRkODYwZjIyZmE0ZmMHiN0RriCTOwkn77kdT0oY8e3zKugto_bpXM86HYlJU
kA5lh-TuwntRF3a-iypdPnaJ5GwlHN_JYV6hOQq11cK”
}
Request Body
a. Plaintext
{ file: TransactionRGTS.txt
request:{"aggregatorID": "1234","corporateAlias":
"656154C","corpToken":"abcersddff12345","corpOTPRefNo": "iB199991","corpOTPMobNo": "91|
8103674451","yBAPIOTPRefNum": "OTP0000004587","OTP": "40887199","transactionType":
"NEFT","aPIReqRefNo":"YBAPIREQ211020211010109109","oTPEnabled":"Y"}}

b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service

for encryption/decryption logic to be followed for request/response.)
{"payload":"t4Pr6sSvI1UiQri7sU/fXz6Rw07PD8/
sVLE6GWTSozUo68GXnya5uNq+Jm87tq64Ztw8iGVnppKXmLPcqAhjZvxPbsMJ5eW7Vy7wJHI/
vBlj+hQtLSgXXfZFYtJC8Y/jSajP/H8atiaXw/
cR6Esx8YylWD00+mFYEuiewIKhJbZekm0puteVFmpYwYj7+jQ0O9Fp9TiEPhB+DyEveCPJc2/8+OGK/
0K0stUUFtEkKmBaAoc/tw3W5vuVK0FNjhEbfyRKBrmeCFZ0uIxhvgnJI+/z/
XulTNBbVeGblG6ySs30NvuU/xqePMTh4A9Gu8jlt5D4Drl5LQnDpbUSqP133BV20jNyR/
seC3cLCeoNdLHhGIU/
62QfaLHOetm3URqO","hashValue":"47e90035687acd6b9ebae16b26800b8c82f837e3424cb5b4575c764

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 19 of 65

Project Confidential
 1227cfbabe9e1d3e810294b80fcc8256624e012728a388b90f4324c0d798aacb0c878c34b"}
Response String:-
a. Plaintext
{
"corporateAlias": "656154C",
"message": "File uploaded successfully",
"statusCode": "S0001",
"data": "{\"fileAckRefNo\":\"FUCN0000019206\",\"transactionStatus\":\"Pending\"}",
"status": "Success",
"aPIResRefNo": "YBAPIRES211020211558340003",
"aPIReqRefNo": "YBAPIREQ211020211010109109",
"aggregatorID": "1234"
}
b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication
service for encryption/decryption logic to be followed for request/response.)
{"corporateAlias":"656154C","message":"File uploaded
successfully","statusCode":"S0001","data":"sRr4xxlxp8qprLd2HQLB3dtoTJK2b9CaCqzlaZBODJOp+Df
rgZN9mQ9SRUdom7bTtfdyzgA3JBYe60p1bnHc/
w==","status":"Success","aPIResRefNo":"YBAPIRES221020211026410004","aPIReqRefNo":"YBAPIRE
Q221020211010109109","aggregatorID":"1234"}

File Type and Sample Files

Please refer below parameters for Debit and Credit details in file.
Debit Detail/Debit Row:

Parameter Name Data Type Mandatory Field Description

Order
DebitAccountNumber String (17) Y 1 Debit Account number will be
checked against CINB account
numbers for the Corporate
And if the debit account number in
payload is not a valid account
number mapped to corporate in
CINB , transaction request should be
rejected.
12 digit account number should be
left padded by zero as shown below.
Account No : 123456789012
After Padding: 00000123456789012
Debit BranchCode String (10) Y  2 Debit account branch code (if Branch
code is not available, branch code to
be derived from IFSC Code (Last 5
digit of IFSC code)
Date Date(dd/mm/yy Y  3 If Payment date is future date,
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 20 of 65

Project Confidential
 or transaction will be considered as
dd/mm/yyyy) scheduled transaction and will be
send to CBS on scheduled date and
time.
Debit Amount Numeric( 14,2) Y  4 FOR STP Transactions :
Payment amount will be validated
against corporate transaction limit,
Payment transaction with amount
more that corporate limit will not be
processed ( For STP Transaction)

For NONSTP Transactions:

The transaction amount will be
validated with the limit set in CINB
for the selected debit account.
Transactions with the amount
exceeding the debit account limit
should be rejected
For RTGS transactions, Minimum
Amount should be >= 2 lac
Reference No Numeric(15) Y  6 Debit Reference Number
Purpose of Transaction String(240) Y  7 Debit Transaction Remarks.
Transaction String Y  8 NEFT/RTGS/IMPS/
Type/Payment Values should be any one of the
identifier above , in case payload contains any
other values (like rtgs/Neft,) payload
will be rejected.
Blank value
Note in Debit row, there will not be any value at 5th position and delimiter (#) is required

Credit Detail/Credit Row:

Parameter Name Data Type Mandatory Field Description

Order
CreditAccountNumber String (20) Y  1 For within SBI Payments , account
number should be 17 digit account
number.
For other bank payments no
restriction on account number
length
CreditIFSCCode String (10) Y  2 For within SBI payments Branch
/Branch code code to be provided ,
If Branch code is not available,
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 21 of 65

Project Confidential
 branch code to be derived from
IFSC Code (Last 5 digit of IFSC code)
for other bank payments , IFSC code
is required
Transaction Date Date(dd/mm/yy Conditiona  3 If Payment date is future date,
or dd/mm/yyyy) l transaction will be considered as
scheduled transaction and will be
send to CBS on scheduled date and
time.
Credit Amount Numeric( 14,2) Y  5 Credit amount for the transaction

Credit Reference No  Numeric(10) Y  6 Credit Reference Number

Purpose of String(240) Y  7 Credit Transaction Remarks.
Transaction
Transaction String Y  8
NEFT/RTGS/IMPS/
Type/Payment Values should be any one of the
identifier above , in case payload contains any
other values (like rtgs/Neft,)
payload will be rejected.
Blank value is required for within
Bank transfers
Note in Credit row, there will not be any value at 4th position and delimiter (#) is required
Please note following for file creation and additional validations.

 Credit Branch Code field should accommodate 11 characters.

 Dates in transaction files can be in dd/mm/yy or dd/mm/yyyy format
 The payment identifier field should contain RTGS,NEFT for Inter Bank Transactions and Blank
value for Intra Bank Transactions
 Purpose of transaction can accommodate 240 characters but only the first 35 characters will
appear in account statement.
 Field order cannot exceed the number of field names
 For NEF/RTGS transactions, it is mandatory to provide a value for the field 'Purpose of
Transaction'.
 Sample values for 'Purpose of Transaction' will be your own reason for payment for example,
"Payment Towards loan repayment", "Deposit / Investment", "Donation", "Other".
 System will assign a default value as 'Other' in both debit and credit transaction if upload file has
no value/blank value in the field 'Purpose of Transaction'.

Sample Files :

Please refer below file formats and sample files.

1. NEFT Sample File:

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 22 of 65

Project Confidential
 2. RTGS Sample File

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 23 of 65

Project Confidential
 3. Intrabank ( Both Debit and Credit accounts in SBI) Sample File

4. IMPS Sample file

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 24 of 65

Project Confidential
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 25 of 65

Project Confidential
 2.4 Cancel Transaction
Using this API, Corporate can cancel scheduled transaction only.

Access to backend service via API Gateway

https://uatapibanking.yonobusiness.sbi/erpuat/uat/corp/
cancelScheduledTransaction
host (10.189.98.100) Port (443)
Headers:

Authorization: Bearer <Access Token>

X-IBM-Client-Secret: 6242c02cf39e02b3eea3ac4f4a3b56ed
X-IBM-Client-Id: 1e1c67f1ca982d22c40e22df459ed92f

Header

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.

client ID String Y Client id of the Aggregator generated

during subscription of the product in
developer portal

client Secret String Y Secret key of the Aggregator generated

during subscription of the product in
developer portal

Y RSA encrypted AES 256 dynamic

aES Dynamic Key String (500) encryption key.

Y Token generated using PAN #, TIN #,

TAN#, GSTIN, Corporate CIN, and
Corporate ID.
O-Auth token generated for the
oauth Token String (3000) Aggregator

Request Body

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 26 of 65

Project Confidential
 Yonob during Aggregator Onboarding.

corporateAlias String (11) Y Corporate id for the customer, Yono

business to create an alias of the
corporate id and share with
aggregator.
Aggregator should use the Corporate
ID (alias) provided by yono business in
all the service calls

corpToken String (300) Y Token generated in yono business; this

is alphanumeric randomly generated
string

Y This will be a reference number

generated by corporate’s ERP system
Format
(YBAPIREQDDMMYYYYHHMMSSFFFF)
NOTE :
This parameter "aPIReqRefNo" is
meant for audit logging purpose for all
incoming API request from Corporate's
ERP system for future reference.
We are expecting the parameter with
specific format and Corporate ERP to
maintain uniqueness while sending the
APIReqRefNo.
As per the reference number format
"YBAPIREQDDMMYYYYHHMMSSFFFF"
, we are only validating starting 8 char
"YBAPIREQ" in the format followed by
datestamp "DDMMYYYY".
Any details or time fractions after this
aPIReqRefNo String (26) format is not being validated.

String (15) Y Unique reference number generated

yBAPITXNREFNO for this transaction

Response Parameter

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 27 of 65

Project Confidential
 Value received in Request will be part
of Response parameters
corporateAlias String (11) Y Corporate id for the customer, Yono
business to create an alias of the
corporate id and share with
aggregator.
Value received in Request will be part
of Response parameters
Y This will be a reference number
generated by corporate’s ERP system
The value received in Request will be
aPIReqRefNo String (26) shared as part of Response

Y This will be unique reference number

generated by Yonob
Format
aPIResRefNo String (26) (YBAPIRESDDMMYYYYHHMMSSFFFF)

String (15) Y Unique reference number generated

for this transaction
The value received in Request will be
yBAPITXNREFNO shared as part of Response

Y Status codes are maintained in

statusCode String (6) separate document

Y Success or Failure
status String (10)

Y "Transaction canceled successfully"

message String (100)

Request String:-
Header:
{
" X-IBM-Client-Id”: " 3bd611f7a6aa0311b894d860f22fa4fc ",
" X-IBM-Client-Secret":" f3b5bcd32768bc620980332ff318700e",
"Key":"
NgPP2Kjac+6olZaaqcg0f/eDbtwZL9EL+INjqXs/bX7gKKTu2kHhDAGy5rEqqeKBrECs5ulLAQYoPF7neEl0wKzUIeKO+E
xMysLr+8rtbXBuSAGds5gbemXFTzvuQpn02ludiUnjAmM7i4maKAOoSBH3V0mRVMh3U3gpzNiVprNpJMWy84o0j3No
ZBdd1vKc2nwnHyRKXhtYzOQfcLbaJKhbAlBHiU4qO5ArS6o6G5pGoaQQX+AKdypvocK4kJQdg/
tDAtpCHe7C9KLvExptDuEP98p9NTR5p6i12OLx1GtBnRWF556s285gSBrzvdO/UqQEjhU0rYgK5LRL2dfBPQ==",
“Authorization”: “Bearer
AAIgM2JkNjExZjdhNmFhMDMxMWI4OTRkODYwZjIyZmE0ZmMHiN0RriCTOwkn77kdT0oY8e3zKugto_bpXM86HYlJU
kA5lh-TuwntRF3a-iypdPnaJ5GwlHN_JYV6hOQq11cK”
}
Payload:
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 28 of 65

Project Confidential
a. Plaintext
{
"aggregatorID": "1234",
"corporateAlias": "656154C",
"corpToken": "abcersddff12345",
"yBAPITXNREFNO": "CN47296782",
"aPIReqRefNo": "YBAPIREQ211020211306120000"
}
b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service
for encryption/decryption logic to be followed for request/response.)
{
"payload":
"KL82MkRARRvkP2t7dhnUgVfESokc64dGJ/1yg8zp4FPVUkNQPWpO83uGAFYIt71otlNgwL1XIII89TKFvgQ2d
tgtgQ0OX1fxZJQ9W4u0gxPNGPspVYixhiG9IgtVc8+CNfd0+Xayl/Gf6BTFjhSIJO6gyrqBb6xb032ACSB/
Qx17vTskwSWOS96IiRbofEDVCPyVP4IvFNspmcDg4WTtag==",
"hashValue":
"05dd4cde636e993a3aa16a5813d2d43cab5337aaccc0973e7db2761638ebd5b07bf0f7d9c26cfc1b9b49366
2b13fbe1fd5823500935b2bc877fbf113b0ae4127"
}

Response String:-
a. Plaintext
{
"status": "Failure",
"statusCode": "F0001",
"message": "This transaction is already cancelled",
"data": {
"yBAPITXNREFNO": "CN47296782",
"aPIResRefNo": "YBAPIRES211020211616330003",
"aPIReqRefNo": "YBAPIREQ211020211306120000"
},
"corporateAlias": "656154C",
"aggregatorID": "1234"
}
b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service
for encryption/decryption logic to be followed for request/response.)
{"message":"This transaction is already
cancelled","data":"KL82MkRARRvkP2t7dhnUgVfESokc64dGJ/1yg8zp4FN13knRUNB49YxjJofGOTRaZ
wr3fuiI86Byv2AvSO2U6R1czuFcXWGuH3qwm2DhQ0G9OEjbuBlAp1BvPYoJnLaCIBV70/8nxVPn2sm
zAnSDxSOvRKtUyu2H5wL2evWTlPE=","status":"Failure","statusCode":"F0001","corporateAlias":"65
6154C","aggregatorID":"1234"}

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 29 of 65

Project Confidential
 2.5 Check Payment Status
Using this API, Corporate can check status of existing transaction.

Access to backend service via API Gateway

https://uatapibanking.yonobusiness.sbi/erpuat/uat/corp/
checkPayment
host (10.189.98.100) Port (443)
Headers:

X-IBM-Client-Id: 6242c02cf39e02b3eea3ac4f4a3b56ed
X-IBM-Client-Secret: 1e1c67f1ca982d22c40e22df459ed92f
Authorization: Bearer <Access Token>

Request Parameter: -
Header

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.

client ID String Y Client id of the Aggregator generated

during subscription of the product in
developer portal

client Secret String Y Secret key of the Aggregator generated

during subscription of the product in
developer portal

Y RSA encrypted AES 256 dynamic

aES Dynamic Key String (500) encryption key.

Y Token generated using PAN #, TIN #,

TAN#, GSTIN, Corporate CIN, and
Corporate ID.
O-Auth token generated for the
oauth Token String (3000) Aggregator

Request Body

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 30 of 65

Project Confidential
 business. This ID will be generated by
Yonob during Aggregator Onboarding.

corporateAlias String (11) Y Corporate id for the customer, Yono

business to create an alias of the
corporate id and share with
aggregator.
Aggregator should use the Corporate
ID (alias) provided by yono business in
all the service calls

corpToken String (300) Y Token generated in yono business; this

is alphanumeric randomly generated
string

Y This will be a reference number

generated by corporate’s ERP system
Format
(YBAPIREQDDMMYYYYHHMMSSFFFF)
NOTE :
This parameter "aPIReqRefNo" is
meant for audit logging purpose for all
incoming API request from Corporate's
ERP system for future reference.
We are expecting the parameter with
specific format and Corporate ERP to
maintain uniqueness while sending the
APIReqRefNo.
As per the reference number format
"YBAPIREQDDMMYYYYHHMMSSFFFF"
, we are only validating starting 8 char
"YBAPIREQ" in the format followed by
datestamp "DDMMYYYY".
Any details or time fractions after this
aPIReqRefNo String (26) format is not being validated.

String (15) Conditional Unique reference number generated

yBAPITXNREFNO for this transaction

fileAckRefNo Alphanumeric(1 Conditional Unique reference number generated by

4) API platform for file.

Response Body

Parameter Name Data Type Mandatory Description

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 31 of 65

Project Confidential
 aggregatorID String (20) Y Aggregator ID maintained in yono
business. This ID will be generated by
Yonob during Aggregator Onboarding.
Value received in Request will be part of
Response parameters
corporateAlias String (11) Y Corporate id for the customer, Yono
business to create an alias of the
corporate id and share with aggregator.
Value received in Request will be part of
Response parameters
Y This will be a reference number
generated by corporate’s ERP system
The value received in Request will be
shared as part of Response
aPIReqRefNo String (26)

Y This will be unique reference number

generated by Yonob
Format
aPIResRefNo String (26) (YBAPIREQDDMMYYYYHHMMSSFFFF)

String (15) Y Unique reference number generated for

the transaction single payment
transactions,
For file based transaction , this
reference no will be available only for
yBAPITXNREFNO processed transactions in file

Y Status codes are maintained in separate

statusCode String (6) document

Y Success or Failure
status String (10)

Y E.g.: "Transaction was Successful”

message String (100)

Y Unique Transaction Reference,

applicable for other bank transfers only.
IMPS Ref No for IMPS transactions
For file based transaction , this
reference no will be available only for
UTR No/IMPS Ref No String (50) processed transactions in file

transaction Status String (50) Y Just uploaded, File is yet to be processed

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 32 of 65

Project Confidential
 (For File Based transactions)
Error in file format (For File Based
transactions)
Loading the data into transaction tables
(For File Based transactions)
File / Txn Processed (status for
processed transactions )

 Validation in process

 Validation Failure

 Pending with Approver

(For NONSTP)

 Cancelled by Approver
(for NON- STP)

 Pending 1st Level

authorize ((For
NONSTP)

 Pending 2nd Level

authorize((For NONSTP)

 Canceled by 1st level

authorize (For NONSTP)

 Canceled by 2nd level

authorize(For NONSTP)
Transaction in process(For File Based
transactions)
Transactions is processed successfully
(For File Based transactions)
Error -Core connectivity issue
Error- Concrete status is not provided
by core

Request String:-
Header:
{
" X-IBM-Client-Id”: " 3bd611f7a6aa0311b894d860f22fa4fc ",
" X-IBM-Client-Secret":" f3b5bcd32768bc620980332ff318700e",
"Key":"
NgPP2Kjac+6olZaaqcg0f/eDbtwZL9EL+INjqXs/bX7gKKTu2kHhDAGy5rEqqeKBrECs5ulLAQYoPF7neEl0wKzUIeKO+E
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 33 of 65

Project Confidential
 xMysLr+8rtbXBuSAGds5gbemXFTzvuQpn02ludiUnjAmM7i4maKAOoSBH3V0mRVMh3U3gpzNiVprNpJMWy84o0j3No
ZBdd1vKc2nwnHyRKXhtYzOQfcLbaJKhbAlBHiU4qO5ArS6o6G5pGoaQQX+AKdypvocK4kJQdg/
tDAtpCHe7C9KLvExptDuEP98p9NTR5p6i12OLx1GtBnRWF556s285gSBrzvdO/UqQEjhU0rYgK5LRL2dfBPQ==",
“Authorization”: “Bearer
AAIgM2JkNjExZjdhNmFhMDMxMWI4OTRkODYwZjIyZmE0ZmMHiN0RriCTOwkn77kdT0oY8e3zKugto_bpXM86HYlJU
kA5lh-TuwntRF3a-iypdPnaJ5GwlHN_JYV6hOQq11cK”
}
Payload
a. Plaintext
{
"aggregatorID": "1234",
"corporateAlias": "656154C",
"corpToken": "abcersddff12345",
"yBAPITXNREFNO": "",
"aPIReqRefNo": "YBAPIREQ211020211306120000",
"fileAckRefNo": "FUCN0000019214"
}
b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service
for encryption/decryption logic to be followed for request/response.)
{
"payload":
"KL82MkRARRvkP2t7dhnUgYAwAZ1djsuk1S//j24F5Dcr2u8a+RMBV2EP7ayuJWzbeSWY6Y/
h3jc35hsTE9yeSKUhMe1vkfFACkRCqkEcgvaI+R5Tn9DZgepjiTf5WFueL2hvKmL6sMOlJwtNJH7ZbZioiQR
9iUIWp6E0PN28MrtdIPx73dj+idhjdc2yydtVPfXYx5mbqmgTl64bpUZIKdB9FSFGmcPwJCkYkdExHmg=",
"hashValue":
"d2d9eb2e13f13e7f7ea7aa6b3d1c47a7b9eb739b2ae273325d5324814494f61fabc5782ebb159fcbca36e
29cd23c40e24b667109ee0b6d7c430d53e1438317dd"
}
Response String: -
a. Plaintext
{
"aPIReqRefNo": "YBAPIREQ211020211306120000",
"aPIResRefNo": "YBAPIRES211020211641140003",
"statusCode": "S0001",
"status": "Success",
"message": "Transaction was Successful",
"data": [
{
"transactionStatus": "Loading the data into transaction tables"
}
]
}

b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service

for encryption/decryption logic to be followed for request/response.)
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 34 of 65

Project Confidential
{"yBAPITXNREFNO":null,"aPIReqRefNo":"YBAPIREQ221020211306120000","aPIResRefNo":"YBAPIRES221
020211039400004","statusCode":"S0001","status":"Success","message":"Transaction was
Successful","data":"MwQwRo5VD4xhwct/XHrTtsIpoNpIdog1AkbTz0sL65N8HLk1B7UoVFbWgC1IbkK29U0P
rLROfXyQR3fOQO47YCVi/NIDI0i1N4ZKMDg7pY4="}

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 35 of 65

Project Confidential
 2.6 Get Balance
Using this API, Corporate can check status of existing transaction

Access to backend service via API Gateway

https://uatapibanking.yonobusiness.sbi/erpuat/uat/corp/accountBalance
host (10.189.98.100) Port (443)
Headers:

X-IBM-Client-Secret: 1e1c67f1ca982d22c40e22df459ed92f
X-IBM-Client-Id: 6242c02cf39e02b3eea3ac4f4a3b56ed
Authorization: Bearer <Token>

Request Parameter: -
Header

Parameter Name Data Type Mandatory Description

AggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.

Client ID String Y Client id of the Aggregator generated

during subscription of the product in
developer portal

Client Secret String Y Secret key of the Aggregator generated

during subscription of the product in
developer portal

Y RSA encrypted AES 256 dynamic

AES Dynamic Key String (500) encryption key.

Y Token generated using PAN #, TIN #,

TAN#, GSTIN, Corporate CIN, and
Corporate ID.
O-Auth token generated for the
Oauth Token String (3000) Aggregator

Request Body

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 36 of 65

Project Confidential
 Yonob during Aggregator Onboarding.

corporateAlias String (11) Y Corporate id for the customer, Yono

business to create an alias of the
corporate id and share with
aggregator.
Aggregator should use the Corporate
ID (alias) provided by yono business in
all the service calls

corpToken String (300) Y Token generated in yono business; this

is alphanumeric randomly generated
string

Y Account number will be checked

against CINB account numbers for the
Corporate
And if the debit account number in
payload is not a valid account number
mapped to corporate in CINB , enquiry
request should be rejected.
12 digit account no should be left
padded by zero as shown below.
Account No : 123456789012
After Padding: 00000123456789012
corporateAccountNumbe
r Numeric(17)

aPIReqRefNo String (26) Y This will be a reference number

generated by corporate’s ERP system
Format
(YBAPIREQDDMMYYYYHHMMSSFFFF
)
NOTE :
This parameter "aPIReqRefNo" is
meant for audit logging purpose for all
incoming API request from
Corporate's ERP system for future
reference.
We are expecting the parameter with
specific format and Corporate ERP to
maintain uniqueness while sending
the aPIReqRefNo.
As per the reference number format
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 37 of 65

Project Confidential
 "YBAPIREQDDMMYYYYHHMMSSFFFF
", we are only validating starting 8
char "YBAPIREQ" in the format
followed by datestamp "DDMMYYYY".
Any details or time fractions after this
format is not being validated.

Response Parameter

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.
corporateAlias String (11) Y Corporate id for the customer, Yono
business to create an alias of the
corporate id and share with
aggregator.
Aggregator should use the Corporate
ID (alias) provided by yono business in
all the service calls
aPIResRefNo String (26) Y This will be unique reference number
generated by YonoB
Format
(YBAPIRESDDMMYYYYHHMMSSFFFF)
aPIReqRefNo String (26) Y This will be a reference number
generated by corporate’s ERP system
The value received in Request will be
shared as part of Response

corporateAccountNumbe Y Corporate account number selected in

r Numeric(17) request should be sent in response

Y Book Balance for the corporate.

bookBalance String (20)

Y Available balance for the corporate.

availBalance String (20)

Y Holding Value for the corporate.

holdValue String (20)

Y Mod Balance for the corporate.

modBalance String (20)

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 38 of 65

Project Confidential
 Y Unclear Balance of the corporate.
unclearBalance String (20)

statusCode String (6) Y Status codes are maintained in

separate document

status String (10) Y Success or Failure

message String (100) Y "Balance enquiry request is successful"

Request String: -
Header
{
" X-IBM-Client-Id”: " 3bd611f7a6aa0311b894d860f22fa4fc ",
" X-IBM-Client-Secret":" f3b5bcd32768bc620980332ff318700e",
"Key":"
NgPP2Kjac+6olZaaqcg0f/eDbtwZL9EL+INjqXs/bX7gKKTu2kHhDAGy5rEqqeKBrECs5ulLAQYoPF7neEl0wKzUIeKO+E
xMysLr+8rtbXBuSAGds5gbemXFTzvuQpn02ludiUnjAmM7i4maKAOoSBH3V0mRVMh3U3gpzNiVprNpJMWy84o0j3No
ZBdd1vKc2nwnHyRKXhtYzOQfcLbaJKhbAlBHiU4qO5ArS6o6G5pGoaQQX+AKdypvocK4kJQdg/
tDAtpCHe7C9KLvExptDuEP98p9NTR5p6i12OLx1GtBnRWF556s285gSBrzvdO/UqQEjhU0rYgK5LRL2dfBPQ==",
“Authorization”: “Bearer
AAIgM2JkNjExZjdhNmFhMDMxMWI4OTRkODYwZjIyZmE0ZmMHiN0RriCTOwkn77kdT0oY8e3zKugto_bpXM86HYlJU
kA5lh-TuwntRF3a-iypdPnaJ5GwlHN_JYV6hOQq11cK”
}
Payload
a. Plaintext
{
"aggregatorID": "2510",
"corporateAlias": "2602",
"corpToken": "k2a6r0p2a",
"corporateAccountNumber": "00000030002046100",
"aPIReqRefNo": "YBAPIREQ211020211105130199"
}

b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication

service for encryption/decryption logic to be followed for request/response.)
{ "payload":
"ncTRmsL/Bivl2vBRngyQvqt1fD9BkeQk+3FgL7vC+412rNAfvwkZTbHpHLQ5ViR0uI+hl9fcAjTE50Ux
CFh07AIivXzV8SIQQqlBI4jowhj+va4phMF4SYzYUbm63e4bRHl22j1PPm+E+Pdk8NSfBxNHCUwUOCJ
uND9RrpNSBdR453E+LM1/3YMM2v5bZjxMbOM1CDAvqLqMpOJnTsR2dg==",
"hashValue":
"c9b4a83ad1255cf745970dc553be1c11da3eac92e031f192a55a2f5d73796a58ca06af9de7aceeb8ab
316cc2e4dce66d4238a04af3ed43e0bbff2edb83fb60d8"
}

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 39 of 65

Project Confidential
Response String:-
a. Plaintext
{
"message": "Balance enquiry request is successful",
"data":
"{\"corporateAccountNumber\":\"00000030002046100\",\"bookBalance\":\"9160265.19 \",\"avail
Balance\":\"9160265.19 \",\"holdValue\":\"0.00 \",\"modBalance\":\"0.00 \",\"unclearBalance\":\"
0.00 \",\"aPIResRefNo\":\"YBAPIRES211020211554510003\",\"aPIReqRefNo\":\"YBAPIREQ21102
0211105130199\"}",
"status": "Success",
"statusCode": "S0001",
"corporateAlias": "2602",
"aggregatorID": "2510"
}
b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service
for encryption/decryption logic to be followed for request/response.)
{"message":"Balance enquiry request is
successful","data":"ncTRmsL/Bivl2vBRngyQvqt1fD9BkeQk+3FgL7vC+434kW+eU8O7CrbwX7S/
PChz5O0yWssvJI6mOx/
UuOBfIpY7gbue2dWUeHb2vNEXkP56G9drGYDGtyYqXDpsc3DqT9yYNjySTdk1vFq3OpKzZ0dFti+J5erHw
D011vRGET97N9Q7NvOaVCnnWYf5EbsYMCkb722dJljeJvrH4bFWm14JRwx4feMSK/
UBspV8LJC2+hEKD+aUvjHZJwflTTWX7OXatwQ6bLZhMt+LXL5kKUbowtc5PbJ9HuHijysjB5EfCkPVxDqyF
2Fwc/
7tMkKkVIsHJYjimQU8lXuf1bKAFw==","status":"Success","statusCode":"S0001","corporateAlias":"2602","
aggregatorID":"2510"}

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 40 of 65

Project Confidential
 2.7 MIS
This API will help Corporate to generate transaction report for an account for a date range. This response will
be in form of array ( up to 10,000 records) in single response.
Note : MIS report generated using MIS API will have details of transactions created using Payment APIs only.
Other transaction (created using any other channels) will not be available in MIS Report.(when generated
using MIS API)

Access to backend service via API Gateway

https://uatapibanking.yonobusiness.sbi/erpuat/uat/corp/misReport

host (10.189.98.100) Port (443)

Headers:

X-IBM-Client-Secret: 1e1c67f1ca982d22c40e22df459ed92f
X-IBM-Client-Id: 6242c02cf39e02b3eea3ac4f4a3b56ed
Authorization: Bearer <Token>
Request Parameter: -
Header

Parameter Name Data Type Mandatory Description

AggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Aggregator Onboarding.

Client ID String Y Client id of the Aggregator generated

during subscription of the product in
developer portal

Client Secret String Y Secret key of the Aggregator generated

during subscription of the product in
developer portal

Y RSA encrypted AES 256 dynamic

AES Dynamic Key String (500) encryption key.

Y Token generated using PAN #, TIN #,

TAN#, GSTIN, Corporate CIN, and
Corporate ID.
O-Auth token generated for the
Oauth Token String (3000) Aggregator

Body Request

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono business.

This ID will be generated by Yonob during
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 41 of 65

Project Confidential
 Aggregator Onboarding.

corporateAlias String (11) Y Corporate id for the customer, Yono business

to create an alias of the corporate id and
share with aggregator.
Aggregator should use the Corporate ID
(alias) provided by yono business in all the
service calls

corpToken String (300) Y Token generated in yono business; this is

alphanumeric randomly generated string

Y Account number will be checked against CINB

account numbers for the Corporate
And if the debit account number in payload is
not a valid account number mapped to
corporate in CINB , enquiry request should be
rejected.
12 digit account no should be left padded by
zero as shown below.
Account No : 123456789012
After Padding: 00000123456789012
corporateAccountNumber String (17)

aPIReqRefNo String (26) Y This will be a reference number generated by

corporate’s ERP system
Format
(YBAPIREQDDMMYYYYHHMMSSFFFF)
NOTE :
This parameter "aPIReqRefNo" is meant for
audit logging purpose for all incoming API
request from Corporate's ERP system for
future reference.
We are expecting the parameter with specific
format and Corporate ERP to maintain
uniqueness while sending the aPIReqRefNo.
As per the reference number format
"YBAPIREQDDMMYYYYHHMMSSFFFF", we
are only validating starting 8 char
"YBAPIREQ" in the format followed by
datestamp "DDMMYYYY".
Any details or time fractions after this format

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 42 of 65

Project Confidential
 is not being validated.

Y Start Date from which MIS is required (Date

fromDate Date Format DD/MM/YYYY)

Y End Date till which MIS is required (Date

toDate Date Format DD/MM/YYYY)

Conditional This parameter will be required when no of

records in response file are more than 10000
and the response file is split basis record
count.
For the first request, the parameter value will
default to 0(zero)
For subsequent request (when no of records
in response parameters are >10000), Value
for Start At will be the last record no in first
response +1
Consider below example:
Total no of transactions 80000
No of records in this file 10000
More Records Yes
Start At (when 10001
corporate fetch the next
set of records)

For the next set of records, input will be

1. Account No (same as initial request)
2. Date Range (same as initial request)
Start AT (Last record no in previous response
+1)
Numeric(1-
startAt 10)

Response Parameter

Parameter Name Data Type Mandatory Description

aggregatorID String (20) Y Aggregator ID maintained in yono business.

This ID will be generated by Yonob during
Aggregator Onboarding.
corporateAlias String (11) Y Corporate id for the customer, Yono
business to create an alias of the corporate
id and share with aggregator.
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 43 of 65

Project Confidential
 Aggregator should use the Corporate ID
(alias) provided by yono business in all the
service calls
aPIReqRefNo String (26) Y This will be a reference number generated
by corporate’s ERP system
The value received in Request will be
shared as part of Response

aPIResRefNo String (26) Y This will be unique reference number

generated by YonoB
Format
(YBAPIREQDDMMYYYYHHMMSSFFFF)
Y Account number will be checked against
debit accounts selected by corporate in ERP
onboarding.
If Account is not matching with debit
account selected in ERP onboarding,
CorporateAccountNumber String (20) enquiry request will be rejected.

Y Reference number
Debit Reference Number String (20)

N Debit Account number will be checked

against debit accounts mapped with the
Corporate in CINB
Debit Account No String (17)

Y For within SBI payments if Branch code is

not available, branch code to be derived
Debit IFSC Code String (10) from IFSC Code (Last 5 digit of IFSC code)

Y Debit amount of the transaction

Debit Amount Number(14,2)

Y Debit date for transaction

Debit Date Date

Y It will be always Debit

Debit Status String (10)

Y Debit Remarks/Narration.
Debit Remarks String (50)

Credit Reference Number String (20) Y Credit Narration

Credit Account No String (20) Y Credit account no should be a valid SBI

account no with length 11

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 44 of 65

Project Confidential
 Y IFS Code for Credit Account / Branch code
for within Bank Transfers
Credit IFSC Code String (10)

Y Payment amount will be validated against

corporate transaction limit
Credit Amount Number(14,2)

Credit Date Date Y Credit Date

Credit Remarks String (50) Y Special Instructions for credit

Y It shows success or failure status of credit

Credit Status String (10) transaction

Total Records Numeric Y Total number of records in result set

Y Total no of record present in the response

No of Records in this file Numeric file (Maximum 10000 in response JSON file)

Y Yes/No
Yes – When Total no of records fetched for
the input criteria are more than records in
the first response file
No- When Total no of records fetched for
the input criteria is less than or equal to
records in the first response file
Consider below example
Total no of 80000
transactions
No of records in this 10000
file
More Records Yes
Start At 10001

Total no of 6000
transactions
No of records in this 6000
file
More Records No
More Records Numeric Start At
Records Start At Numeric(1- Y This parameter will be required when no of
10) records in response file are more than

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 45 of 65

Project Confidential
 10000 and the response file is split basis
record count.
For the first response, the parameter value
will be
last record no in response +1

YBAPITXNREFNO String (15) Y Transaction reference number.

StatusCode String (6) Y Status codes are maintained in separate

document , .

Status String (10) Y Success or Failure

Message String (100) Y "MIS Generated Successfully"

Request Body: -
Header
{
" X-IBM-Client-Id”: " 3bd611f7a6aa0311b894d860f22fa4fc ",
" X-IBM-Client-Secret":" f3b5bcd32768bc620980332ff318700e",
"Key":"
NgPP2Kjac+6olZaaqcg0f/eDbtwZL9EL+INjqXs/bX7gKKTu2kHhDAGy5rEqqeKBrECs5ulLAQYoPF7neEl0wKzUIeKO+E
xMysLr+8rtbXBuSAGds5gbemXFTzvuQpn02ludiUnjAmM7i4maKAOoSBH3V0mRVMh3U3gpzNiVprNpJMWy84o0j3No
ZBdd1vKc2nwnHyRKXhtYzOQfcLbaJKhbAlBHiU4qO5ArS6o6G5pGoaQQX+AKdypvocK4kJQdg/
tDAtpCHe7C9KLvExptDuEP98p9NTR5p6i12OLx1GtBnRWF556s285gSBrzvdO/UqQEjhU0rYgK5LRL2dfBPQ==",
“Authorization”: “Bearer
AAIgM2JkNjExZjdhNmFhMDMxMWI4OTRkODYwZjIyZmE0ZmMHiN0RriCTOwkn77kdT0oY8e3zKugto_bpXM86HYlJU
kA5lh-TuwntRF3a-iypdPnaJ5GwlHN_JYV6hOQq11cK”
}
Payload
a. Plaintext
{
"aggregatorID": "1234",
"corporateAlias": "656154C",
"corpToken": "abcersddff12345",
"fromDate": "08/10/2021",
"corporateAccountNumber": "00000030001786088",
"toDate": "13/10/2021",
"aPIReqRefNo": "YBAPIREQ211020211306120000",
"startAt": 0
}

b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication service

for encryption/decryption logic to be followed for request/response.)
{
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 46 of 65

Project Confidential
 "payload":
"SVgY9QokO8alf2bSlZzx6OMcFz1NQz+oEix/Qkjz1TM8bAPJ34ekZEYr776oc/z2EzzfnS3rpx6MWnkA0
2mEJ3fGJ5d0oDAfeM5/Dt+VVeDTcFl249cBsA+Vc88SqUkfe8AypLJLeIYYGCfW/xDWdM18uk/
u+nAwtaGIFEMCtCWb4mwlOJEJI4dnkCAI6CF6AN7kxOHj076f4VYALcjE3MkQqEKkp2szYBavbrP9An
uCdtwGxKCtAEtQGsnsjOfmEnFeHPXdSxywfP+kQi879+BcHBXNwlCjFeE6IdQ3eepvEyACt+g8NYIJN/
Y2q2cK",
"hashValue":
"f95a44b18db4238259b926f0f969f3cab95dc546ec22ec5724e6ac7babf6242b4659ff5d21f6e113b46
1ef18e4d0db135043c8dcfc8191c2902080f3034970ab"
}

Response String:-
a. Plaintext
{
"corporateAccountNumber": "00000030001786088",
"aPIReqRefNo": "YBAPIREQ211020211306120000",
"aPIResRefNo": "YBAPIRES211020211607180003",
"totalRecords": 2,
"noofRecordsinthisfile": 2,
"moreRecords": "No",
"recordsStartAt": 0,
"statusCode": "S0001",
"status": "Success",
"message": "MIS Generated Successfully",
"data": [
{
"creditAmount": "1000",
"debitAccountNo": "00000030001786088",
"debitRemarks": "imps test",
"debitAmount": "1000",
"debitStatus": "Debit",
"debitDate": "2021-10-09 18:46:36.0",
"creditAccountNo": "00000000000",
"yBAPITXNREFNO": "CJ00057548",
"debitIFSCCode": "00437",
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 47 of 65

Project Confidential
 "creditIFSCCode": "00000",
"creditRefrenceNumber": "CJ0005754800001",
"creditStatus": "failure",
"creditDate": "2021-10-09 18:46:36.0",
"debitReferenceNumber": "CJ00057548"
},
{
"creditAmount": "1000",
"debitAccountNo": "00000030001786088",
"debitRemarks": "imps test",
"debitAmount": "1000",
"debitStatus": "Debit",
"debitDate": "2021-10-09 18:51:18.0",
"creditAccountNo": "00000000000",
"yBAPITXNREFNO": "CJ00057549",
"debitIFSCCode": "00437",
"creditIFSCCode": "00000",
"creditRefrenceNumber": "CJ0005754900001",
"creditStatus": "failure",
"creditDate": "2021-10-09 18:51:18.0",
"debitReferenceNumber": "CJ00057549"
}
],
"corporateAlias": "656154C",
"aggregatorID": "1234"
}

b. Encrypted (Please refer to b. Encryption/Decryption of Request/Response in Authentication

service for encryption/decryption logic to be followed for request/response.)

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 48 of 65

Project Confidential
{"corporateAccountNumber":"00000030001786088","aPIReqRefNo":"YBAPIREQ221020211306120000",
"aPIResRefNo":"YBAPIRES221020211048420004","totalRecords":2,"noofRecordsinthisfile":2,"moreReco
rds":null,"recordsStartAt":0,"statusCode":"S0001","status":"Success","message":"MIS Generated
Successfully","data":"66PhQDPCsqugVNjW4ixDavogXDt/Ey8wFSSe+d/1yk7ntc1mS6rt4PJQ6McWTFn8
05iokIpbg6yiIdRIy/6+arbz5M6RKwi6SW5LDp3Se7ZPrSat3dBDCUBU/itUzEqOcpZdl6jgOOZmn/
BFn6IWvE23uHOziQqzWsoQBjINXPyAIgTqU6IntFXiWQVzrzQXq1MLmyegk7l2qdudObYXqoy7UM1T7I
ARvLOxqlEeo7rvEuLdeonfezqhRkNeq/5FvPVVRAR06cwb3B/
hh4A6X5YHH0MpuxdKAXVZACVenpAYcoofT6jQRF/AULdIcjVa0xO2pmkFlA0lYQJ/
YJ4IYyb+n6MpoZZNu6F/I30EA18YTjz5E8vgx/
94wplY2oai8DVJhnYyTTK+0BAZvhDzyZxDYaZVUiZynUkSCdVqZmEequ/
+Q226YIC2+pnIE0nqtoWAOyiccU6lqHH54uKHglS0XXZ9bwWZRnxGI26EFYDsFNKQetMiJYeBgl5fw3U
HNMMe3cMYsM/
j8YKRAuP+2jYTgUckAPvFlSYoh5Qjh2uTvo0fJ72LKqwyavY5yZLwRkhKPHGKnKlobdPpj7euGmPU9XV
CVYKazyZ8m/liuYgG4mMsWVY4z1iI+Y9gTEU22GuHvimzsFCnNjOk+3DqypREZHGic/
dWOLgTSej1ZPYuTkDCetB8GyOIDtqBhG9H29phsB4lsKGsrj89zIaQk0GG11wZrEOPAaMA2x3/
v+ODkNVnaxKAr3NS1LAeAa1+WpB2L6BvKqaD66XUGw5Luba1lNOBoqaBLi4efAFVoi5/
B+aJdD0wXuWhA2NgvxmI17G3jceEXRApmTaCv8Ru2y2cwR1sPdezoMZg3JdY8RN9+aCA6LNv6z+3v
52N9AzkTJW9Ka4d3+tOof+7rw8ri9K62g5A+p/uGcsm+xEhsOLh/XKqiVj9D910bInUfg/
5vxZEd8icxXSDfVskGMa11t+tuTs0cyg5yoNAgk4vFBQMnBN2Y44I10Vm/8P4+/
cbAOLj6Juay9SvwnTz8gaXKezzexXFgLrWfM/
SnFaRru6ARzAT3b3goM3TJMlqdmxngCOAN6X24HOHVSfwzxqDo8rFyfZ8WuBE9dbV2g+lH+4=","hash
Value":null}

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 49 of 65

Project Confidential
 2.8 Error Messages
Please refer below table for error code and error messages for specific service.

Service Name Message Message Type Message

Code

Common V0001 Input Validation Aggregator ID is mandatory

Common F0001 Functional Aggregator ID is not active
Validation
Common V0001 Input Validation Invalid Aggregator ID
Common V0001 Input Validation Aggregator ID should not be more than 20
characters
Common F0001 Functional Aggregator ID does not exist
Validation
Common V0001 Input Validation Corporate Alias is mandatory
Common F0001 Functional Corporate Alias is not active
Validation
Common V0001 Input Validation Invalid Corporate Alias
Common V0001 Input Validation Corporate Alias should not be more than 11
characters
Common F0001 Functional Corporate Alias does not exist
Validation
Common V0001 Input Validation Corporate token is mandatory
Common V0001 Input Validation Invalid corporate token
Common F0001 Functional Corporate token is expired
Validation
Common V0001 Input Validation Corporate token should not be more than 300
characters
Common F0001 Functional Aggregator and Corporate mapping not valid
Validation
Common V0001 Input Validation APIReqRefNo length should be 26 characters
Common V0001 Input Validation Invalid APIReqRefNo
Common V0001 Input Validation APIReqRefNo should have current date
Common V0001 Input Validation APIReqRefNo is mandatory
File Based V0001 Input Validation Corporate reference number is mandatory
Payments
File Based V0001 Input Validation Invalid corporate reference number
Payments
File Based V0001 Input Validation Mobile number is mandatory
Payments
File Based V0001 Input Validation Invalid Mobile number
Payments
File Based V0001 Input Validation Mobile number should be 10 digits
Payments
File Based V0001 Input Validation OTP reference number is mandatory
Payments
File Based V0001 Input Validation OTP reference number should not be more than
Payments 20 characters
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 50 of 65

Project Confidential
 File Based V0001 Input Validation OTP is mandatory
Payments
File Based V0001 Input Validation OTP length should be 8 digits
Payments
File Based V0001 Input Validation OTPEnabled is mandatory
Payments
File Based V0001 Input Validation Invalid OTPEnabled value
Payments
File Based V0001 Input Validation OTPEnabled should not be more than 1
Payments character
File Based V0001 Input Validation Transaction type is mandatory
Payments
File Based V0001 Input Validation Invalid Transaction type
Payments
File Based V0001 Input Validation Invalid file name
Payments
File Based V0001 Input Validation File extension not allowed (Only TXT is allowed)
Payments
File Based V0001 Input Validation Invalid file content type
Payments
File Based V0001 Input Validation File not found
Payments
File Based T0001 Technical Reached maximum number of attempts ,please
Payments Validation try after later
File Based T0001 Technical Failed to save file details ,please try again later
Payments Validation
File Based F0001 Functional OTP Mobile number and Corporate Alias does
Payments Validation not match
File Based F0001 Functional Invalid OTP, you have 2 attempts left
Payments Validation
MIS V0001 Input Validation Corporate Account Number is mandatory
MIS F0001 Functional Account number is not active
Validation
MIS V0001 Input Validation Invalid Date Format
MIS V0001 Input Validation Invalid Account number
MIS V0001 Input Validation Total count of Account numbers in request
should be less than or equal to 5
MIS V0001 Input Validation Please enter valid StartAt parameter value
MIS V0001 Input Validation From date is mandatory
MIS V0001 Input Validation To date is mandatory
MIS V0001 Input Validation Please enter valid date format
MIS V0001 Input Validation From date should be less than current date
MIS V0001 Input Validation To date should be less than current date
MIS V0001 Input Validation From date should be less than To date
MIS V0001 Input Validation Difference between From Date and To Date
should not more than 31 days
MIS V0001 Input Validation From date should not be less than 2 years from
current date

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 51 of 65

Project Confidential
 MIS V0001 Input Validation Please enter valid Corporate Account number
MIS V0001 Input Validation Corporate Account Number should be 17
characters
MIS V0001 Input Validation Invalid Date Format
MIS F0001 Functional Account number or Corporate Alias does not
Validation exist
Check Status V0001 Input Validation Invalid yBAPITXNREFNO
Check Status V0001 Input Validation yBAPITXNREFNO length should be 15 digits
Check Status V0001 Input Validation Invalid fileAckRefNo
Check Status V0001 Input Validation fileAckRefNo length should be 14 digits
Check Status V0001 Input Validation Corporate transaction reference number and
FileAckRefNo both cannot be empty
Check Status V0001 Input Validation yBAPITXNREFNO and FileAckRefNo both cannot
be entered
Check Status V0001 Input Validation Transaction Reference No is not mapped with
Corporate Alias
Check Status V0001 Input Validation File acknowledge reference number is not
mapped with Corporate Alias
Check Status V0001 Input Validation No record found
Get Balance V0001 Input Validation Corporate Account number is mandatory
Get Balance F0001 Functional Account number is not active
Validation
Get Balance V0001 Input Validation Invalid Account number
Get Balance V0001 Input Validation Account number should not be more than 17
characters
Get Balance F0001 Functional Account number or Corporate Alias does not
Validation exist
Authentication V0001 Input Validation Salt is mandatory
Authentication V0001 Input Validation Salt should not be more than 32 characters
Authentication V0001 Input Validation Salt format is invalid
Authentication V0001 Input Validation Value of corpSecParams is mandatory
Authentication V0001 Input Validation Value of corpSecParams should not be more than
300 characters
Authentication F0001 Functional Invalid Aggregator ID or security parameter
Validation
OTP V0001 Input Validation Invalid format for corpOTPRefNo
OTP V0001 Input Validation Length for corpOTPRefNo should be less than or
equal to 20 characters
OTP V0001 Input Validation Corporate OTP reference number is mandatory
OTP V0001 Input Validation Mobile number is mandatory
OTP V0001 Input Validation Only Domestic Mobile number allowed
OTP V0001 Input Validation Mobile number should be 10 digits
OTP V0001 Input Validation Invalid Mobile number
OTP F0001 Functional Duplicate corporate reference number not
Validation allowed
OTP F0001 Functional Mobile number is not mapped with the corporat
Validation e
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 52 of 65

Project Confidential
 OTP T0001 Technical Reached maximum number of attempts. Please
Validation try after some time
Cancel Payment V0001 Input Validation YBAPITXNREFNO is mandatory
Cancel Payment V0001 Input Validation YBAPITXNREFNO should not be more than 15
characters
Cancel Payment V0001 Input Validation Invalid YBAPITXNREFNO
Cancel Payment F0001 Functional YBAPITXNREFNO is not mapped with Corporate
Validation ID or Does not exists
Cancel Payment F0001 Functional Transaction cancelled successfully
Validation
Cancel Payment F0001 Functional Transaction with current date cannot be
Validation cancelled
Cancel Payment F0001 Functional This transaction already processed cannot be
Validation cancelled
Cancel Payment F0001 Functional This transaction is already cancelled
Validation

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 53 of 65

Project Confidential
3. API’s for Data Synchronization
This set of APIs will be hosted by Aggregator as per given format and SBI’s system will consume these APIs for data
sharing with the Aggregator.

3.1 Corporate Validation Service

This service hosted at aggregator will be called to validate Corporate details with the aggregator selected by the
corporate at the time of onboarding.

UAT URLs
Direct Access to backend service Access to backend service via API Gateway
To be provided later To be provided later.
N/A To be provided later.

Request Parameter: -
Header
Parameter Name Data Type Mandatory Description

AES Dynamic Key String (500) Y RSA encrypted AES 256 dynamic encryption key.

Request Body
Parameter Name Data Type Mandatory Description

Corp_AggregatorID String (20) Y Corporate’s id with the selected aggregator. This

Corporate ID should be present in aggregators system
and should be unique per Corporate.

AggregatorID String (20) Y Aggregator ID maintained in yono business.

This ID will be generated by Yonob during Onboarding

of Aggregator and shared with the Aggregator.

Enquiry_Ref_Number String (30) System generated enquiry reference number generated

for enquiry request by Yonob

Format (ENQREQDDMMYYYYHHMMSSFFFF)

Response Parameter
Parameter Name Data Type Mandatory Description

Corp_AggregatorID String (20) Y Corporate’s id with the selected aggregator. This

Corporate ID should be present in aggregators system
and should be unique per Corporate.

AggregatorID String (20) Y Aggregator ID maintained in yono business. This ID will

be generated by Yonob during Onboarding and shared
with the Aggregator.

Enquiry_Ref_Number String (30) Y System generated enquiry reference number provided

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 54 of 65

Project Confidential
 in request payload

Format (ENQREQDDMMYYYYHHMMSSFFFF)

Enquiry_Resp_Number String (30) Y System generated enquiry reference number generated

for enquiry response by aggregate

Format (ENQRESDDMMYYYYHHMMSSFFFF)

Validation Status String (1) Y “Y” or” N”

StatusCode String (6) Y Value: 200

Status String (10) Y Success or Failure

Message String (100) Y “Request Completed Successfully”

Request String: -
Header: -
{
"Key":"SJSEHFIEFWEFWJ1287312WEE2SDSBDBWSDWS240293UR1KJSDFE347534053043JSFHFKSJDV”,
}

Payload: -
a. Plaintext

{
" CorpAggregatorID ":"ZERBIA734562",
" AggregatorID": "ABCL CORP 93452",
"EnquiryRefNumber":"ENQREQ1202202113474758",
}

b. Encrypted

{
    "payload":
"RBQpeyBgB7OVjg7om5P1VNNHSIfVqh/VdfpFCoO+ib/iNrWk4iCAqIBDd2cWo4gjpet6WWFI22HpG80tMJbv
a7KsnvPla+UW8TeErTMTalC56dgMhbZyfq3/
DgAa5E73+EIjoVyZV9DRVfwhi0vQU9YB8G5TaR9kRaXs7hJKZzG8AyjTtKwnKBF/
wtWRdb3iVXbirxJ4QP1lyLUzEYrFn05e36cjK9kzmzm2CzN0BlppD36pVfVNBhG9V0AhZU7mpObpIBaPLGULz
oAcAzgZZJnY5ig38wUq125Rr854ihQ=",
    "digitalSignature":
"dGjTJH0S7u72jzd1k5nZdwjUuQ9PoaFXrqyc28gtBuuCecoL77j24E6JAg41QHa1Hq27O/
CZtbuANPazLZF91Kef11ZRwj6I4Ju5+28fKUdfPsjMOrEHzXTgs4LO3EHf3bHfNIcrM47TrG5xOhSCUT4HWXzP
q76fBxWNAS16UWGx6OeJFPIXl7kcEBHYJYNzvfpUbWJZP04RHDIP/BMgOdGfyd/3xibDAF4s4fyIBbZO8mH/
alO5Nhx3lh6RPRZ+7WaZNiOtOSTDYCSywcUwhjlfd5ABvCV1/
GRxu4r6HxV6kpY2pRo51c3HbSuqEgr64E4sfZcmPVTfeccAK3qLcA=="
}

Response String:
a. Plaintext

{
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 55 of 65

Project Confidential
 " CorpAggregatorID ":"ZERBIA734562",
" AggregatorID": "ABCL CORP 93452",
"EnquiryRefNumber":"ENQREQ1202202113474758",
"EnquiryRespNumber":"ENQRES1202202113474758",
“ValidationStatus” : “Y or N”
}
b. Encrypted

{
"payLoad":
"ckmse4MiZTR4rxrVQrtW4GqWATARs2ouARHCJyyagdH3gUcXkjWVSFU4Q9FP5dNevNh93Q7oi6mBpMKO0PA
GEMa8BpjIsLeTbVYNR2utaRg5wi2lMBX8DlqgT05elNgtP8svzFeliBKfZJ3VsP4xaWB8Tzk64GBhxjpAcqjnPeGpP1
EdOpzdW00wVJ/
DYnwskP3jF7s21gJqyen8kIW+TJoeUZRM01NZkuD8fqefS4yT5l0pGQ6ZT8ns9JzJh0urXXyrJSeatgZf9YBA8NDqZ
/FfyadIYCz+T2/
jEK4gGz0P3nsU1xp0BuZtTSCLN3gqLmOGUxJ2S0nXY9dkIFcZI8NqCiyYbnvc5rxSFrEfEt1XSyoXJHyYpFlsZB14Vx
mmh0iBOylGqsr6EABiVPHLyg==",
"StatusCode":"200",
"Status”: “Success or Failure",
"Message”: “Request Completed Successfully"
}
3.2 Corporate Details Service
This service hosted at aggregator will be called to push Corporate details captured in yono business onboarding with the
aggregator selected by the corporate at the time of onboarding.

UAT URLs
Direct Access to backend service Access to backend service via API
Gateway
To be provided later To be provided later.
N/A To be provided later.

Request Parameter: -
Header
Parameter Name Data Type Mandatory Description

AES Dynamic Key String (500) Y RSA encrypted AES 256 dynamic encryption key.

Request Body
Parameter Name Data Type Mandatory Description

Corp_AggregatorID String (20) Y Corporate’s id with the selected aggregator. This Corporate
ID should be present in aggregators system and should be
unique per Corporate.

AggregatorID String (20) Y Aggregator ID maintained in yono business. This ID will be

generated by Yonob during Onboarding and shared with
the Aggregator.

CorporateAlias String (10) Y Yono business will create an alias of the corporate id and

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 56 of 65

Project Confidential
 share with aggregator

CorporateAccount JSON Nested Y Array of accounts (debit accounts selected in yonobusiness

onboarding)

TxnUserMobile JSON Nested Y Array of mobile numbers (Transaction user mobile number
selected/entered in yonobusiness onboarding)

Enquiry_Ref_Number String (30) Y System generated enquiry reference number generated for
enquiry request by Yonob

Format (ENQREQDDMMYYYYHHMMSSFFFF)

Response Parameter
Parameter Name Data Type Mandatory Description

Corp_AggregatorID String (20) Y Corporate’s id with the selected aggregator. This

Corporate ID should be present in aggregators
system and should be unique per Corporate.

AggregatorID String (20) Y Aggregator ID maintained in yono business. This

ID will be generated by Yonob during
Onboarding and shared with the Aggregator.

String (10) Y Yono business will create an alias of the

CorporateAlias corporate id and share with aggregator

Enquiry_Ref_Number String (30) Y System generated enquiry reference number

generated for enquiry request by Yonob

Format (ENQREQDDMMYYYYHHMMSSFFFF)

StatusCode String (6) Y Value: 200

Status String (10) Y Success or Failure

Message String (100) Y "Corporate Details Pushed to Aggregator

Successfully”

Request String: -
Header:
{
"Key":"SJSEHFIEFWEFWJ1287312WEE2SDSBDBWSDWS240293UR1KJSDFE347534053043JSFHFKSJDV”,
}

Payload:
a. Plaintext

{
" CorpAggregatorID ":"ZERBIA734562",
" AggregatorID": "ABCL CORP 93452",
“YonoCorporateID”: “1000061297”
"EnquiryRefNumber":"ENQREQ1202202113474758",
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 57 of 65

Project Confidential
 “CorporateAccount”:
{
“accountsList”:
[
“00000010004312903”,
“00000010004312911”,
“00000010004312945”,
“00000010004312987”,
“00000010004312915”,
“00000010004312943”,
“00000010004312939”,
“00000010004312982”
]
},
“TxnUserMobile”:
{
“mobileNumbersList”:
[
“9819452737”,
“8088152737”,
“9764312945”,
“9819452737”,
“8088152737”,
“9764312945”
]
},

b. Encrypted

{
"digitalSignature":"ZlKd//
MDRT92uH01xEGbhqI8P0wgqH1lR05ohNQfYB4hxbSlbNBkiuAqbnKbpuEaDKpx+A1LBbaSOZ42Ma9qQ+6RZD
QmdEzx865lb8pdCu3mg3v0KmH41zltUS5nTzQYyg/YFgOomREWA/OhO/
fvEdK0qrroNZAEQxqrTN7+2eZ4FeYPrPxnABZ9HXm4DIawKiDa+/
+xk972SKRl82BwROO1uygqv4jlxRnc0sfUWqAA6tmKuqm7CIjUq74GZeUwvFxpK0qP9celcFwXfZsBJ3ZAd7OzJV
OdXjGbH7BoJ134lr3HoP8je3cvBO/4//RAfNLD3pceXukkUCXkkvD3gg==",
"payLoad":"hs0aW4TNRZbg4EK6pSdOerM9GiaUZhsOeCsQQHPRqLr9Y3RECF9t4TAJgfutYTUqA4JQ/env/
78dE6AarIaIqFeb79s+uBM5qYjJJdROt7brAn/tPM/
gfqdE0AtXmeVree8nK+bQ0T91cluxKUcnnkGRrs3W5SeAGZ36dF4RGF57d61XEUwr6cxZUwfAWNZYElXh/
8pPCIHjRRTGIv+70G5EhQrnO4NCmWVLceB5NEzpPNDW+PvAD/5piBwqAbAZ57YPgKu4NY/f7fNO4Yj/
YcpCczrJL8NCsYUTPFJi0TfH5YbheEx/v2EY6khar9z/4sOe8RL4ZgEYv2tg/
VzYkeMl4qpCT8DCXztAFfRKEBWq8lVnx55XVPaQmtwayQctFDYTUpYa1VClp40Fqg3iA/
kWm3TA4wsSCPcGQeXWOTx7lELvY358cvn4W89A2mDZNrqp8l5PDTDjVOE+r0rfi7cRQQSsmssb7ym/pbc/
EHJl1iCB66e7b8OKkkD9/3fT39255hqu/
5eWxIsMRtdhhBw7vzeO7iVc4le5U46oVzyv8lxlijv+OHLlbwDC2HHKN3T//MI+Suwen0LxYibmSg=="
}
Response String: -
a. Plaintext

{
" CorpAggregatorID ":"ZERBIA734562",
" AggregatorID": "ABCL CORP 93452",
“YonoCorporateID”: “1000061297”
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 58 of 65

Project Confidential
 "EnquiryRefNumber":"ENQREQ1202202113474758"

b. Encrypted

{
"payLoad":
"ckmse4MiZTR4rxrVQrtW4GqWATARs2ouARHCJyyagdH3gUcXkjWVSFU4Q9FP5dNevNh93Q7oi6mBpMKO0PA
GEMa8BpjIsLeTbVYNR2utaRg5wi2lMBX8DlqgT05elNgtP8svzFeliBKfZJ3VsP4xaWB8Tzk64GBhxjpAcqjnPeGpP1
EdOpzdW00wVJ/
DYnwskP3jF7s21gJqyen8kIW+TJoeUZRM01NZkuD8fqefS4yT5l0pGQ6ZT8ns9JzJh0urXXyrJSeatgZf9YBA8NDqZ
/FfyadIYCz+T2/
jEK4gGz0P3nsU1xp0BuZtTSCLN3gqLmOGUxJ2S0nXY9dkIFcZI8NqCiyYbnvc5rxSFrEfEt1XSyoXJHyYpFlsZB14Vx
mmh0iBOylGqsr6EABiVPHLyg==",
"StatusCode":"200",
"Status”: “Success or Failure",
"Message": "Corporate Details Pushed to Aggregator Successfully"
}
3.3 Token Generation Service
Using this service Corporate’s unique token generated in yono business will be pushed to the aggregator selected by the
corporate at the time of onboarding.

UAT URLs
Direct Access to backend service Access to backend service via API
Gateway
To be provided later To be provided later.
N/A To be provided later.

Request Parameter: -
Header
Parameter Name Data Type Mandatory Description

AES Dynamic Key String (500) Y RSA encrypted AES 256 dynamic encryption key.

Request Body
Parameter Name Data Type Mandatory Description

Corp_AggregatorID String (20) Y Corporate’s id with the selected aggregator.

This Corporate ID should be present in
aggregators system and should be unique per
Corporate.

AggregatorID String (20) Y Aggregator ID maintained in yono business.

This ID will be generated by Yonob during
Onboarding and shared with the Aggregator.

String (10) Y Yono business will create an alias of the

CorporateAlias corporate id and share with aggregator

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 59 of 65

Project Confidential
 Y Token generated in yono business; this is
CorporateToken String (300) alphanumeric randomly generated

Date (DD-MM-YYYY Y Token Expiry Date and time

TokenExpiryDate HH:MM: SS)

Enquiry_Ref_Number String (30) Y System generated enquiry reference number

generated for enquiry request by Yonob

Format (ENQREQDDMMYYYYHHMMSSFFFF)

Response Parameter
Parameter Name Data Type Mandatory Description

Corp_AggregatorID String (20) Y Corporate’s id with the selected

aggregator. This Corporate ID should be
present in aggregators system and should
be unique per Corporate.

AggregatorID String (20) Y Aggregator ID maintained in yono

business. This ID will be generated by
Yonob during Onboarding and shared with
the Aggregator.

String (10) Y Yono business will create an alias of the

CorporateAlias corporate id and share with aggregator

Enquiry_Ref_Number String (30) Y System generated enquiry reference

number generated for enquiry request by
Yonob

Format
(ENQREQDDMMYYYYHHMMSSFFFF)

StatusCode String (6) Y 200

Status String (10) Y Success or Failure

Message String (100) Token generated Successfully

Request String: -
Header
{
"Key":"SJSEHFIEFWEFWJ1287312WEE2SDSBDBWSDWS240293UR1KJSDFE347534053043JSFHFKSJDV”,
}

Request Body
a. Plaintext

{
" CorpAggregatorID ":"ZERBIA734562",

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 60 of 65

Project Confidential
 " AggregatorID": "ABCL CORP 93452",
“YonoCorporateID”: “1000061297”
"EnquiryRefNumber":"ENQREQ1202202113474758",
“CorporateToken”:
“/tPM/gfqdE0AtXmeVree8nK+bQ0T91cluxKUcnnkGRrs3W5SeAGZ36dF4RGF57d61XEUwr6cxZUwfAWNZYElX
h/8pPCIHjRRTGIv+70G5EhQrnO4NCmWVLceB5NEzpPNDW+PvAD”,
“TokenExpiryDate”: “12-03-2021”
}

b. Encrypted

{
"digitalSignature":"ZlKd//
MDRT92uH01xEGbhqI8P0wgqH1lR05ohNQfYB4hxbSlbNBkiuAqbnKbpuEaDKpx+A1LBbaSOZ42Ma9qQ+6RZD
QmdEzx865lb8pdCu3mg3v0KmH41zltUS5nTzQYyg/YFgOomREWA/OhO/
fvEdK0qrroNZAEQxqrTN7+2eZ4FeYPrPxnABZ9HXm4DIawKiDa+/
+xk972SKRl82BwROO1uygqv4jlxRnc0sfUWqAA6tmKuqm7CIjUq74GZeUwvFxpK0qP9celcFwXfZsBJ3ZAd7OzJV
OdXjGbH7BoJ134lr3HoP8je3cvBO/4//RAfNLD3pceXukkUCXkkvD3gg==",
"payLoad":"hs0aW4TNRZbg4EK6pSdOerM9GiaUZhsOeCsQQHPRqLr9Y3RECF9t4TAJgfutYTUqA4JQ/env/
78dE6AarIaIqFeb79s+uBM5qYjJJdROt7brAn/tPM/
gfqdE0AtXmeVree8nK+bQ0T91cluxKUcnnkGRrs3W5SeAGZ36dF4RGF57d61XEUwr6cxZUwfAWNZYElXh/
8pPCIHjRRTGIv+70G5EhQrnO4NCmWVLceB5NEzpPNDW+PvAD/5piBwqAbAZ57YPgKu4NY/f7fNO4Yj/
YcpCczrJL8NCsYUTPFJi0TfH5YbheEx/v2EY6khar9z/4sOe8RL4ZgEYv2tg/
VzYkeMl4qpCT8DCXztAFfRKEBWq8lVnx55XVPaQmtwayQctFDYTUpYa1VClp40Fqg3iA/
kWm3TA4wsSCPcGQeXWOTx7lELvY358cvn4W89A2mDZNrqp8l5PDTDjVOE+r0rfi7cRQQSsmssb7ym/pbc/
EHJl1iCB66e7b8OKkkD9/3fT39255hqu/
5eWxIsMRtdhhBw7vzeO7iVc4le5U46oVzyv8lxlijv+OHLlbwDC2HHKN3T//MI+Suwen0LxYibmSg=="
}
Response Body: -
a. Plaintext

{
" CorpAggregatorID ":"ZERBIA734562",
" AggregatorID": "ABCL CORP 93452",
“YonoCorporateID”: “1000061297”
"EnquiryRefNumber":"ENQREQ1202202113474758"
}
b. Encrypted

{
"payLoad":
"ckmse4MiZTR4rxrVQrtW4GqWATARs2ouARHCJyyagdH3gUcXkjWVSFU4Q9FP5dNevNh93Q7oi6mBpMKO0PA
GEMa8BpjIsLeTbVYNR2utaRg5wi2lMBX8DlqgT05elNgtP8svzFeliBKfZJ3VsP4xaWB8Tzk64GBhxjpAcqjnPeGpP1
EdOpzdW00wVJ/
DYnwskP3jF7s21gJqyen8kIW+TJoeUZRM01NZkuD8fqefS4yT5l0pGQ6ZT8ns9JzJh0urXXyrJSeatgZf9YBA8NDqZ
/FfyadIYCz+T2/
jEK4gGz0P3nsU1xp0BuZtTSCLN3gqLmOGUxJ2S0nXY9dkIFcZI8NqCiyYbnvc5rxSFrEfEt1XSyoXJHyYpFlsZB14Vx
mmh0iBOylGqsr6EABiVPHLyg==",
"StatusCode":"200",
"Status": "Success or Failure",
"Message": "Token generated Successfully"
}
3.4 Token Revocation Service
UAT URLs
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 61 of 65

Project Confidential
 Direct Access to backend service Access to backend service via API
Gateway
To be provided later To be provided later.
N/A To be provided later.
Using this service Corporate’s token generated in yono business will be revoked and details will be shared to
Aggregator.

Request Parameter: -
Header
Parameter Name Data Type Mandatory Description

String (25) Y Client id of the aggregator generated

during subscription of the product.

This will be visible only one-time during

subscription. If aggregator misplaces or
forgets the same, a new Client ID needs to
Client ID be regenerated.

Number (2) Y Secret key of the aggregator generated

during subscription of the product.

This will be visible only one-time during

subscription. If corporate misplaces or
forgets the same, a new Secret key need to
Client Secret be regenerated.

String (1) Y RSA encrypted AES 256 dynamic

AES Dynamic Key encryption key.

String (10) Y Token for Authorization

Oauth Token

Request Body
Parameter Name Data Type Mandatory Description

Corp_AggregatorID String (20) Y Corporate’s id with the selected aggregator.

This Corporate ID should be present in
aggregators system and should be unique
per Corporate.

AggregatorID String (20) Y Aggregator ID maintained in yono business.

This ID will be generated by Yonob during
Onboarding and shared with the
Aggregator.

String (10) Y Yono business will create an alias of the

CorporateAlias corporate id and share with aggregator

Date (DD-MM- Y Date of revocation request

TokenRevocationDate YYYY)

Token_Ref_Number String (30) Y System generated enquiry reference

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 62 of 65

Project Confidential
 number generated while issuing Corporate
Token.

This has to be stored

Format
(ENQREQDDMMYYYYHHMMSSFFFF)

Token_Rev_Req_NO String (30) Y System generated enquiry reference

number generated by Aggregator

Format
(TKREVREQDDMMYYYYHHMMSSFFFF)

Response Parameter
Parameter Name Data Type Mandatory Description

Corp_AggregatorID String (20) Y Corporate’s id with the selected aggregator.

This Corporate ID should be present in
aggregators system and should be unique per
Corporate.

AggregatorID String (20) Y Aggregator ID maintained in yono business.

This ID will be generated by Yonob during
Onboarding and shared with the Aggregator.

String (10) Y Yono business will create an alias of the

CorporateAlias corporate id and share with aggregator

Token_Rev_Req_NO String (30) Y System generated enquiry reference number

generated by Aggregator

Format
(TKREVREQDDMMYYYYHHMMSSFFFF)

Token_Rev_Res_NO String (30) Y System generated enquiry reference number

generated by Yonob

Format
(TKREVRESDDMMYYYYHHMMSSFFFF)

StatusCode String (6) Y 200

Status String (10) Y Success or Failure

Message String (100) Y "Token revoked Successfully”

Request String: -
Header
{
"ClientID": "AJEHDBSEFWVEHJR6223234234R2B2V42",
"ClientSecret":"SDXAHWDCQYWD17E612E712E",
"Key":"SJSEHFIEFWEFWJ1287312WEE2SDSBDBWSDWS240293UR1KJSDFE347534053043JSFHFKSJDV”,
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 63 of 65

Project Confidential
 “Token”:” ASDAVSVUCWSDEEHFIEFWEFWJ1287312WEE2SDSBDBWS1KJSDFE347534053043JSFHFKSJ”
}

Request Body
a. Plaintext

{
" CorpAggregatorID ":"ZERBIA734562",
" AggregatorID": "ABCL CORP 93452",
“YonoCorporateID”: “1000061297”,
" TokenRevocationDate”:”12-02-2021”,
“TokenRefNumber”: “ENQREQ210220211910547812”,
“TokenRevReqNO”: “TKREVREQ1202202113474758”
}

b. Encrypted

{
"digitalSignature":"ZlKd//
MDRT92uH01xEGbhqI8P0wgqH1lR05ohNQfYB4hxbSlbNBkiuAqbnKbpuEaDKpx+A1LBbaSOZ42Ma9qQ+6RZD
QmdEzx865lb8pdCu3mg3v0KmH41zltUS5nTzQYyg/YFgOomREWA/OhO/
fvEdK0qrroNZAEQxqrTN7+2eZ4FeYPrPxnABZ9HXm4DIawKiDa+/
+xk972SKRl82BwROO1uygqv4jlxRnc0sfUWqAA6tmKuqm7CIjUq74GZeUwvFxpK0qP9celcFwXfZsBJ3ZAd7OzJV
OdXjGbH7BoJ134lr3HoP8je3cvBO/4//RAfNLD3pceXukkUCXkkvD3gg==",
"payLoad":"hs0aW4TNRZbg4EK6pSdOerM9GiaUZhsOeCsQQHPRqLr9Y3RECF9t4TAJgfutYTUqA4JQ/env/
78dE6AarIaIqFeb79s+uBM5qYjJJdROt7brAn/tPM/
gfqdE0AtXmeVree8nK+bQ0T91cluxKUcnnkGRrs3W5SeAGZ36dF4RGF57d61XEUwr6cxZUwfAWNZYElXh/
8pPCIHjRRTGIv+70G5EhQrnO4NCmWVLceB5NEzpPNDW+PvAD/5piBwqAbAZ57YPgKu4NY/f7fNO4Yj/
YcpCczrJL8NCsYUTPFJi0TfH5YbheEx/v2EY6khar9z/4sOe8RL4ZgEYv2tg/
VzYkeMl4qpCT8DCXztAFfRKEBWq8lVnx55XVPaQmtwayQctFDYTUpYa1VClp40Fqg3iA/
kWm3TA4wsSCPcGQeXWOTx7lELvY358cvn4W89A2mDZNrqp8l5PDTDjVOE+r0rfi7cRQQSsmssb7ym/pbc/
EHJl1iCB66e7b8OKkkD9/3fT39255hqu/
5eWxIsMRtdhhBw7vzeO7iVc4le5U46oVzyv8lxlijv+OHLlbwDC2HHKN3T//MI+Suwen0LxYibmSg=="
}
Response String: -
a. Plaintext

{
" CorpAggregatorID ":"ZERBIA734562",
" AggregatorID": "ABCL CORP 93452",
“YonoCorporateID”: “1000061297”,
“TokenRefNumber”: “ENQREQ210220211910547812”,
“TokenRevReqNO”: “TKREVREQ1202202113474758”,
“TokenRevResNO”: “TKREVRES1202202113474758”
}
b. Encrypted

{
"payLoad":
"ckmse4MiZTR4rxrVQrtW4GqWATARs2ouARHCJyyagdH3gUcXkjWVSFU4Q9FP5dNevNh93Q7oi6mBpMKO0PA
GEMa8BpjIsLeTbVYNR2utaRg5wi2lMBX8DlqgT05elNgtP8svzFeliBKfZJ3VsP4xaWB8Tzk64GBhxjpAcqjnPeGpP1
EdOpzdW00wVJ/
DYnwskP3jF7s21gJqyen8kIW+TJoeUZRM01NZkuD8fqefS4yT5l0pGQ6ZT8ns9JzJh0urXXyrJSeatgZf9YBA8NDqZ
/FfyadIYCz+T2/
jEK4gGz0P3nsU1xp0BuZtTSCLN3gqLmOGUxJ2S0nXY9dkIFcZI8NqCiyYbnvc5rxSFrEfEt1XSyoXJHyYpFlsZB14Vx
Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 64 of 65

Project Confidential
 mmh0iBOylGqsr6EABiVPHLyg==",
"StatusCode":"200",
"Status": "Success or Failure",
"Message": "Token revoked Successfully"
}

Service Specification Document – Yono_Business_API Banking_Aggregator Model Page 65 of 65

Project Confidential