Professional Documents
Culture Documents
Solution Document API Based ERP Integration - Postlogin Onboarding Journey v0.9 - 05062021
Solution Document API Based ERP Integration - Postlogin Onboarding Journey v0.9 - 05062021
Solution Document
for
API Banking Onboarding (Post-login) through yonoBusiness
Tech Mahindra
2. SCOPE........................................................................................................................................................................7
3. OUT OF SCOPE.......................................................................................................................................................7
4. EXISTING FUNCTIONALITY..............................................................................................................................7
6. TECHNICAL/OTHER SPECIFICATIONS........................................................................................................11
7. USER STORIES......................................................................................................................................................13
10. RISKS..................................................................................................................................................................52
12. ABBREVIATIONS.............................................................................................................................................54
2. Scope
This document covers below-mentioned journeys of API Based ERP Integration
Aggregator onboarding (offline process)
Post-login online onboarding process through yono business with Aggregator option
Token Managment in yono business (required for Aggregator model)
Online Branch Approval using YBBI
GITC approval using YBBI Portal
Transaction initiation in Aggregator ERP system using SBI’s APIs
Customer segment considered is CUG Corporates for Pilot, later all customers will be considered
Transaction initiation through API and Processing in CINB including authorization in case NON STP
is selected
3. Out of Scope
This section comprises the modules or functionalities that are not in scope from the delivery perspective
in the current release. These requirements are to be considered in subsequent phases of ERP journey
Other Customer segments: E-commerce players, Payment Gateways, Urban Cooperative Banks
(UCBs), Scheduled Commercial Banks (SCBs)
Any other items not listed explicitly under In Scope
4. Existing Functionality
N/A
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 7 of 60
Project Confidential
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 8 of 60
Project Confidential
5. Functional Specification/Proposed Solution
The ERP integration with SBI’s API Banking system will happen through developer portal-based registration
and API subscription. As a prerequisite, Corporate need to submit certain details required for enabling ERP
integration with SBI’s API Banking systems, Corporate will have to submit these details using yono business.
Once Corporate completes the onboarding process in yono business, post-approval by branch, Developer
portal will be enabled for the Corporates for registration and subscription for API.
Below are the prerequisite steps for API Banking.
For details, refer7.1 Post Login Onboarding User Stories, following list of User stories
US02_Postlogin_API Banking Tab View
US03_Postlogin Regulator Action
US04_Postlogin_Onboarding to API Banking
US05_Postlogin_Update Existing Information
US06_Postlogin_Check Application Status
US07_Postlogin UAT Completion
US08_Token Management (applicable for aggregator model only)
ACTIVE CHAR Y
INSERT_TS TIMESTAMP Y
UPDATE_TS TIMESTAMP N
UPDATE_BY TIMESTAMP N
Insert Script
Insert into SBI_YB_APIBNKNG_AGGRTR_MSTR
(AGGRTR_ID,AGGRTR_NAME,AGGRTR_EMAIL,TECH_DEPT_EMAIL,AGGRTR_DTLS,ACTIVE,INSERT_TS,UPDAT
E_TS,UPDATE_BY,UPDATE_COMMENTS) values ('1234','ABC
LTD',’xyz@abc.com’,'techitdept@abc.com',’Aggregator corporation for payment’,'Y',current
timestamp,null,null,null);
Type Master setup /Data setup Priority High Effort Estimate High
Process Flow Post login Tab View
Step1: Corporate User login to yono business
Step2: Corporate User selects API Banking menu
Step 3: Corporate User selects Onboard Now on API Banking page
System to do following validations for logged in Corporate user
Acceptance Please refer below table for validations performed for logged in Corporate user as per
category
Criteria
Type Master setup /Data setup Priority High Effort Estimate High
Process Flow Admin user selection
Step1: Regulator login to yono business
Step2: Regulator selects API Banking menu
API Banking landing page should be displayed
Step 3: Regulator user selects Onboard Now on API Banking page
“As a Regulator, you need to choose an Admin for API Banking Onboarding”
message should be displayed to Regulator along with a popup screen to select
Admin user
Step 4: Regulator user selects a Primary Admin from List of all Admin users
The system should allow Regulator to select Primary Admin and should display a
message “Do you want to select a secondary admin” with “Yes” and “No” options,
I. On selecting Yes, the system should display a list of Admin users and allow
the Regulator to select Secondary Admin.
II. If Regulator user selects No, Admin user list for selection of secondary admin
should not be displayed
Step 5: The regulator user selects a Secondary Admin from a List of Admin users.
The system should allow to select Secondary Admin and should give confirmation
message.
Step 6: Regulator user does not select secondary admin and continues to proceed
System should allow Regulator to submit details without selecting Secondary
Admin
Step 7: Process End
Acceptance Please refer below table for validations performed for the logged-in user as per category
Criteria
Scenario Expected Result
Regulator user for Vistaar corporate login API Banking page should be displayed
to yono and selects API Banking
Regulator user clicks on Onboard Now The system should display a message “As
button on API Banking page a Regulator, you need to select an
Administrator for API Banking Onboarding
“and should display a list of Admin users
for selection
Regulator user selects a Primary Admin The system should display a message” Do
and proceed you want to select a Secondary
Regulator user selects a Secondary Admin The system should allow to select
from List of Admin users Secondary Admin and should display a
confirmation message
Regulator user does not select any Admin The system should show API banking
user and clicks on Cancel landing page
Notes
Reference
Type Master setup /Data setup Priority High Effort Estimate High
Pre requisite Aggregator is successfully onboarded and available for selection
Process Flow Onboarding
Step1: Corporate Admin user login to yono business and select API Banking
menu
System to display API Banking landing page with below options
Onboard Now /Update Existing Application/ Check Status /UAT Completion/
Token Generation.
Step2: Admin User selects Onboard Now
1. System to check if Corporate already onboarded for API.
2. If found duplicate request, an error message “Your company has already
registered for API banking, please check the status for more details
“should be displayed
3. If not duplicate, System should allow Admin User to continue the
In the Transaction Details tab, Admin The system should give an error message
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 27 of 60
Project Confidential
User does not specify all mandatory “Please enter all mandatory details in all
details and moves to the next tab tabs “
In the Integration details tab, Admin User The system should not allow and should
does not upload a valid certificate give an error message, invalid certificate
(security certificate upload in txt, jpeg
format)
In the Integration details tab, Admin User The system should give an error message
does not specify all mandatory details “Please enter all mandatory details in all
and moves to next tab tabs “
In the preview page, Admin User clicks on System should redirect the user to the
back button Onboarding details tab and should allow
the user to update details in all tabs
In preview page, Admin User clicks on System should open a popup window
Terms & Condition link with Terms & Condition details
Admin User submit details without System should not allow the user to
selecting Terms & Conditions submit the details and should display an
error message as “Please select Terms &
Conditions”
Admin User enters all mandatory fields, 1. System should allow submitting details
selects Terms & Conditions and submit and should generate an onboarding
the onboarding request reference number
2. System should also generate an
omnibus document with options to
download/print /email
3. System should display a message
“Please visit your home branch for
approval”
Corporate user enters email id other than In case user enter an email id other than
registered email ID for sending the the registered email of the corporate,
omnibus document by email system to send a copy to the registered
email id along with the email id
mentioned
Reference
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 29 of 60
Project Confidential
7.1.5 US05_Postlogin_Update Existing Information
User Story US05_Update Existing Information in Post Login Journey
As a Corporate Admin, I should be able to update existing information for API Banking for my organization
post login to yono business
Type Master setup /Data setup Priority High Effort Estimate High
Process Flow Update Information
Step1: Corporate Admin login to yono business and select API Banking menu
System to display API Banking landing page with below options
Onboard Now /Update Existing Application/ Check Status /UAT Completion.
Step2: Admin User selects Update Existing Application
The system should display the Onboarding details tab and should allow Admin
User to update applicable values
Step3: Admin User edits Onboarding details
i. The system should not allow changing Technical team’s email address
ii. The system should allow to update the Technical team’s mobile number
and update API selection
Step4: Admin User edits Transaction details
Following details can be edited in the Transaction details tab
i. Transaction user details
Transaction Users can be disabled (soft delete) or Updated
ii. Debit Account Details
iii. Transaction Limit (Corporate limit)
Changes in transaction details will need updated BR and Omnibus document and
Branch approval
Step5: Admin User edits Integration details
Following technical integration details can be updated
i. IP & Port Details and Digital Certificate for UAT environment
ii. IP & Port Details and Digital Certificate for the Production environment
Change only in Integration details will require GITC Approval Branch approval and
Omnibus document is not required
Step6: Admin User enter all required information and select Proceed
Preview page displayed with Terms & Condition checkbox
Step7: Admin User clicks on Terms & Condition
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 30 of 60
Project Confidential
System to display Terms & Conditions in a pop-up window
Step8: Admin User checks Terms & Condition and Submit
System to check for all mandatory fields and if any of the mandatory fields are
not entered, display an appropriate error message
If all mandatory details are available, should allow Admin User to submit the
application and to display a new screen with following
i. The system generates Ref No and displays on the screen
ii. A message will be displayed “Please approach home branch for further
processing”
iii. The omnibus document will be generated with all information entered in
onboarding and should be available for download, print, and share over
email
Step9: End Process
Acceptance Please refer below table for validations performed for updating existing information
Criteria
Scenario Expected Result
Admin user for existing API banking System should display Onboarding details
customer selects Update Existing tab and should allow the user to edit,
Information Technical Team’s Mobile No, Update API
Selection
In Onboarding details, tab Admin User try Technical Team Email Address should be
to update Technical Team’s Email in a non-editable format
Address
Khata /Khataplus user checks available For Khata/Khataplus users only Enquiry
API’s API’s (Balance Enquiry API) should be
available
SARAL/Vyapaar /Vistar user checks For SARAL/Vyapaar/Vistar corporate
available API’s both Transaction and Enquiry API’s
should be available
In Onboarding details tab Admin User System should display one more option
selects Beneficiary Management API’s for selection “Validate Beneficiary at the
time of Transaction “with a checkbox for
selection
Admin User selects “Validate Beneficiary System should allow the user to select
at the time of Transaction “as Yes and should validate beneficiary details at
the time of transactions
Admin User selects “Validate Beneficiary System should allow the user to select
at the time of Transaction “as No and should not validate beneficiary
details at the time of transactions
In the Transaction Details tab, Admin System should allow the user to enter
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 31 of 60
Project Confidential
User add a new transaction user transaction user details (Name, PAN,
Mobile No, Email)
User details should be saved in the
Omnibus document.
The system should display an alert
message “Updated details will be
applicable post branch approval “
In Transaction details tab, User update System should display an alert message
corporate limit “Updated details will be applicable post
branch approval “
In the Transaction Details tab, Admin System should not allow and should give
User try to enter Corporate Limit more error message as “Corporate Limit
than Bank defined limit cannot be greater than Limit allowed by
Bank”
Admin User edits only integration details For updating only in Integration details
will need approval from GITC and branch
approval will not be required
Admin User enters all mandatory fields, 1. System should allow to submit details
selects Terms & Conditions and submit and should generate an onboarding
the onboarding request reference number
2. The system should also generate an
omnibus document with options to
download/print /email
3. System should display upload omnibus
document option
4. System should display a message
“Please visit your home branch for
approval”
Admin user has updated Transaction For Transaction level and API level detail
details and onboarding details like API changes, Corporate should submit
selection updated board resolution, Changes
should be effective post branch approval
Admin User download Omnibus System should allow to download
document Omnibus document
Type Master setup /Data setup Priority High Effort Estimate High
Process Flow Check Status
Step1: Corporate Admin User login to yono business and select API Banking
menu
System to display API Banking landing page with below options
Onboard Now /Update Existing Application/ Check Status /UAT Completion.
Step2: Admin User selects Check Status
System should display the Application Status page with below information
1. Application Status along with Date for the corporate which logged in
Admin belongs to
2. Download Omnibus Document
3. Print Omnibus Document
4. Email Omnibus Document
5. Resend Registration Email button
6. Upload signed Omnibus document
Step3: Admin User download Omnibus Document
The system should allow Admin User to download the omnibus document, the
downloaded document should be in PDF format by default
Step4: Admin User Print Omnibus Document
The system should allow Admin User to print the omnibus document
Step5: Admin User email Omnibus Document
The system should allow Admin User to specify email id for sending the Omnibus
document
In case user enter an email id other than the registered email of the corporate,
system to send a copy to the registered email id along with the email id
mentioned
Step6: Admin User selects Resend Registration Email button
The System should send an email to GITC user to resend the invitation email
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 33 of 60
Project Confidential
Step7: Admin User upload a signed omnibus document
The system should allow the user to upload a signed document in .pdf format
Step8: End Process
Acceptance Please refer below table for validations
Criteria
Scenario Expected Result
Admin User selects View Status The system should display API banking
Onboarding Application status for the
logged-in Admin User’s corporation
Admin User does not enter valid email The system should display an error
address and try to send the omnibus message “Please enter valid email
document address”
Application status is Approval Pending, Resend Registration Link button should
and Admin User tries to Resend be enabled only for Approved
Registration Link applications.
Admin User enter valid email address and i. The system should send the
try to send the omnibus document Omnibus document on the specified
email address.
ii. In case user enter an email id other
than the registered email of the
corporate, system to send a copy to
the registered email id along with
the email id mentioned
Notes
Reference
Type Master setup /Data setup Priority High Effort Estimate High
Process Flow UAT Completion
Step1: Corporate user (Admin and above) login to yono business and select API
Banking menu
System to display API Banking landing page with below options
Onboard Now /Update Existing Application/ Check Status /UAT Completion.
Step2: Admin User selects UAT Completion
System should UAT Completion page with below fields
1. Upload UAT Exit Report
2. Upload UAT Security Compliance Certificate
3. Production Details
4. Digital Certificate Upload
5. UAT User Comments
Step3: Admin User Upload UAT Exit Report
System should allow Admin User to upload UAT Exit Report, UAT exit report
should be in Template shared by bank, format should be .pdf
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 35 of 60
Project Confidential
Step4: Admin User Upload Security Compliance Certificate
System should allow Admin User to upload Security Compliance Certificate, this
certificate should be approved by permitted vendors
Step5: Admin User update Production Environment Details
System should display Production IP details if Admin User has entered while
doing onboarding and should allow to update.
In case Production IP details are not entered earlier, system should allow Admin
User to update
Step6: Admin User Upload Digital Certificate for Production environment
System should allow Admin User to upload Digital Certificate as per Standards
Step7: Admin User enters comments and submit details
System should display confirmation message and should generate reference
number
Step8: End Process
Acceptance Please refer below table for validations
Criteria
Scenario Expected Result
Admin User upload UAT exit report in System should not allow to upload and
incorrect format (.doc,.xls,.txt) should display error message “Invalid file
format”
Admin User upload UAT exit report in pdf System should allow to upload
format
Admin User does not enter production System should not allow to Submit
details and submit UAT Completion details and give error message
details “Mandatory details are not entered;
request cannot be saved”
Admin User update existing production System should allow Admin User to
environment details (Production update Production IP details
environment details in Onboarding)
Admin User submit UAT Completion System should allow to submit UAT
details Completion details, System should
generate and Reference Number and
should display confirmation message
with Reference Number
Details should be sent to GITC for
approval
Notes
Reference
Acceptance Please refer below table for validations performed for logged in user as per category
Criteria
Scenario Expected Result
Branch Maker selects “Manage Open API System should display Open request for
Banking Request” tab Maker’s branch
Branch Maker selects “View ALL API System should display All API Banking
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 40 of 60
Project Confidential
Banking Request” tab request for Maker’s branch
Branch Maker user search API Banking System should fetch search results as per
request by Corporate ID input criteria
Branch Maker user search API Banking System should fetch API Banking request
request by Reference Number matching with entered Reference
Number
On the Preview page, Branch maker does System should not allow Branch Maker to
not upload omnibus document and submit request for checker approval
approve request
On the Preview page, Branch maker does System should not allow Branch Maker to
not tick checklist for API Banking submit request for checker approval
onboarding request and approve
On the Preview page, Branch maker System should allow Branch Maker to
confirms checklist for API Banking submit request for checker approval
onboarding request and approve
Corporate type is UCB/SCB and corporate Branch maker should reject all API
submit API Banking onboarding request Banking onboarding requests for
following customer type
1. Non-Banking Finance Company
2. SCB
3. UCB
Notes 1. API Banking onboarding approval should be available in CMP OC HYD branch for CMP
Corporates.
2. Branch maker should be able to validate Corporate PAN (as part of O-auth
parameters) using NSDL interface/service (Existing functionality)
Reference 5.1.2 Branch Approval for onboarding (YBBI Approval)
Acceptance Please refer below table for validations performed for logged in user as per category
Criteria
Scenario Expected Result
Branch Checker selects “Manage Open System should display Open request for
API Banking Request” tab Checker’s branch
Branch Checker selects “View ALL API System should display All API Banking
Banking Request” tab request for Checker’s branch
Branch Checker search API Banking System should fetch API Banking request
request by Reference Number matching with entered reference number
Branch Checker user search API Banking System should fetch search results as per
request by Corporate ID input criteria
Branch checker rejects API Banking System should not allow to reject request
request without entering Reject Remarks without entering reject remarks
Notes Similar process of API Banking onboarding approval should be available in CMP OC HYD
branch for CMP Corporates.
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 43 of 60
Project Confidential
Reference 5.1.2 Branch Approval for onboarding (YBBI Approval)
Acceptance Please refer below table for validations performed for logged in user as per category
Criteria
Scenario Expected Result
GITC User selects “Manage Open API System should display Open request for
Banking Request” tab Maker’s branch
GITC User selects “View ALL API Banking System should display All API Banking
Request” tab request for Maker’s branch
GITC User search API Banking request by System should fetch search results as per
Corporate ID input criteria
GITC User search API Banking request by System should fetch API Banking request
Reference Number matching with entered Reference
Number
On the Preview page, GITC User does not System should not allow GITC User to
tick checklist for API Banking Onboarding approve request without confirming all
request and approve check list points
Notes For GITC approval, checker action is not required.
Reference 5.1.3 GITC Approval for onboarding (Technical Approval)
Acceptance Please refer below table for validations performed for logged in user as per category
Criteria
Scenario Expected Result
GITC User selects “Manage Open API System should display Open request for
Banking Request” tab Maker’s branch
Solution Document – Yono_Business_API-based ERP Integration Post Login Onboarding
Page 48 of 60
Project Confidential
GITC User selects “View ALL API Banking System should display All API Banking
Request” tab request for Maker’s branch
GITC User search API Banking request by System should fetch search results as per
Corporate ID input criteria
GITC User search API Banking request by System should fetch API Banking request
Reference Number matching with entered Reference
Number
GITC User downloads the UAT Exit Report System should allow to download UAT
uploaded by Corporate Exit Report
On the Preview page, GITC User does not System should not allow GITC User to
tick checklist for API Banking UAT submit request for checker approval
Completion request and approve
Notes For GITC approval, checker action is not required.
Reference 5.1.3 GITC Approval for onboarding (Technical Approval)
Acceptance Please refer below table for validations performed for logged in user as per category
Criteria
Scenario Expected Result
GITC user reject modification request System should not allow to submit
without entering reject remarks rejection without reject remarks
GITC User approves an IP change request API Banking platform should reject all
raised by Corporate incoming API’s from the old IP of Client
ERP and API’s coming from new /latest IP
should be considered for Processing
GITC User rejects an IP change request API Banking platform should reject all
raised by Corporate incoming API’s from the New IP of Client
ERP and API’s coming from old IP should
be considered for Processing
Notes 1. For GITC approval, checker action is not required .
For remaining acceptance criteria for Business validations for different payment
types, refer Supporting documents File Name: Phase 1 solution document (section
7 user stories)
Notes N/A
Reference
For service level parameter details for above services, please refer: Supporting documents
File Name: SBI API Banking_Aggregator Service Specification Document_V1.1