BSE StAR MF – WEBSERVICE STRUCTURE

Version 3.5
Aug 2023

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 0

 Table of Contents

Introduction to the WEB Services API Structure Document ............................................................................14

Going Live of your software for the BSE Mutual fund Segment ..................................................................14
Pre-Requisites ..............................................................................................................................................14
Infrastructure ...........................................................................................................................................14
Software ...................................................................................................................................................14
Access to Test Environment .....................................................................................................................14
Testing Tools ............................................................................................................................................14
Web Services APIs ....................................................................................................................................14
Understanding the Web Service API ................................................................................................................15
Common Fields and Nomenclature used in the Web Service API ...................................................................16
User ID:.....................................................................................................................................................16
Member ID: ..............................................................................................................................................16
Password: .................................................................................................................................................16
Passkey: ....................................................................................................................................................16
Client Code: ..............................................................................................................................................16
getPassword: ............................................................................................................................................16
Encrypted Password.................................................................................................................................16
Introduction to the Order Entry API ................................................................................................................18
MUTUAL FUND ORDER WEB SERVICE AUTHENTICATION MESSAGE STRUCTURE...........................................19
MF Order Web Service Authentication Details ............................................................................................19
Web Service Authentication Request ..........................................................................................................20
WSDL Definition .......................................................................................................................................20
Sample SOAP Request ..............................................................................................................................20
Web Service Authentication Request Response..........................................................................................21
WSDL Definition .......................................................................................................................................21
Sample SOAP Response ...........................................................................................................................21
Web Service Authentication Error ...............................................................................................................22
LUMPSUM PURCHASE & REDEMPTION ORDER ENTRY MESSAGE STRUCTURE ..............................................23
Introduction .................................................................................................................................................23

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 1

 LUMPSUM PURCHASE & REDEMPTION Order Entry Web Service Request ................................................23
WSDL Definition for Request ...................................................................................................................26
Web Service Order Entry Request Response ...............................................................................................27
WSDL Definition for Response .................................................................................................................27
Sample SOAP Request for Purchase ........................................................................................................28
Sample SOAP Response for Purchase ......................................................................................................29
Sample SOAP Request for Redemption ...................................................................................................30
Sample SOAP Response for Redemption .................................................................................................31
SIP MESSAGE STRUCTURE ................................................................................................................................32
Web Service SIP Request .............................................................................................................................32
Web Service SIP Request Response .............................................................................................................34
Sample SOAP Request for SIP ..................................................................................................................35
Sample SOAP Response for SIP ................................................................................................................36
XSIP/ISIP REQUEST MESSAGE STRUCTURE ......................................................................................................37
Web Service XSIP/ISIP Request ....................................................................................................................37
Web Service XSIP/ISIP Request Response ...................................................................................................39
Sample SOAP Request for XSIP ................................................................................................................40
Sample SOAP Response for XSIP ..............................................................................................................41
SPREAD ORDER REQUEST MESSAGE STRUCTURE (Overnight) ........................................................................42
Web Service SPREAD Order Request (Overnight) ........................................................................................42
Web Service SPREAD Order Request Response (Overnight) .......................................................................45
Sample SOAP Request for SPREAD ORDER ..............................................................................................46
Sample SOAP Response for SPREAD ORDER ............................................................................................47
SWITCH ORDER REQUEST MESSAGE STRUCTURE ...........................................................................................48
Web Service SWITCH Order Request ...........................................................................................................48
Web Service SWITCH Order Request Response...........................................................................................50
Sample SOAP Request for SWITCH ORDER ..............................................................................................51
Sample SOAP Response for SWITCH ORDER ............................................................................................52
MUTUAL FUND ADDITIONAL SERVICES AUTHENTICATION MESSAGE STRUCTURE ........................................54
MUTUAL FUND Additional Services Login Request .....................................................................................55
MUTUAL FUND Additional Services Login Request Response .....................................................................55
Notes ........................................................................................................................................................55

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 2

 MUTUAL FUND ADDITIONAL SERVICES MESSAGE STRUCTURE.......................................................................56
MUTUAL FUND Additional Services Request ...............................................................................................56
Notes ........................................................................................................................................................56
Values for Param in MUTUAL FUND Additional Services Request...........................................................57
FATCA UPLOAD ........................................................................................................................................58
UCC/CLIENT CREATION– MFD (Depreciated)...........................................................................................64
Payment Gateway Values (Depreciated) .................................................................................................64
CHANGE PASSWORD ................................................................................................................................64
UCC/CLIENT CREATION– MFI (Depreciated) ............................................................................................64
MANDATE REGISTRATION........................................................................................................................65
STP REGISTRATION (Depreciated – Legacy Use only use the Enhanced STP API) ...................................65
SWP REGISTRATION .................................................................................................................................66
STP CANCELLATION ( Depreciated Legacy use Only) ...............................................................................66
SWP CANCELLATION ................................................................................................................................66
CLIENT ORDER PAYMENT STATUS............................................................................................................67
CKYC UPLOAD (Depreciated) ...................................................................................................................67
SYSTEMATIC PLAN AUTHENTICATION (Registration/ Cancellation) (Depreciated) ................................67
ORDER REJECTION (Depreciated) ............................................................................................................67
MUTUAL FUND Additional Services Request Response ..............................................................................68
MANDATE REGISTRATION RESPONSE ......................................................................................................68
CLIENT ORDER PAYMENT RESPONSE STATUS ..........................................................................................68
StAR MF Enhanced UCC Registration Structure API for MFI & MFD Members ...............................................71
StAR MF Enhanced UCC Registration Structure API for MFI & MFD Members ...............................................71
API Structure Details ....................................................................................................................................71
Request Parameter : (JSON Format) .......................................................................................................71
Response Parameter : (JSON Format) .....................................................................................................71
MUTUAL FUND NEW ENHANCED UCC REGISTRATION WEBSERIVCE STRUCTURE ..........................................72
https://bsestarmfdemo.bseindia.com/StarMFCommonAPI/ClientMaster/Registration ................................72
New Client Registration ...............................................................................................................................72
Request Parameter (JSON Format) ..........................................................................................................72
Response Parameter (JSON Format)........................................................................................................72
New Client Modification/ Old Client UCC Upgrade .....................................................................................73

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 3

 Request Parameter (JSON Format) ..........................................................................................................73
Response Parameter (JSON Format)........................................................................................................73
MFI & MFD New Common Client Registration Parameter Structure ..............................................................74
NEW CLIENT Parameter Validations ................................................................................................................86
ACCOUNT TYPE ............................................................................................................................................86
CLIENT HOLDING ..........................................................................................................................................86
DIVIDEND PAYMODE....................................................................................................................................86
COMMUNICATION MODE ............................................................................................................................86
TAX STATUS WITH ACCOUNT TYPE ..............................................................................................................87
TAX STATUS ..................................................................................................................................................89
OCCUPATION CODE .....................................................................................................................................91
PAN EXEMPT CATEGORY ..............................................................................................................................91
COUNTRY CODE ...........................................................................................................................................92
STATES..........................................................................................................................................................99
MUTUAL FUND StAR MF ENHANCED STP REGISTRATION API MESSAGE STRUCTURE ..................................102
Introduction ...............................................................................................................................................102
StAR MF Enhanced STP Registration API Structure ..................................................................................103
Request Field Parameters: (Field Details) ..............................................................................................103
Response Field Parameters : (Field Details) ...........................................................................................104
StAR MF EXCHANGE & STP Registration and Cancellation API JSON Request & Response ......................105
NEW EXCHANGE STP REGISTRATION .........................................................................................................105
Request (JSON Format) ..........................................................................................................................105
NEW EXCHANGE STP CANCELLATION ........................................................................................................107
Request (JSON Format) ..........................................................................................................................107
NEW AMC STP REGISTRATION ...................................................................................................................109
Request (JSON Format) ..........................................................................................................................109
NEW AMC STP CANCELLATION ..................................................................................................................111
Request (JSON Format) ..........................................................................................................................111
MUTUAL FUND AOF IMAGE UPLOAD WEB SERVICES MESSAGE STRUCTURE ...............................................114
MUTUAL FUND AOF Image Upload Services Login Request ......................................................................114
Request Parameters...............................................................................................................................114
MUTUAL FUND AOF Image Upload Login Request Response ...................................................................114

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 4

 Response Parameters ............................................................................................................................114
Notes ......................................................................................................................................................115
MUTUAL FUND AOF IMAGE UPLOAD Services Login Request/Response Sample .....................................116
Sample Request (SOAP Format).............................................................................................................116
Sample Response (SOAP Format) ..........................................................................................................116
Sample Request (JSON Format) .............................................................................................................117
Sample Response (JSON Format) ...........................................................................................................117
MUTUAL FUND Image Upload Services Request .......................................................................................118
Request Parameters...............................................................................................................................118
MUTUAL FUND Image Upload Services Request Response .......................................................................118
Response Parameters ............................................................................................................................118
MUTUAL FUND AOF IMAGE UPLOAD Services Request/Response Sample ..............................................119
Sample Request (SOAP Format).............................................................................................................119
Sample Response (SOAP Format) ..........................................................................................................120
Sample Request (JSON Format) .............................................................................................................121
Sample Response (JSON Format) ...........................................................................................................121
MUTUAL FUND Image Upload Notice/ Naming Convention .....................................................................122
Notice Details .........................................................................................................................................122
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD WEBSERVICES MESSAGE STRUCTURE ............................124
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request ...............................................124
Request Parameters...............................................................................................................................124
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request Response ..............................124
Response Parameters ............................................................................................................................124
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request/Response Sample .................125
Sample Request (SOAP Format).............................................................................................................125
Sample Response (SOAP Format) ..........................................................................................................125
Sample Request (JSON Format) .............................................................................................................126
Sample Response (JSON Format) ...........................................................................................................126
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request ........................................................127
Request Parameters...............................................................................................................................127
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request Response ........................................127
Response Parameters ............................................................................................................................127

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 5

 Values for Utility Code & Sponsor Bank Code .......................................................................................127
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Service Request/Response Sample ............................128
Sample Request (SOAP Format).............................................................................................................128
Sample Response (SOAP Format) ..........................................................................................................129
Sample Request (JSON Format) .............................................................................................................130
Sample Response (JSON Format) ...........................................................................................................130
MUTUAL FUND Scan Image Upload Notice for Naming Convention & Format ........................................131
Notice Details .........................................................................................................................................131
MUTUAL FUND DIRECT PAYMENT GATEWAY MESSAGE STRUCTURE (Depreciated – Legacy Use only use the
Single Payment Gateway API) ........................................................................................................................133
Description: ................................................................................................................................................133
Sample structure ........................................................................................................................................134
DIRECT PAYMENT GATEWAY Authentication ................................................................................................135
MUTUAL FUND DIRECT PAYMENT GATEWAY Authentication Request ....................................................135
MUTUAL FUND DIRECT PAYMENT GATEWAY Authentication Request Response ....................................135
Notes ......................................................................................................................................................135
DIRECT PAYMENT GATEWAY URL Request ....................................................................................................136
MUTUAL FUND DIRECT PAYMENT GATEWAY URL Request ......................................................................136
MUTUAL FUND DIRECT PAYMENT GATEWAY URL Request Response ......................................................136
ERROR CODES ............................................................................................................................................137
MUTUAL FUND CHILD ORDER WEB SERVICES MESSAGE STRUCTURE ..........................................................139
MUTUAL FUND Child Order Services Login Request .................................................................................139
REQUEST STRUCTURE ................................................................................................................................139
MUTUAL FUND Child Order Login Request Response ...............................................................................139
RESPONSE STRUCTURE ..............................................................................................................................139
Notes ......................................................................................................................................................140
MUTUAL FUND Child Order Login Request/Response Sample ..................................................................140
REQUEST PARAMETER (JSON Format) ..................................................................................................140
RESPONSE PARAMTER (JSON Format) ...................................................................................................140
MUTUAL FUND Child Order Services Request ...........................................................................................141
REQUEST STRCUTURE ................................................................................................................................141
RESPONSE STRUCTURE ..............................................................................................................................141

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 6

 MUTUAL FUND Child Order Services Request/Response Sample .............................................................142
REQUEST PARAMETER (JSON Format) ..................................................................................................142
RESPONSE PARAMETER (JSON Format) .................................................................................................142
MUTUAL FUND MANDATE STATUS WEB SERVICES AUTHENTICATION MESSAGE STRUCTURE ....................145
MUTUAL FUND Mandate Status Services Login Request ..........................................................................145
REQUEST STRUCTURE ............................................................................................................................145
MUTUAL FUND Mandate Status Login Request Response ........................................................................145
RESPONSE STRUCTURE ..........................................................................................................................145
MUTUAL FUND Mandate Status Login Request/Response Sample ..........................................................146
REQUEST PARAMETER (JSON Format) ..................................................................................................146
RESPONSE PARAMETER (JSON Format) .................................................................................................146
MUTUAL FUND MANDATE STATUS WEB SERVICES MESSAGE STRUCTURE ..................................................147
MUTUAL FUND Mandate Status Services Request ....................................................................................147
REQUEST STRUCTURE ............................................................................................................................147
MUTUAL FUND Mandate Status Services Request Response ...................................................................147
RESPONSE STRUCTURE ..........................................................................................................................147
Status Table............................................................................................................................................148
MUTUAL FUND Mandate Status Service Request/Response Sample........................................................149
REQUEST PARAMETER (JSON Format) ..................................................................................................149
RESPONSE PARAMETER (JSON Format) .................................................................................................149
MUTUAL FUND Mandate Status Service Request/Response Error Codes.................................................150
- MUTUAL FUND PROVISIONAL ORDER MESSAGE STRUCTURE ....................................................................152
This API has been DEPRECIATED and is no longer Available .....................................................................152
MUTUAL FUND ORDER STATUS REPORT MESSAGE STRUCTURE ..................................................................152
MUTUAL FUND Order Status Services Request .........................................................................................152
Request parameters...............................................................................................................................152
MUTUAL FUND Order Status Request Response .......................................................................................153
Parameters .............................................................................................................................................153
ERROR CODES.........................................................................................................................................155
MUTUAL FUND ALLOTMENT STATEMENT MESSAGE STRUCTURE ................................................................156
MUTUAL FUND Allotment Statement Services Request............................................................................156
Request parameters...............................................................................................................................156

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 7

 MUTUAL FUND Allotment Statement Request Response .........................................................................157
Parameters .............................................................................................................................................157
ERROR CODES.........................................................................................................................................159
MUTUAL FUND REDEMPTION STATEMENT MESSAGE STRUCTURE ..............................................................160
MUTUAL FUND Redemption Statement Services Request ........................................................................160
Request parameters...............................................................................................................................160
MUTUAL FUND Redemption Statement Request Response .....................................................................161
Parameters .............................................................................................................................................161
ERROR CODES.........................................................................................................................................163
MUTUAL FUND e-NACH MANDATE AUTHENTICATION URL WEB SERVICES AUTHENTICATION MESSAGE
STRUCTURE ....................................................................................................................................................165
MUTUAL FUND e-NACH Mandate Authentication URL Services Request .................................................165
Request parameters (JSON Format) ......................................................................................................165
MUTUAL FUND e-NACH Mandate Authentication URL Response.............................................................165
Response Parameter ..............................................................................................................................165
Sample Code ..............................................................................................................................................166
Error Codes ................................................................................................................................................166
MUTUAL FUND MANDATE SHIFT WEB SERVICES AUTHENTICATION MESSAGE STRUCTURE .......................168
MUTUAL FUND e-NACH Mandate Authentication URL Services Request .................................................168
Request Parameter ................................................................................................................................168
Response Structure ................................................................................................................................169
Sample Code ..............................................................................................................................................169
MUTUAL FUND AXIS BANK CHEQUE COLLECTION WEB SERVICES AUTHENTICATION MESSAGE STRUCTURE
.......................................................................................................................................................................171
Cheque Collection API URL ........................................................................................................................171
Cheque Collection API Flow .......................................................................................................................171
Member Cheque Collection Entry – Website ............................................................................................172
Member Cheque Collection Entry – API ....................................................................................................172
Request ..................................................................................................................................................172
Member Cheque Collection Deposit Challan Creation Entry – Website (PDF File Download) ..................174
Member Cheque Collection Deposit Challan Creation Entry – API (PDF File Download) ..........................174
Request Parameter ................................................................................................................................174

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 8

 Response Parameter ..............................................................................................................................175
Sample Code ..............................................................................................................................................175
Member Cheque Collection Deposit Challan Generation Entry – Website ...............................................176
Member Cheque Collection Deposit Challan Generation Entry – API .......................................................176
Request Parameter ................................................................................................................................176
Response Parameter ..............................................................................................................................176
Sample Code ..............................................................................................................................................177
SINGLE INTEGRATED PAYMENT WEBSERVICE MESSAGE STRUCTURE THROUGH API FOR ALL PAYMENT
METHODS .......................................................................................................................................................179
Structure for Single Payment API Interface ...............................................................................................179
Request Parameter ................................................................................................................................179
Response ................................................................................................................................................180
Sample Code ..............................................................................................................................................181
Request : ................................................................................................................................................181
Response : ..............................................................................................................................................181
NET BANKING BANK CODES ...........................................................................................................................182
UPI BANK CODES ............................................................................................................................................185
MUTUAL FUND CHEQUE IMAGE UPLOAD API WEB SERVICE MESSAGE STRUCTURE FOR NRI MINOR .........189
Method 1 : ImageUploadBase64 ...............................................................................................................189
Request Parameter : (JSON Format) .....................................................................................................189
Response Parameter : (JSON Format) ...................................................................................................189
Method 2 : ImageUploadByte ....................................................................................................................190
Request Parameter : (JSON Format) .....................................................................................................190
Response Parameter : (JSON Format) ...................................................................................................190
API Methods Name : ..............................................................................................................................191
Request Parameter : (JSON Format) .....................................................................................................191
Response (JSON Format) ........................................................................................................................191
Request Parameter : (JSON Format) .....................................................................................................192
Response Parameter : (JSON Format) ....................................................................................................192
MUTUAL FUND SIP XSIP PAUSE API WEB SERVICE MESSAGE STRUCTURE....................................................194
Request Parameter : (JSON Format) .....................................................................................................194
Response Parameter : (JSON Format) ...................................................................................................194

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 9

 Pause SIP/ XSIP API JSON Request & Response Example ..........................................................................195
Request (JSON Format) ..........................................................................................................................195
MUTUAL FUND SIP TO XSIP SHIFT API WEB SERVICE MESSAGE STRUCTURE ................................................197
REQUEST STRUCTURE ....................................................................................................................................197
RESPONSE STRUCTURE ..................................................................................................................................197
SAMPLE CODE ............................................................................................................................................198
Request Details : (JSON) .........................................................................................................................198
Response Details : (JSON ) .....................................................................................................................198
Additional Resources .....................................................................................................................................199
STANDARD ERROR CODES..............................................................................................................................200
GET PASSWORD .........................................................................................................................................200
MFAPI .........................................................................................................................................................201
MUTUAL FUND REDEMPTION TWO FATOR AUTHENTICATION API WEB SERVICE MESSAGE STRUCTURE ...203
Introduction ...................................................................................................................................................203
Overview ....................................................................................................................................................203
Technology .................................................................................................................................................203
Structure for Redemption 2FA Authentication API ...................................................................................204
REQUEST STRUCTURE ............................................................................................................................204
RESPONSE STRUCTURE ..........................................................................................................................204
Sample Code ..............................................................................................................................................205
Request (Json): .......................................................................................................................................205
Response (Json) :....................................................................................................................................205
MUTUAL FUND SUBSCRIPTION TWO FATOR AUTHENTICATION API WEB SERVICE MESSAGE STRUCTURE .207
Introduction ...................................................................................................................................................207
Overview ....................................................................................................................................................207
Technology .................................................................................................................................................207
Message Flow.............................................................................................................................................207
Structure for 2FA Authentication API ........................................................................................................208
Request Parameter ....................................................................................................................................208
Response Parameter ..............................................................................................................................209
Post Data to be Submitted to the Response Parameter ........................................................................209
Sample Code ..............................................................................................................................................211

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 10

 Request (JSON).......................................................................................................................................211
Response (JSON) ....................................................................................................................................211
Post Data to Post URL on Client Journey Completion........................................................................211
MUTUAL FUND NOMINATION API WEB SERVICE MESSAGE STRUCTURE .....................................................213
Introduction ...................................................................................................................................................213
MUTUAL FUND NOMINEE REGISTRATION API WEBSERVICE MESSAGE STRUCTURE ....................................214
NOMINEE REGISTRATION STRUCTURE ......................................................................................................214
Nomination Registration API URL ..............................................................................................................214
REQUEST PARAMETER (JSON FORMAT) ................................................................................................214
Individual Records of ‘Param’ field of Request Parameter ....................................................................215
REQUEST RESPONSE PARAMETER (JSON FORMAT)...............................................................................217
Individual Records of ‘ErrorMessage’ field of Request Response Parameter........................................218
BSE StAR MF NOMINATION REGISTRATION API JSON Request & Response .................................................219
Nominee Registration JSON Request & Response (Sample Format) .........................................................219
REQUEST PARAMETER .......................................................................................................................219
RESPONSE PARAMETER .....................................................................................................................220
REQUEST PARAMETER .......................................................................................................................221
RESPONSE PARAMETER .....................................................................................................................222
Nominee Modification JSON Request & Response (Sample Format) ........................................................223
REQUEST PARAMETER .......................................................................................................................223
RESPONSE PARAMETER .....................................................................................................................223
REQUEST PARAMETER .......................................................................................................................224
RESPONSE PARAMETER .....................................................................................................................225
BSE StAR MF NOMINEE IMAGE UPLOAD WEBSERVICE API MESSAGE STURCTURE ......................................226
NOMINEE IMAGE UPLOAD STRUCTURE.....................................................................................................226
Nomination Image Upload API URL ...........................................................................................................226
REQUEST PARAMETER (JSON FORMAT) ................................................................................................226
RESPONSE PARAMETER (JSON FORMAT)...............................................................................................227
BSE StAR MF NOMINEE IMAGE UPLOAD API JSON Request & Response .....................................................227
Nominee Image upload JSON Request & Response - BASE_64 (Sample Format) .....................................227
REQUEST PARAMETER .......................................................................................................................227
RESPONSE PARAMETER .....................................................................................................................228

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 11

 BSE StAR MF NOMINEE 2FA API WEBSERVICE MESSAGE STRUCTURE ..........................................................229
NOMINEE 2FA STRUCTURE ........................................................................................................................229
Nomination 2FA API URL............................................................................................................................229
REQUEST PARAMETER (JSON FORMAT) ................................................................................................229
RESPONSE PARAMETER (JSON FORMAT)...............................................................................................230
BSE StAR MF NOMINEE 2FA API JSON Request & Response .........................................................................231
Nominee 2FA API JSON Request & Response (Sample Format) ................................................................231
REQUEST PARAMETER .......................................................................................................................231
MUTUAL FUND COMBINED UCC- NOMINATION REGISTRATION API WEBSERVICE STRUCTURE ..................233
Request Parameter (Json Format) .............................................................................................................233
Response Parameter (Json Format) ...........................................................................................................241
SAMPLE JSON FORMAT (New Registration)...............................................................................................241
Request Parameter ................................................................................................................................241
Response Parameter ..............................................................................................................................242
SAMPLE JSON FORMAT (Modification) ......................................................................................................242
Request Parameter ................................................................................................................................242
Response Parameter ..............................................................................................................................242
MUTUAL FUND ENHANCED SIP & XSIP REGISTRATION API WEBSERVICE MESSAGE STRUCTURE ................244
ENHANCED SIP REGISTRATION API STRUCTURE ........................................................................................244
Request Field Parameters: (Field Details) ..........................................................................................244
Goal Type .......................................................................................................................................246
Response Field Parameters: (Field Details)........................................................................................246
StAR MF Enhanced SIP Registration Structure API JSON Request & Response .....................................247
Request (JSON Format) ......................................................................................................................247
StAR MF ENAHNCED SIP CANCELLATION API STRUCTURE ........................................................................249
Request Field Parameters: (Field Details) ..........................................................................................249
Response Field Parameters: (Field Details)........................................................................................249
StAR MF Enhanced SIP Cancellation Structure API JSON Request & Response.....................................250
StAR MF ENHANCED XSIP REGISTRATION API STRUCTURE .......................................................................251
Request Field Parameters: (Field Details) ..........................................................................................251
GOAL TYPE......................................................................................................................................253
Response Field Parameters: (Field Details)........................................................................................254

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 12

 StAR MF Enhanced XSIP Registration Structure API JSON Request & Response .................................255
Request (JSON Format) ......................................................................................................................255
Response (JSON Format) ....................................................................................................................256
StAR MF ENHANCED XSIP CANCELLATION API STRUCTURE ......................................................................257
Request Field Parameters: (Field Details) ..........................................................................................257
Response Field Parameters: (Field Details)........................................................................................257
StAR MF Enhanced XSIP Cancellation Structure API JSON Request & Response ..................................258
Configuring Postman for Testing API .............................................................................................................259
Create a New POST Request in Postman ...........................................................................................259
Enter the URL in the Postman Request URL ......................................................................................259
1) Adding key in Authorization Tab....................................................................................................260
2)Adding the API Key manually in Headers........................................................................................260
Adding the JSON parameters in the Body..........................................................................................261
REVISION HISTORY .........................................................................................................................................262
Revision 3.5 ................................................................................................................................................262
Revision 3.1 ................................................................................................................................................263
Revision 3.0 ................................................................................................................................................264
Revision 2.1 ................................................................................................................................................265
Revision 2.0 ................................................................................................................................................265
Revision 1.9 ................................................................................................................................................265
Revision 1.8 ................................................................................................................................................266
Revision 1.7 ................................................................................................................................................266
Revision 1.6 ................................................................................................................................................266
Revision 1.5 ................................................................................................................................................266
Revision 1.4 ................................................................................................................................................266
Revision 1.3 ................................................................................................................................................266
Revision 1.2 ................................................................................................................................................267
Revision 1.1 ................................................................................................................................................267

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 13

 Introduction to the WEB Services API Structure Document

BSE StAR MF Mutual Fund Platform provides Web Services based Order routing services and Additional
Services for all Mutual Fund Intermediaries (MFIs)/Mutual Fund Distributors (MFDs) / Vendors / Application
Solution Providers (ASP Vendors) using third party vendor solutions and/or in-house developed trading
applications over the Internet

Going Live of your software for the BSE Mutual fund Segment
The following steps are needed to be taken.
1. Member can receive the API documents and request for Test Market credentials by sending mail
with their existing Live BSE StAR MF Member ID.
2. Develop your own software using the BSE StAR MF Test Market.
3. Once ready request the Exchange for a demo of the product to be conducted in the Test Market.
4. Once Demo is given and product is confirmed member shall receive the Live API links.
5. Member can integrate the Live API links within their product and go live.

Pre-Requisites
Infrastructure
The BSE StAR MF Webservices is used over the Internet to connect from the Member/ Vendor Server to the
BSE StAR MF server. Members /Vendors can utilize their existing Internet Connectivity for using the
Webservices, however It is recommended to have dedicated bandwidth and low latency connectivity.

Software
Any language that has support for a SOAP based Library (SOAP Ver 1.2) can be used in development for using
the Web Services API.

Access to Test Environment

BSE Provides a Test Environment to its members for testing, development and Integration of their Products
using the BSE StAR MF Web Services API. If the Member/Vendor desires access for the same, he can send a
mail requesting access to [email protected] or [email protected] with his BSE StAR MF
Member ID.

Testing Tools
It is recommended to use SOAPUI (Open-Source Version) available at https://www.soapui.org/ for testing
the Web Services API. It is also possible to use POSTMAN for testing however it will require manual crafting
of the XML SOAP requests which is done automatically by SOAPUI.

Web Services APIs

The WEB SERVICE API is an ASP.NET XML based service using SOAP which is language agnostic and can be
called by any language having SOAP 1.2 libraries.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 14

 Understanding the Web Service API

• All Web Services are separated in their own sections based on their own Authentication mechanism.
• All APIs require a Session ID /Encrypted Password to be generated by the Authentication method
before calling the actual API eg. getPassword method for Order API
• Each Section has the API web service link for the API provided in the Introduction or start of the
sections.
• For each web service on opening the API Link Members are given two links for WSDL definition,
Members have to use the ?singleWsdl link to generate the Methods for their language if required
eg. .NET, Java etc..

• Please use the /Secure Endpoint as given in the WSDL definition for all communication as it uses
HTTPS.

• If you are using a SOAP library to connect to the Web Service kindly ensure that you are targeting
the correct Service and the HTTPS endpoint (/Secure) eg given in the Web Service ?singleWsdl
configuration. In this case ‘MFOrder’ and ‘ WSHttpBinding_MFOrderEntry1’
• All API Table Descriptions are given in the same order as the module definitions given in the WSDL
method for the given API
• Methods are given along with the API Structure with the snapshot of the relevant in the API Sample
requests and Response are provided in the Member

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 15

 Common Fields and Nomenclature used in the Web Service API

User ID:
Login ID/ User ID /Web Service ID is the Main ID which is used for Login along with the Member ID. This is
provided by the Exchange for the API.

Member ID:
Member ID/ Member Code is assigned to the member on registration with the Exchange. This is not the
ARN Code.

Password:
The Password which is provided for User ID/ Login ID.

Passkey:
The Passkey is any random Alphanumeric string used to increase the session Entropy when creating the
Encrypted Password / Session ID

Client Code:
The Client for which the transaction or service has to be invoked.

getPassword:
The Authentication method that is used to establish a session for the additional requests. The validity for
the Encrypted Password /Session ID generated is 1 hour for MFOrder.svc and 5 minutes for the rest.

Note: This is not required in methods in which authentication is built-in

Encrypted Password
This is the session ID to be used after being generated through the getPassword method to authenticate
the session.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 16

 MUTUAL FUND ORDER ENTRY REQUEST
AND RESPONSE SERVICES MESSAGE
STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 17

 Introduction to the Order Entry API

NOTE : This section contains a SOAP Only service

The Order Entry API exposes the Order Entry functionality through which members/vendors can enter
Orders through API into the BSE StAR MF System.

The Web Service through which order entry and response can be facilitated is available at.

URL https://bsestarmfdemo.bseindia.com/MFOrderEntry/MFOrder.svc

This Order Entry API Document Section contains Message Structures for

1) Login Entry
2) Login Response
3) Normal Order Entry
4) Normal Order Entry Response
5) SIP Order Entry
6) SIP Order Entry Response
7) X-SIP Order Entry
8) X-SIP Order Entry Response
9) Spread Order Entry
10) Spread Order Entry Response
11) Switch Order Entry
12) Switch Order Entry Response

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 18

 MUTUAL FUND ORDER WEB SERVICE AUTHENTICATION MESSAGE
STRUCTURE

MF Order Web Service Authentication Details

1. The Session Validity for MFOrder.svc Service is 1 Hour for all other services it is 5 minutes
2. Member session has to be Authenticated before sending any messages
3. Pass Key Validity can be Time based or One Time.
4. Member will have to enter the Web Service ID and password provided to them with a pass key (Alpha
numeric with no special characters) each time they login.
5. Pass key can be different each time they login
6. Once user provides all the above / required details and submits it the Exchange, a response code will
be sent to the member.
7. If the login is successful then response code “100” will be sent and after pipe an encrypted password
will be sent to the member.
8. If the login is not successful then response code “101” will be sent.
9. This encrypted password will be unique each time the member logins into BSE web service.
10. Member has to use this encrypted password whenever they punch the order.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 19

 Web Service Authentication Request
The Method used for order Entry is getPassword

Parameter Mandatory /
Type Length Description Sample Values
Name Non Mandatory
User ID Varchar 5 Login ID for Web Service 0123 Mandatory
Password Varchar 20 Password for the Login ID mf@abc Mandatory
Random Alphanumeric value
Pass Key Varchar 10 entered by member used for abcdef1234 Mandatory
Entropy

WSDL Definition

Sample SOAP Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:bses="http://bsestarmf.in/">

<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://bsestarmf.in/MFOrderEntry/getPassword</wsa:Action>
<wsa:To>
https://bsestarmfdemo.bseindia.com/MFOrderEntry/MFOrder.svc/Secure
</wsa:To>
</soap:Header>
<soap:Body>
<bses:getPassword>
<bses:UserId>{{LoginID}}</bses:UserId>
<bses:Password>{{Password}}</bses:Password>
<bses:PassKey>{{Passkey}}</bses:PassKey>
</bses:getPassword>
</soap:Body>
</soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 20

 Web Service Authentication Request Response
The Method used for order Entry is getPasswordResponse

Response Type Length Description Sample Values

100 - Success
Response Code Varchar 3 Request Response
101 - Invalid

Encrypted Password Varchar 250 Encrypted password

WSDL Definition

Sample SOAP Response

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action
s:mustUnderstand="1">http://bsestarmf.in/MFOrderEntry/getPasswordResponse</a:Action>
</s:Header>
<s:Body>
<getPasswordResponse xmlns="http://bsestarmf.in/">

<getPasswordResult>100|UWQ/yLAS7KmiHyExtsKKq3DuHTWuyGOzy0P4s38PSL8nA==</getPasswordResult>
</getPasswordResponse>
</s:Body>
</s:Envelope>

Structure : Response Code |Encrypted Password (Session ID)

Sample : 100|UWQ/yLAS7KmiHyExtsKKq3DuHTWuyGOzy0P4s38PSL8nA==

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 21

 Web Service Authentication Error

ERROR MESSAGES DESCRIPTION

USER ID SHOULD NOT BE BLANK Blank value in user Id field
MEMBER ID SHOULD NOT BE BLANK Blank value in member Id field
PASSWORD SHOULD NOT BE BLANK Blank value in password field
PASSKEY SHOULD NOT BE BLANK Blank value in passkey field
USER IS DISABLED. CONTACT ADMIN User is blocked or disabled
YOU HAVE EXCEEDED MAXIMUM LOGIN
ATTEMPTS. CONTACT ADMIN User has entered wrong password more than 5 times
INVALID ACCOUNT INFORMATION Incorrect Login details
INVALID USER ID Incorrect Login ID
THE MEMBER IS SUSPENDED. CONTACT
ADMIN when the given member is blocked or inactive
THE BRANCH IS SUSPENDED. CONTACT
ADMIN when the given member branch is blocked or inactive]
ACCESS TEMPORARILY SUSPENDED. KINDLY
BEAR WITH US when forced login is "YES"
PASSWORD EXPIRED when the user password has expired
USER NOT EXISTS when user doesn't pass proper login details

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 22

 LUMPSUM PURCHASE & REDEMPTION ORDER ENTRY MESSAGE
STRUCTURE
Introduction

• Lumpsum transactions in StAR MF are Single Investments in a Mutual Fund Asset.

• For a new Lumpsum transaction NEW has to be sent. Modification/ Cancellation is no longer
available due to real-time integration with RTA. (FIELD: TRANSCODE)
• A unique no has to be sent for each request, this has to be unique even if the request is rejected.
(FIELD: TRANSNO)
• The Order ID is generated by the Exchange so it is kept blank for new order requests. (FIELD: ORDERID)
• Lumpsum can be Purchased or Redeemed (FIELD: BUYSELL)
• On Purchase the Mutual Fund Investments are received as Units, These units can be received as
Physical or in an Demat Account. (FIELD: BUYSELL)

LUMPSUM PURCHASE & REDEMPTION Order Entry Web Service Request

The Method used for order Entry is orderEntryParam

Parameter
Type Length Description Sample Values Mandatory
Name
Order : New/
Transaction
varchar 3 Modification/ NEW/MOD/CXL Mandatory
code
Cancellation
Unique reference number
from the member.
Number can be
Transaction YYYYMMDD<memberid
varchar 19 incremental for each Mandatory
Number >000001
order(000001,
000002,….). The number
will be reset the next day.
BSE unique order
number, for new order
this field will be blank Non-
OrderId bigint 8 and incase of Mandatory/
modification and Mandatory
cancellation the order
number has to be given
UserID bigint 5 User ID as given by BSE Mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 23

 Member code as given by
MemberId varchar 20 Mandatory
BSE
ClientCode varchar 20 Client Code Mandatory
BSE scheme code
SchemeCd varchar 20 available from BSE Mandatory
Scheme Code Master
Type of transaction i.e.
BuySell varchar 1 P/R Mandatory
Purchase or Redemption
Buy/Sell type i.e. Fresh
BuySellType varchar 10 Folio or Additional in FRESH/ADDITIONAL Mandatory
existing Folio
DPTxn varchar 10 CDSL/NSDL/PHYSICAL C/N/P Mandatory
Purchase/Redemption
amount (redemption Either Amount
AMOUNT money 14
amount only in case of Or Qty
physical redemption)
Either Amount
Qty money 8 Redemption quantity
Or Qty
All units flag, If this Flag is
"Y" then units and
AllRedeem varchar 1 Y/N Mandatory
amount column should
be blank
Incase Demat transaction
this field will be blank
and mandatory in case of For Physical
FolioNo varchar 20
physical redemption and Additional
physical purchase +
additional
Non-
Remarks varchar 255
Mandatory
KYCStatus varchar 1 KYC status of client Y/N Mandatory
Internal reference Non-
RefNo varchar 20
number Mandatory
Non-
SubBrCode varchar 15 Sub Broker code
Mandatory
EUIN varchar 20 EUIN number Mandatory
EUIN flag varchar 1 EUIN declaration Y/N Mandatory
Minimum redemption
MinRedeem varchar 1 Y/N Mandatory
flag
DPC flag for purchase
DPC varchar 1 Y Mandatory
transactions

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 24

 IPAdd varchar 20
Password varchar 250 Encrypted password Mandatory
Pass Key varchar 10 Mandatory
Param1 (Sub Filler 1 Will Be Used As Non-
varchar 20
Broker ARN) Sub Broker ARN Code Mandatory
Param2 (PG
Purchase Only, Used for Non-
Reference varchar 25
Funds Mapping Mandatory
No)
Redemption Only, to
Param3 Mandatory
choose the account in
(Bank varchar 20 For
which the Funds are
Account No) Redemption
redeemed to.
10 Digit Indian Mobile No Non-
Mobile No varchar 10
used for verification Mandatory
Email ID of the Client Non-
Email ID varchar 50
used for verification Mandatory
Only for Purchase, for Non-
Mandate ID varchar 10
OTM Mandatory
Filler 1 varchar 30
Filler 2 varchar 30
Filler 3 varchar 30
Filler 4 varchar 30
Filler 5 varchar 30
Filler 6 varchar 30

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 25

 WSDL Definition for Request

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 26

 Web Service Order Entry Request Response
The Method used for order Entry is orderEntryParamResponse

Parameter Name Type Length Description Sample values

Transaction
Code as given
Transaction code varchar 3 in the request

Unique
reference
number as
Unique Reference given in the
number varchar 19 request YYYYMMDD<memberid>000001

BSE order
number will be
given in this
Order number bigint 8 field
User ID as
UserID bigint 5 given by BSE
Member code
MemberId varchar 20 as given by BSE
ClientCode varchar 20 Client Code
Bse Response
BSE remarks varchar 1000 Return remarks
Order success
Success flag varchar 1 flag

WSDL Definition for Response

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 27

 Sample SOAP Request for Purchase

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:bses="http://bsestarmf.in/"><soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://bsestarmf.in/MFOrderEntry/orderEntryParam</wsa:Action><wsa:To>https://bsestarmfdemo
.bseindia.com/MFOrderEntry/MFOrder.svc/Secure</wsa:To></soap:Header>
<soap:Body><bses:orderEntryParam>
<bses:TransCode>NEW</bses:TransCode>
<bses:TransNo>202202181234000002</bses:TransNo>
<bses:OrderId/>
<bses:UserID>123401</bses:UserID>
<bses:MemberId>1234</bses:MemberId>
<bses:ClientCode>clientcode01</bses:ClientCode>
<bses:SchemeCd>02-DP</bses:SchemeCd>
<bses:BuySell>P</bses:BuySell>
<bses:BuySellType>FRESH</bses:BuySellType>
<bses:DPTxn>P</bses:DPTxn>
<bses:OrderVal>500</bses:OrderVal>
<bses:Qty/>
<bses:AllRedeem>N</bses:AllRedeem>
<bses:FolioNo/>
<bses:Remarks/>
<bses:KYCStatus>Y</bses:KYCStatus>
<bses:RefNo/>
<bses:SubBrCode/>
<bses:EUIN/>
<bses:EUINVal>N</bses:EUINVal>
<bses:MinRedeem>N</bses:MinRedeem>
<bses:DPC>Y</bses:DPC>
<bses:IPAdd/>
<bses:Password>UWQ/yLAS7KmiHyExtsKKq3DuHTWuyGOzy0P4s38PSL8nA==</bses:Password>
<bses:PassKey>abc123</bses:PassKey>
<bses:Parma1/>
<bses:Param2/>
<bses:Param3/>
<bses:MobileNo/>
<bses:EmailID/>
<bses:MandateID/>
<bses:Filler1/>
<bses:Filler2/>
<bses:Filler3/>
<bses:Filler4/>
<bses:Filler5/>
<bses:Filler6/>
</bses:orderEntryParam></soap:Body>
</soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 28

 Sample SOAP Response for Purchase

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://bsestarmf.in/MFOrderEntry/orderEntryParamResponse</a:Action>
</s:Header>
<s:Body>
<orderEntryParamResponse xmlns="http://bsestarmf.in/">
<orderEntryParamResult>NEW|202202181234000002|7531973|123401|1234|clientcode01|ORD CONF:
Your Request for FRESH PURCHASE 500.000 in SCHEME: 02-DP THRO : PHYSICAL is confirmed for CLIENT :
clientname (Code: clientcode01) CONFIRMATION TIME: Jun 2 2022 11:15AM ENTRY BY: ORDER NO: 7531973|0
</orderEntryParamResult>
</orderEntryParamResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 29

 Sample SOAP Request for Redemption

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:bses="http://bsestarmf.in/">

<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"><wsa:Action>http://bsestarmf.in/
MFOrderEntry/orderEntryParam</wsa:Action><wsa:To>https://bsestarmfdemo.bseindia.com/MFOrderEntry
/MFOrder.svc/Secure</wsa:To></soap:Header>
<soap:Body>
<bses:orderEntryParam>
<bses:TransCode>NEW</bses:TransCode>
<bses:TransNo>2022021810234000003</bses:TransNo>
<bses:OrderId/>
<bses:UserID>123401</bses:UserID>
<bses:MemberId>1234</bses:MemberId>
<bses:ClientCode>clientcode01</bses:ClientCode>
<bses:SchemeCd>02-DP</bses:SchemeCd>
<bses:BuySell>R</bses:BuySell>
<bses:BuySellType>FRESH</bses:BuySellType>
<bses:DPTxn>P</bses:DPTxn>
<bses:OrderVal>100</bses:OrderVal>
<bses:Qty/>
<bses:AllRedeem>N</bses:AllRedeem>
<bses:FolioNo>123456</bses:FolioNo>
<bses:Remarks/>
<bses:KYCStatus>Y</bses:KYCStatus>
<bses:RefNo/>
<bses:SubBrCode/>
<bses:EUIN/>
<bses:EUINVal>N</bses:EUINVal>
<bses:MinRedeem>N</bses:MinRedeem>
<bses:DPC>Y</bses:DPC>
<bses:IPAdd/>
<bses:Password>UWQ/yLAS7KmiHyExtsKKq3DuHTWuyGOzy0P4s38PSL8nA==</bses:Password>
<bses:PassKey>abc123</bses:PassKey>
<bses:Parma1/>
<bses:Param2/>
<bses:Param3>{ucc bank account number}}</bses:Param3>
<bses:MobileNo/>
<bses:EmailID/>
<bses:MandateID/>
<bses:Filler1/>
<bses:Filler2/>
<bses:Filler3/>
<bses:Filler4/>
<bses:Filler5/>
<bses:Filler6/>
</bses:orderEntryParam></soap:Body></soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 30

 Sample SOAP Response for Redemption

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://bsestarmf.in/MFOrderEntry/orderEntryParamResponse</a:Action>
</s:Header>
<s:Body>
<orderEntryParamResponse xmlns="http://bsestarmf.in/">
<orderEntryParamResult>NEW|2022052610996000003|7532017|123401|123401|clientcode01|ORD CONF:
Your Request for FRESH REDEMPTION 100.000 UNITS in SCHEME: 02-DP THRO : PHYSICAL is confirmed for
CLIENT : clientname (Code: clientcode01) CONFIRMATION TIME: Jun 2 2022 12:30PM ENTRY BY: ORDER NO:
7532017|0 </orderEntryParamResult>
</orderEntryParamResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 31

 SIP MESSAGE STRUCTURE
Web Service SIP Request
The Method used for SIP Request is sipOrderEntryParam

Parameter Name Type Length Description Sample values Mandatory

Transaction code varchar 3 New SIP or NEW/CXL mandatory
Cancellation of SIP

Unique reference varchar 19 Unique reference YYYYMMDD<usercode> mandatory

number number from the 000001
member. Number
can be incremental
for each
order(000001,
000002,….). The
number will be
reset the next day.
SchemeCd varchar 20 BSE scheme code mandatory
MemberId varchar 20 BSE member code mandatory
ClientCode varchar 20 BSE client code mandatory
UserId bigint 5 user id mandatory

INTERNALREFNO / varchar 25 internal reference non -

PG REFERENCE NO number or PG mandatory
reference no
TRANSMODE varchar 2 demat or physical D/P mandatory
DP TRANSACTION char 1 CDSL/NSDL/PHYSIC C/N/P mandatory
MODE AL
START DATE varchar 10 start date of the DD/MM/YYYY mandatory
SIP
FREQUENCY TYPE varchar 20 type of frequency MONTHLY/QUARTERLY/ mandatory
WEEKLY

frequency allowed int 1 rolling frequency 1 mandatory

INSTALLMENT int 8 installment mandatory
AMOUNT amount
NO OF int 4 number of mandatory
INSTALLMENTS installments

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 32

 REMARKS varchar 100 non -
mandatory
FOLIO NO varchar 20 mandatory incase
of physical SIP
FIRSTORDERFLAG char 1 first order today Y/N mandatory
flag
SUBBRCODE varchar 15 sub broker code non -
mandatory
EUIN varchar 20 EUIN number mandatory
EUIN DECLERATION varchar 1 EUIN declaration Y/N mandatory
FLAG flag
DPC char 1 DPC flag Y mandatory
REGID bigint 10 SIP reg number.
Incase of new
registration this
will be blank
IPAdd varchar 20
Password varchar 250 encrypted mandatory
password
Pass Key varchar 10
Param1 (Sub Broker varchar 20 Filler 1 Will Be non -
ARN) Used As Sub mandatory
Broker ARN Code
Param2 (End Date) varchar 10 End Date for Daily DD/MM/YYYY Mandatory
SIP only in case
of daily SIP
only for
MFI/RFI
Param3 (Mobile No) varchar 10 non-
Primary Holder mandatory
Mobile Number
varchar 30 Primary Holder non-
FILLER 1 (Email ID) Email ID mandatory

FILLER 2 varchar 30
FILLER 3 varchar 30
FILLER 4 varchar 30
FILLER 5 varchar 30
FILLER 6 varchar 30

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 33

 Web Service SIP Request Response
The Method used for SIP Request Response is sipOrderEntryParamResponse

Parameter
Name Type Length Description Sample values
Transaction Transaction Code as
code varchar 3 given in the request NEW/CXL

Unique Unique reference

reference number as given in
number varchar 19 the request YYYYMMDD<usercode>000001
MemberId varchar 20 BSE member code
ClientCode varchar 20 BSE client code
UserId bigint 5 user id
in case new SIP, BSE
XSIP registration will
SIP REG_ID bigint 10 be populated.
Bse Response
Bse remarks varchar 1000 Return remarks
Success flag varchar 1 Order success flag
Only if First Order
First Order Today Flag is Y, and
Today Order SIP Authentication is
No varchar 20 Disabled First Order Today Order No

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 34

 Sample SOAP Request for SIP

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-
envelope" xmlns:bses="http://bsestarmf.in/"><soap:Header xmlns:wsa="http://www.w3.org/2005/08/address
ing"><wsa:Action>http://bsestarmf.in/MFOrderEntry/sipOrderEntryParam</wsa:Action>
<wsa:To>https://bsestarmfdemo.bseindia.com/MFOrderEntry/MFOrder.svc/Secure</wsa:To>
</soap:Header>
<soap:Body><bses:sipOrderEntryParam>
<bses:TransactionCode>NEW</bses:TransactionCode>
<bses:UniqueRefNo>20230810000011</bses:UniqueRefNo>
<bses:SchemeCode>B301G</bses:SchemeCode>
<bses:MemberCode>1234</bses:MemberCode>
<bses:ClientCode>clientcode01</bses:ClientCode>
<bses:UserID>123401</bses:UserID>
<bses:InternalRefNo>12340001</bses:InternalRefNo>
<bses:TransMode>P</bses:TransMode>
<bses:DpTxnMode>P</bses:DpTxnMode>
<bses:StartDate>15/08/2023</bses:StartDate>
<bses:FrequencyType>MONTHLY</bses:FrequencyType>
<bses:FrequencyAllowed>1</bses:FrequencyAllowed>
<bses:InstallmentAmount>500</bses:InstallmentAmount>
<bses:NoOfInstallment>12</bses:NoOfInstallment>
<bses:Remarks></bses:Remarks>
<bses:FolioNo></bses:FolioNo>
<bses:FirstOrderFlag>Y</bses:FirstOrderFlag>
<bses:SubberCode></bses:SubberCode>
<bses:Euin></bses:Euin>
<bses:EuinVal>N</bses:EuinVal>
<bses:DPC>Y</bses:DPC>
<bses:RegId></bses:RegId>
<bses:IPAdd></bses:IPAdd>
<bses:Password>qRZoNjextpqrrJJBs0DO6XL5LxTB8zJ7Ur70bKQ==</bses:Password>
<bses:PassKey>@12345</bses:PassKey>
<bses:Param1></bses:Param1>
<bses:Param2></bses:Param2>
<bses:Param3></bses:Param3>
<bses:Filler1></bses:Filler1>
<bses:Filler2></bses:Filler2>
<bses:Filler3></bses:Filler3>
<bses:Filler4></bses:Filler4>
<bses:Filler5></bses:Filler5>
<bses:Filler6></bses:Filler6>
</bses:sipOrderEntryParam></soap:Body>
</soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 35

 Sample SOAP Response for SIP

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-
envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://bsestarmf.in/MFOrderEntry/sipOrderEntryParamResponse
</a:Action>
</s:Header>
<s:Body>
<sipOrderEntryParamResponse xmlns="http://bsestarmf.in/">
<sipOrderEntryParamResult>NEW|20230810000011|1234|clientcode01|1234|582596|
SIP HAS BEEN REGISTERED, SIP REG NO IS : 582596|0|0</sipOrderEntryParamResult>
</sipOrderEntryParamResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 36

 XSIP/ISIP REQUEST MESSAGE STRUCTURE

Web Service XSIP/ISIP Request

The Method used for XSIP/ISIP Request is xsipOrderEntryParam

Parameter Type Length Description Sample values Mandatory

Name
Transaction varchar 3 New XSIP or NEW/CXL mandatory
code Cancellation of XSIP
Unique varchar 19 Unique reference YYYYMMDD<usercode mandatory
reference number from the >000001
number member. Number can
be incremental for each
order(000001,
000002,….). The number
will be reset the next
day.
SchemeCd varchar 20 BSE scheme code mandatory
MemberId varchar 20 BSE member code mandatory
ClientCode varchar 20 BSE client code mandatory
UserId bigint 5 user id mandatory

INTERNAL_REF_ varchar 25 internal reference non-

NO / PG number or PG reference mandatory
REFERENCE NO number
TRANS_MODE varchar 2 demat or physical D/P mandatory
DP transaction char 1 CDSL/NSDL/PHYSICAL C/N/P mandatory
mode
start date varchar 10 start date of the SIP DD/MM/YYYY
FREQUENCY varchar 20 type of frequency MONTHLY/QUARTELY/ mandatory
TYPE WEEKLY
frequency int 1 rolling frequency 1 mandatory
allowed
INSTALLMENT_ numeric 8 installment amount mandatory
AMOUNT
NO_OF_INSTALL int 4 number of installments mandatory
MENTS
REMARKS varchar 100 non-
mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 37

 FOLIO_NO varchar 20 mandatory incase of non-
physical SIP mandatory
FIRST_ORDER_F char 1 first order today flag Y/N mandatory
LAG
BROKERAGE money 8 non-
mandatory
XSIP bigint 8 BSE mandate ID Mandatory
MANDATEID/ (XSIP/Emandate) for for XSIP
EMANDATE ID XSIP Orders Orders
SUBBRCODE varchar 15 sub broker code non-
mandatory
EUIN varchar 20 EUIN number mandatory
EUIN flag varchar 1 EUIN decleration flag Y/N mandatory
DPC varchar 1 DPC flag Y mandatory
XSIP REG_ID int 10 XSIP reg number. Incase
of new registration this
will be blank
IPAdd varchar 20
Password varchar 250 encrypted password mandatory
Pass Key varchar 10
Param1 (Sub varchar 20 Filler 1 Will Be Used As non-
Broker ARN) Sub Broker ARN Code mandatory
Param2 (ISIP varchar 15 ISIP Mandate Mandatory
Mandate ID) for ISIP
Orders
Param3 (END varchar 10 End Date for Daily SIP DD/MM/YYYY Mandatory
DATE) only in case
of daily XSIP
only for
MFI/RFI
varchar 30 Primary Holder Mobile non-
FILLER 1
Number mandatory
(Mobile No)
FILLER 2 varchar 50 Primary Holder Email ID non-
(Email ID) mandatory
FILLER 3 varchar 30
FILLER 4 varchar 30
FILLER 5 varchar 30
FILLER 6 varchar 30

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 38

 Web Service XSIP/ISIP Request Response
The Method used for XSIP/ISIP Request Response is xsipOrderEntryParamResponse

Parameter Name Type Length Description Sample values

Transaction Code as
Transaction code varchar 3 given in the request NEW/CXL

Unique reference
Unique reference number as given in the
number varchar 19 request YYYYMMDD<usercode>000001
MemberId varchar 20 BSE member code
ClientCode varchar 20 BSE client code
UserId bigint 5 user id
in case new XSIP, BSE
XSIP registration will
XSIP REG_ID bigint 10 be populated.
Bse Response Return
BSE remarks varchar 1000 remarks

Success flag Varchar 1 Order success flag

Only if First Order
First Order Today Today Flag is Y, and SIP
Varchar 20
Order No Authentication is
Disabled

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 39

 Sample SOAP Request for XSIP

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:bses="http://bsestarmf.in/"><soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"><wsa:
Action>http://bsestarmf.in/MFOrderEntry/xsipOrderEntryParam</wsa:Action><wsa:To>https://bsestarmfdemo
.bseindia.com/MFOrderEntry/MFOrder.svc/Secure</wsa:To></soap:Header>
<soap:Body><bses:xsipOrderEntryParam>
<bses:TransactionCode>NEW</bses:TransactionCode>
<bses:UniqueRefNo>2023070210234000001</bses:UniqueRefNo>
<bses:SchemeCode>QUOFGP-GR</bses:SchemeCode>
<bses:MemberCode>1234</bses:MemberCode>
<bses:ClientCode>clientcode01</bses:ClientCode>
<bses:UserId>123401</bses:UserId>
<bses:InternalRefNo>123456</bses:InternalRefNo>
<bses:TransMode>P</bses:TransMode>
<bses:DpTxnMode>P</bses:DpTxnMode>
<bses:StartDate>10/08/2023</bses:StartDate>
<bses:FrequencyType>MONTHLY</bses:FrequencyType>
<bses:FrequencyAllowed>1</bses:FrequencyAllowed>
<bses:InstallmentAmount>1000</bses:InstallmentAmount>
<bses:NoOfInstallment>20</bses:NoOfInstallment>
<bses:Remarks></bses:Remarks>
<bses:FolioNo></bses:FolioNo>
<bses:FirstOrderFlag>Y</bses:FirstOrderFlag>
<bses:Brokerage></bses:Brokerage>
<bses:MandateID>780039</bses:MandateID>
<bses:SubberCode></bses:SubberCode>
<bses:Euin></bses:Euin>
<bses:EuinVal>N</bses:EuinVal>
<bses:DPC>Y</bses:DPC>
<bses:XsipRegID></bses:XsipRegID>
<bses:IPAdd></bses:IPAdd>
<bses:Password>qRZoNjepqrrJ3s56VX6J5vHir+xewJzLTffA==</bses:Password>
<bses:PassKey>@12345</bses:PassKey>
<bses:Param1></bses:Param1>
<bses:Param2></bses:Param2>
<bses:Param3></bses:Param3>
<bses:Filler1></bses:Filler1>
<bses:Filler2></bses:Filler2>
<bses:Filler3></bses:Filler3>
<bses:Filler4></bses:Filler4>
<bses:Filler5></bses:Filler5>
<bses:Filler6></bses:Filler6>
</bses:xsipOrderEntryParam></soap:Body>
</soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 40

 Sample SOAP Response for XSIP

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-
envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://bsestarmf.in/MFOrderEntry/xsipOrderEntryParamResponse
</a:Action>
</s:Header>
<s:Body>
<xsipOrderEntryParamResponse xmlns="http://bsestarmf.in/">
<xsipOrderEntryParamResult>NEW|202307021099600001|1234|clientcode01|123401|582597|
X-SIP HAS BEEN REGISTERED, REG NO IS : 582597|0|0</xsipOrderEntryParamResult>
</xsipOrderEntryParamResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 41

 SPREAD ORDER REQUEST MESSAGE STRUCTURE (Overnight)

Web Service SPREAD Order Request (Overnight)

The Method used for SPREAD Order Request is spreadOrderEntryParam

Parameter
Name Type Length Description Sample values Mandatory
New Spread Order or
Transaction Cancellation of Spread
code Varchar 3 Order NEW mandatory

Unique reference
number from the
member. Number can
be incremental for each
order(000001,
Unique 000002,….). The
reference number will be reset
number Varchar 19 the next day. YYYYMMDD<usercode>000001 mandatory

BSE unique order

number, for a new
order this field will be
blank and incase of
modification and
cancellation the order
Orderid Bigint 8 number has to be given

User ID which will be

Userid Bigint 5 given by BSE mandatory

Member code given by

Memberid Varchar 20 BSE mandatory
Clientcode Varchar 20 Client code mandatory
Schemecd Varchar 20 BSE scheme code mandatory

Type of transaction i.e.

Purchase or
Buysell Varchar 1 redemption P/R mandatory

Type of buy/sell type

Buyselltype Varchar 10 i.e. Fresh or additional FRESH/ADDITIONAL mandatory
Dptxn Varchar 10 CDSL/NSDL/PHYSICAL C/N/P mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 42

 Purchase
amount Money 14 Purchase amount
Redemption
amount Money 14 Redemption amount
All units flag, If this Flag
is"Y" then units and
amount column should
All units flag Varchar 1 be blank Y/N mandatory

Redeemdate Varchar 10 Redemption date DD/MM/YYYY mandatory

Incase of demat
transaction this field
will be blank and
mandatory in case of
physical redemption
and physical non-
Foliono Varchar 20 purchase+additional mandatory
non-
Remarks Varchar 255 mandatory

Kycstatus Varchar 1 Kyc status of client Y/N mandatory

Internal reference non-

Refno Varchar 20 number mandatory
non-
Subbrcode Varchar 15 Sub broker code mandatory

Euin Varchar 20 Euin number mandatory

Euinval Varchar 1 EUIN declaration Y/N mandatory
Minimum redemption
Minredeem Varchar 1 flag Y/N mandatory
Dpc flag for purchase
Dpc Varchar 1 transactions Y mandatory
Ipadd Varchar 20
Password Varchar 250 Encrypted password mandatory
Pass key Varchar 10
Param1 (sub Varchar 20 Filler 1 will be used as non-
broker arn) sub broker arn code mandatory

PG non-
Reference Purchase Only, Used mandatory
No (Param for Funds Mapping
2) Varchar 25

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 43

 Redemption Only, to
Bank choose the account in
Account No which the Funds are
(Param3) Varchar 20 redeemed to. Mandatory
10 Digit Indian Mobile Non-
Mobile No varchar 10
No used for verification mandatory
Email ID of the Client Non-
Email ID varchar 50
used for verification mandatory
FILLER 1 varchar 30
FILLER 2 varchar 30
FILLER 3 varchar 30
FILLER 4 varchar 30
FILLER 5 varchar 30
FILLER 6 varchar 30

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 44

 Web Service SPREAD Order Request Response (Overnight)
The Method used for SPREAD Order Request Response is spreadOrderEntryParamResponse

Parameter Name Type Length Description Sample Values

Value will be
same as
value given
in the
Transaction code Varchar 3 request NEW/CXL

Unique
referance
number as
Unique referance given in the
number Varchar 19 request YYYYMMDD<usercode>000001

BSE order
number will
be given in
Orderid Bigint 8 this field
User ID
which will be
Userid Bigint 5 given by BSE
Member
code given
Memberid Varchar 20 by BSE
Clientcode Varchar 20 Client code
Bse return
BSE remarks Varchar 1000 remarks
Order
Success flag Varchar 1 success flag

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 45

 Sample SOAP Request for SPREAD ORDER
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-
envelope" xmlns:bses="http://bsestarmf.in/">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"><wsa:Action>http://bsestarmf.in/MFOrder
Entry/spreadOrderEntryParam</wsa:Action><wsa:To>https://bsestarmfdemo.bseindia.com/MFOrderEntry/MFOrd
er.svc/Secure</wsa:To></soap:Header>
<soap:Body><bses:spreadOrderEntryParam>
<bses:TransactionCode>NEW</bses:TransactionCode>
<bses:UniqueRefNo>202308010000010</bses:UniqueRefNo>
<bses:OrderID></bses:OrderID>
<bses:UserID>1099601</bses:UserID>
<bses:MemberId>10996</bses:MemberId>
<bses:ClientCode>clientcode01</bses:ClientCode>
<bses:SchemeCode>AXFCFDP-DP-L0</bses:SchemeCode>
<bses:BuySell>P</bses:BuySell>
<bses:BuySellType>FRESH</bses:BuySellType>
<bses:DPTxn>P</bses:DPTxn>
<bses:OrderValue>5000</bses:OrderValue>
<bses:RedemptionAmt>5000</bses:RedemptionAmt>
<bses:AllUnitFlag>N</bses:AllUnitFlag>
<bses:RedeemDate>02/08/2023</bses:RedeemDate>
<bses:FolioNo></bses:FolioNo>
<bses:Remarks></bses:Remarks>
<bses:KYCStatus>Y</bses:KYCStatus>
<bses:RefNo></bses:RefNo>
<bses:SubBroCode></bses:SubBroCode>
<bses:EUIN></bses:EUIN>
<bses:EUINVal>N</bses:EUINVal>
<bses:MinRedeem>N</bses:MinRedeem>
<bses:DPC>Y</bses:DPC>
<bses:IPAddress></bses:IPAddress>
<bses:Password>qRZoNjextp6VOt+4LWW/mc+0yIG2AZ7LVBEtUg==</bses:Password>
<bses:PassKey>@12345</bses:PassKey>
<bses:Parma1></bses:Parma1>
<bses:Param2></bses:Param2>
<bses:Param3>11415</bses:Param3>
<bses:MobileNo></bses:MobileNo>
<bses:EmailID></bses:EmailID>
<bses:Filler1></bses:Filler1>
<bses:Filler2></bses:Filler2>
<bses:Filler3></bses:Filler3>
<bses:Filler4></bses:Filler4>
<bses:Filler5></bses:Filler5>
<bses:Filler6></bses:Filler6>
</bses:spreadOrderEntryParam></soap:Body></soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 46

 Sample SOAP Response for SPREAD ORDER
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-
envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://bsestarmf.in/MFOrderEntry/spreadOrderEntryParamRes
ponse</a:Action>
</s:Header>
<s:Body>
<spreadOrderEntryParamResponse xmlns="http://bsestarmf.in/">
<spreadOrderEntryParamResult>NEW|202308010000010|9793057|1099601|10996|
clientcode01|ORD CONF: YOUR REQUEST IS CONFIRMED FOR CLIENT : clientcode01 AND REDEMTION ORDER W
ILL BE TRIGGERED ON 01 Aug 2023 02:45 PM|0</spreadOrderEntryParamResult>
</spreadOrderEntryParamResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 47

 SWITCH ORDER REQUEST MESSAGE STRUCTURE

Web Service SWITCH Order Request

The Method used for SWITCH Order Request is switchOrderEntryParam

Parameter
Name Type LengthDescription Sample values Mandatory
New Switch Order or
Transaction Cancellation of
code Varchar 3 Switch Order NEW Mandatory
Unique reference
number from the
member. Number
can be incremental
for each
order(000001,
Unique 000002,….). The
referance number will be reset YYYYMMDD<usercode>000
number Varchar 19 the next day. 001 Mandatory
Orderid Bigint 8
User ID which will be
Userid Bigint 5 given by BSE Mandatory
Member code given
Memberid Varchar 20 by BSE Mandatory
Clientcode Varchar 20 Client code Mandatory
From
scheme
code Varchar 20 Bse scheme code Mandatory
To scheme
code Varchar 21 Bse scheme code Mandatory
Buysell Varchar 2 Switchout/switchin SO/SI Mandatory
Type of buy/sell type
i.e. Fresh or
Buyselltype Varchar 10 additional FRESH/ADDITIONAL Mandatory
CDSL/NSDL/PHYSICA
Dptxn Varchar 10 L C/N/P Mandatory
Switch
amount Money 14 Switch amount
Switch units Money 8 Switch units
All units flag Varchar 1 All units flag Y/N Mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 48

 Incase of a demat
transaction this field
will be blank and
mandatory in case of
physical redemption
and physical Non-
Foliono Varchar 20 purchase+additional mandatory
Non-
Remarks Varchar 255 Kyc status of client mandatory
Internal referance Non-
Kycstatus Varchar 1 number mandatory
Non-
Subbrocode Varchar 20 Sub broker code mandatory
Euin Varchar 20 Euin number Mandatory
Euinval Varchar 2 EUIN decleration Y/N Mandatory
Minimum
Minredeem Varchar 1 redemption flag Y/N Mandatory
Ipaddress Varchar 20
Password Varchar 250 Encrypted password Mandatory
Pass key Varchar 10
Param1 Varchar 10 filler 1 will be used Non-
(sub broker as sub broker arn mandatory
arn) code
10 Digit Indian Non -
Param2 Mobile No used for Mandatory
(MobileNo) Varchar 10 verification
Param3 Email ID of the Client Non -
(Email ID) Varchar 50 used for verification Mandatory
FILLER 1 varchar 30
FILLER 2 varchar 30
FILLER 3 varchar 30
FILLER 4 varchar 30
FILLER 5 varchar 30
FILLER 6 varchar 30

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 49

 Web Service SWITCH Order Request Response
The Method used for SWITCH Order Request Response is switchOrderEntryParamResponse

Parameter Name Type Length Description Sample Values

value will be
same as value
Transaction code varchar 3 NEW/CXL
given in the
request

Unique reference
Unique reference
varchar 19 number as given YYYYMMDD<usercode>000001
number
in the request

In this exchange
will send the
unique order
number assigned
to the transaction
Order ID bigint 8 (SO). And in case SO – SWITCH OUT Order No.
of modification or
cancellation BSE
unique order
number has to be
given in this field
User ID which will
User ID bigint 5
be given by BSE
member code
MemberId varchar 20
given by BSE
ClientCode varchar 20 Client code
BSE return
Success flag varchar 1
remarks
Bse remarks varchar 1000 order success flag

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 50

 Sample SOAP Request for SWITCH ORDER
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-
envelope" xmlns:bses="http://bsestarmf.in/">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"><wsa:Action>http://bsestarmf.in/MFOrder
Entry/switchOrderEntryParam</wsa:Action><wsa:To>https://bsestarmfdemo.bseindia.com/MFOrderEntry/MFOrd
er.svc/Secure</wsa:To>
</soap:Header>
<soap:Body><bses:switchOrderEntryParam>
<bses:TransCode>NEW</bses:TransCode>
<bses:TransNo>202308010000021</bses:TransNo>
<bses:OrderId></bses:OrderId>
<bses:UserId>1099601</bses:UserId>
<bses:MemberId>10996</bses:MemberId>
<bses:ClientCode>AIN05</bses:ClientCode>
<bses:FromSchemeCd>02-DP</bses:FromSchemeCd>
<bses:ToSchemeCd>B301G</bses:ToSchemeCd>
<bses:BuySell>SO</bses:BuySell>
<bses:BuySellType>FRESH</bses:BuySellType>
<bses:DPTxn>P</bses:DPTxn>
<bses:OrderVal></bses:OrderVal>
<bses:SwitchUnits></bses:SwitchUnits>
<bses:AllUnitsFlag>Y</bses:AllUnitsFlag>
<bses:FolioNo>123456</bses:FolioNo>
<bses:Remarks></bses:Remarks>
<bses:KYCStatus>Y</bses:KYCStatus>
<bses:SubBrCode></bses:SubBrCode>
<bses:EUIN></bses:EUIN>
<bses:EUINVal>N</bses:EUINVal>
<bses:MinRedeem>N</bses:MinRedeem>
<bses:IPAdd></bses:IPAdd>
<bses:Password>qRZoNjJBs0DO6VOt+4LWW/mc8Ra+FYKKaXwfA/Q==</bses:Password>
<bses:PassKey>@12345</bses:PassKey>
<bses:Parma1></bses:Parma1>
<bses:Param2></bses:Param2>
<bses:Param3></bses:Param3>
<bses:Filler1></bses:Filler1>
<bses:Filler2></bses:Filler2>
<bses:Filler3></bses:Filler3>
<bses:Filler4></bses:Filler4>
<bses:Filler5></bses:Filler5>
<bses:Filler6></bses:Filler6>
</bses:switchOrderEntryParam></soap:Body>
</soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 51

 Sample SOAP Response for SWITCH ORDER
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-
envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://bsestarmf.in/MFOrderEntry/switchOrderEntryParamRes
ponse</a:Action>
</s:Header>
<s:Body>
<switchOrderEntryParamResponse xmlns="http://bsestarmf.in/">
<switchOrderEntryParamResult>NEW|202308010000021|9793068|123401|1234|
clientcode01|YOUR REQUEST HAS BEEN CONFIRMED, ORDER NO: 9793068|0</switchOrderEntryParamResult>
</switchOrderEntryParamResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 52

 MUTUAL FUND ADDITIONAL SERVICES
MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 53

 MUTUAL FUND ADDITIONAL SERVICES AUTHENTICATION MESSAGE
STRUCTURE

NOTE : This section contains a SOAP Only service

In Addition to the Existing Order Routing Services additional Services are available through Web Services
for the BSE StAR MF system for the Mutual Fund Platform

1.) FATCA via Webservices

2.) UCC MFI/MFD – Multi Bank via Webservices Depreciated please use UCC API
3.) Online Payment Gateway via Webservices Depreciated. Available for Legacy use
4.) Change Password for Web Services ID and User IDs via Webservices
5.) Mandate Registration via Webservices
6.) STP Registration /Cancellation Depreciated
7.) SWP Registration /Cancellation Depreciated
8.) Client Payment Status via Webservices
9.) CKYC via Webservices Depreciated
10.) Mandate Status via Webservices Depreciated
11.) Client SMS Authentication via Webservices Depreciated
12.) Client Systematic Plan Authentication via Webservices Depreciated

Methods of online Payment Gateway Available as a selectable option

1.) Payment gateways – Direct mode

2.) Payment Gateways – Nodal mode
3.) One Time Mandate ( OTM ) for Lumpsum purchases in addition to SIPs
4.) Provision to put UTR number in case of NEFT / RTGS

The Web Service through which Additional services request and response can be facilitated is available at.

URL https://bsestarmfdemo.bseindia.com/MFUploadService/MFUploadService.svc

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 54

 MUTUAL FUND Additional Services Login Request
The Method used for MUTUAL FUND Additional Services Login Request is getPassword

Request parameters

Parameters Type Length Sample Values Mandatory

User ID Varchar 20 12301 mandatory

Member ID Varchar 20 123 mandatory

Password Varchar 30 mf@abc mandatory

Passkey Varchar 10 abcdef1234 mandatory

MUTUAL FUND Additional Services Login Request Response

The Method used for MUTUAL FUND Additional Services Login Request Response is getPassword

Parameters Type Length Remarks

Status Code Varchar 3 100- Success
101- Failure
Encrypted Password/Error Reason Varchar 500

Notes
1. The session Validity is only for 5 minutes
2. Member has to be Authenticated before sending any messages
3. Pass Key Validity can be Time based or One Time.
4. Member will have to enter the Web Service ID and password provided to them with a pass key ( Alpha
numeric with no special characters ) each time they login.
5. Pass key can be different each time they login
6. Once user provides all the above / required details and submits it the Exchange, a response code will
be sent to the member.
7. If the login is successful then response code “100” will be sent and also an encrypted password will be
sent to the member.
8. If the login is not successful then response code “101” will be sent.
9. This encrypted password will be unique each time the member logins into BSE web service.
10. Member has to use this encrypted password whenever they punches the order.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 55

 MUTUAL FUND ADDITIONAL SERVICES MESSAGE STRUCTURE

MUTUAL FUND Additional Services Request

The Method used for MUTUAL FUND Additional Services Request is MFAPI

Parameters Type Length Sample Values Remarks

01 FATCA UPLOAD
02 UCC – MFD
03 PAYMENT GATEWAY
04 CHANGE PASSWORD
05 UCC – MFI
06 MANDATE REGISTRATION
07 STP REGISTRATION (Depreciated Legacy use only)
08 SWP REGISTRATION
Flag Varchar 2
09 STP CANCELLATION (Depreciated Legacy use
only)
10 SWP CANCELLATION
11 CLIENT ORDER PAYMENT STATUS
12 CLIENT REDEMPTION SMS AUTHENTICATION
13 CKYC UPLOAD
15 SYSTEMATIC PLAN AUTHENTICATION
16 ORDER REJECTION
User Id Varchar 20
Encrypted Password Varchar 10
Parameters Max

Crossed off APIs are no longer available.

Notes
1. Member has to be Authenticated before sending any messages
2. The Flag Value sent denotes the Additional Service that is used.
3. The Value of the Parameters are different for each of the Additional Services Flag
4. The values of the Parameters and the details for their variable are as given below.
5. The Response of the request send are given separately in the next section.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 56

 Values for Param in MUTUAL FUND Additional Services Request

All Values are to be sent as pipe separated (|) unless specified otherwise

Parameters Type Length Sample Values

FATCA UPLOAD Varchar MAX Pipe Separated Values as per Web File Structure
PAYMENT GATEWAY Varchar MAX MemberCode|ClientCode|LogoutURL
CHANGE PASSWORD Varchar MAX Old Password|newpassword|conf password
MANDATE REGISTRATION Varchar MAX Pipe Separated Values as per Table Below
STP REGISTRATION Varchar MAX Pipe Separated Values as per Table Below
SWP REGISTRATION Varchar MAX Pipe Separated Values as per Table Below
STP CANCELLATION Varchar MAX Pipe Separated Values as per Table Below
SWP CANCELLATION Varchar MAX Pipe Separated Values as per Table Below
CLIENT ORDER PAYMENT STATUS Varchar MAX ClientCode|OrderNo|Segment
CLIENT REDEMPTION SMS
Varchar MAX MemberCode |ClientCode
AUTHENTICATION
CKYC UPLOAD Varchar MAX Pipe Separated Values as per File Structure Document
SYSTEMATIC PLAN
AUTHENTICATION (Registration/ Varchar MAX Pipe Separated Values as per Table Below
Cancellation)
ORDER REJECTION Varchar MAX MemberCode|ClientCode| OrderNo|Settlement No

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 57

 FATCA UPLOAD

M/O
FIELD M-
SR NO FIELD TYPE DESCRIPTION
DESCRIPTION MANDATORY
O- OPTIONAL
PAN of the Reporting Person - Investor / Guardian
1 PAN_RP Varchar(10) M
- Mandatory

PAN Exempt KYC Ref No. of the

M [If PAN
2 PEKRN Varchar(10) column in Null]
Investor/Guardian - Mandatory if PAN is not
provided

3 INV_NAME Varchar(70) M Name of the Investor / Guardian - Mandatory

M [if PAN is not

4 DOB Date Date of Birth
provided]
M [if PAN is not
5 FR_NAME Varchar(70)
provided]
M [if PAN is not
6 SP_NAME Varchar(70) provided]

Tax Status of the investor - Refer Tax Status

7 TAX_STATUS Varchar(3) M
Master

This is to indicated data sources whether it is

8 DATA_SRC Varchar(3) M obtained Electronically or through physical
request; Values - 'E' / 'P'

1 - Residential or Business; 2 - Residential; 3 -

9 ADDR_TYPE Varchar(1) M
Business; 4 - Registered Office; 5 - Unspecified

10 PO_BIR_INC Varchar(60) M Applicable to Individuals/Non Individuals

Refer Country/Nationality master enclosed and

11 CO_BIR_INC Varchar(50) M
provide values accordingly

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 58

 Refer Country/Nationality master enclosed and
12 TAX_RES1 Varchar(50) M
provide values accordingly

Tax Payer Identification Number / other Equivalent

13 TPIN1 Varchar(20) M
Number

Type of Identification document to be provided -

14 ID1_TYPE Varchar(1) M
Refer Identification Type master

Refer Country/Nationality master enclosed and

15 TAX_RES2 Varchar(50) M
provide values accordingly

Tax Payer Identification Number / other

16 TPIN2 Varchar(20) M
Equivalent Number

Type of Identification document to be provided -

17 ID2_TYPE Varchar(1) M
Refer Identification Type master

Refer Country/Nationality master enclosed and

18 TAX_RES3 Varchar(50) M
provide values accordingly

Tax Payer Identification Number / other

19 TPIN3 Varchar(20) M
Equivalent Number

Type of Identification document to be provided -

20 ID3_TYPE Varchar(1) M
Refer Identification Type master

Refer Country/Nationality master enclosed and

21 TAX_RES4 Varchar(50) M
provide values accordingly

Tax Payer Identification Number / other

22 TPIN4 Varchar(20) M
Equivalent Number

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 59

 Type of Identification document to be provided -
23 ID4_TYPE Varchar(1) M
Refer Identification Type master

Refer Source of wealth Sheet for values to be

24 SRCE_WEALT Varchar(3) M
populated

01 - Foreign Exchange / Money Changer Services

02 - Gaming / Gambling / Lottery Services [e.g.
M for Non-
25 CORP_SERVS Varchar(2) casinos, betting syndicates]
Individuals
03 - Money laundering / Pawning
04 – to be blank if the same is not applicable

App_Income_code as indicated in the

26 INC_SLAB Varchar(5) M
app_income master to be provided

Numeric M for Non- Provide the net worth of the investor only if the
27 NET_WORTH
(19,2) Individuals same is Corporate Category [INR. In Lacs]

M for Non-
28 NW_DATE Date Provide the net worth of the investor
Individuals

Values to be 'Y' if the investor is politically

M for exposed person; 'N' if the investor is not; 'R' if the
29 PEP_FLAG Varchar(2)
Individuals investor is a relative of the politically exposed
person

Values to be provided as per the Occupation

30 OCC_CODE Varchar(2) M
Master enclosed

S - Service; B - Business, O - Others; X - Not

31 OCC_TYPE Varchar(1) M
Categorized

M for Non- Provide the values as specified under 'Exemption

32 EXEMP_CODE Varchar(2)
Individuals Code' sheet

M for Non-
33 FFI_DRNFE Varchar(20) Values - FFI, DRNFE, NA
Individuals
M for Non-
34 GIIN_NO Varchar(19) Applicable to FFI, DRNFE, NA
Individuals

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 60

 Name of the Sponsoring Entity if GIIN_NO of
35 SPR_ENTITY Varchar(60) O
Sponsoring Entity is given

Value to be provided: AF - Applied for; NR - Not

36 GIIN_NA Varchar(3) O required to apply for; NO - Not obtained - Non-
participating FI

Refer GIIN_EXEMPT sheet and applicable codes

37 GIIN_EXEMC Varchar(2) O
to be populated

L - Listed entity; RL - Related to listed entity; A-

38 NFFE_CATG Varchar(3) O Active NFFE, P - Passive NFFE, NA - Not
Applicable -for Non NFFE

Refer sheet 'ACTIVE_NFE_SUB_CATG' and

39 ACT_NFE_SC Varchar(3) O
populate suitable values

M if
40 NATURE_BUS Varchar(30) NFFE_CATG Applicable for Active NFE & Passive NFE
is 'A' or 'P'

Name of the Listed Company where Entity is its

41 REL_LISTED Varchar(70) O
associate / related company

42 EXCH_NAME Varchar(2) M B - BSE, N - NSE, O - Others

Values should be 'Y' / 'N'. Default - 'Y' for Entities

for other than Listed Company / Group / Associate
43 UBO_APPL Varchar(2) M
Company of the Listed Company / Company
controlled by Listed Company

Provide the count of UBO, if the value is more than

M [if '1', then multiple rows to be provided as per the
44 UBO_COUNT Varchar(3) UBO_APPL is count i.e. if the count is 2, additional one row with
'Y' same investor PAN and only UBO details will be
different

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 61

 M [if
45 UBO_NAME Varchar(70) UBO_APPL is Name of the UBO
'Y'
M / O [if
UBO_TIN is
46 UBO_PAN Varchar(10) not provided, PAN of UBO to be provided
this field is
mandatory

M [if
Refer Country/Nationality master enclosed and
47 UBO_NATION Varchar(3) UBO_APPL is
provide values accordingly
'Y'

M [if
48 UBO_ADD1 Varchar(50) UBO_APPL is
'Y'
M [if
49 UBO_ADD2 Varchar(50) UBO_APPL is
'Y'
M [if
50 UBO_ADD3 Varchar(50) UBO_APPL is
'Y'
M [if
51 UBO_CITY Varchar(50) UBO_APPL is
'Y'
M [if
52 UBO_PIN Varchar(6) UBO_APPL is
'Y'
M [if
State Code to be provided as per the existing
53 UBO_STATE Varchar(3) UBO_APPL is
practice
'Y'

M [if
Refer Country/Nationality master enclosed and
54 UBO_CNTRY Varchar(4) UBO_APPL is
provide values accordingly
'Y'

M [if
1 - Residential or Business; 2 - Residential; 3 -
55 UBO_ADD_TY Varchar(2) UBO_APPL is
Business; 4 - Registered Office; 5 - Unspecified
'Y'

M [if UBO's Country of Tax Residency - Refer

56 UBO_CTR Varchar(4) UBO_APPL is Country/Nationality master enclosed and provide
'Y' values accordingly

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 62

 M / O [if
UBO_PAN is
UBO's Tax Payer Identification Number or any
57 UBO_TIN Varchar(20) not provided,
other relevant reference number
this field is
mandatory]
M / O [if
58 UBO_ID_TY Varchar(2) UBO_APPL is Refer Identification type master given
'Y'
M [if
59 UBO_COB Varchar(30) UBO_APPL is UBO Country of Birth
'Y'
60 UBO_DOB Date O UBO Date of Birth

61 UBO_GENDER Varchar(1) O Value to be provided as 'M' or 'F' or 'O'

62 UBO_FR_NAM Varchar(50) O UBO Father's name to be provided

63 UBO_OCC Varchar(2) O As per Occupation List

S - Service; B - Business, O - Others; X - Not

Categorized - Refer Applicable Occupation Type
64 UBO_OCC_TY Varchar(2) O
for the relevant Occupation Codes under
'Occupation' sheet

65 UBO_TEL Varchar(12) O UBO Telephone Number

66 UBO_MOBILE Varchar(12) O UBO Mobile Number

67 UBO_CODE Varchar(3) M Code as per master given in UBO_CODE sheet

68 UBO_HOL_PC Varchar(3) O Should not be greater than 100 and less than 0

This flag is to indicate whether Values - 'Y', 'N' -

69 SDF_FLAG Varchar(2) M/O
Default 'Y' for Entities; Optional for Individuals,

Values - 'Y', 'N' - Default 'Y' for Entities and 'N' for
70 UBO_DF Varchar(2) M
Individuals

71 AADHAAR_RP Varchar(30) O Aadhaar of the Reporting Person shall be provided

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 63

 N- New - This value should be updated for first
time update by the channel distributors for the
given PAN
C- Change - This Value should be provided for
change in already provided information if CP is
72 NEW_CHANGE Varchar(2) M/O
aware of that this is change in the existing
information
In case of 'C', Channel should provide PAN_RP or
PERKN, Status and applicable fields where
change is required

Mandatory if DATA_SRC is 'E'

73 LOG_NAME Varchar(30) M/O
Eg. 196.15.16.107#23-Nov-15;16:4
These columns are added to meet future
74 FILLER1 Varchar(30) O requirements but CP may provide any other
related information in these columns
These columns are added to meet future
75 FILLER2 Varchar(30) O requirements but CP may provide any other
related information in these columns

UCC/CLIENT CREATION– MFD (Depreciated)

Pipe Separated Values as per Section: UCC/ CLIENT MASTER UPLOAD (MFI) of the BSE StAR MF File
Structure Document/ Web File Structure Document

Payment Gateway Values (Depreciated)

Parameters Type Length
Membercode Varchar 20
Clientcode Varchar 10
Logout Url Varchar 500

CHANGE PASSWORD
Parameters Field Description Values
OLD PASSWORD Minimum 6
NEW PASSWORD Maximum 14
CONF PASSWORD Type Alpha Numeric with one special character

UCC/CLIENT CREATION– MFI (Depreciated)

Pipe Separated Values as per Section: UCC/ CLIENT MASTER UPLOAD (MFI) of the BSE StAR MF File
Structure Document/ Web File Structure Document

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 64

 MANDATE REGISTRATION
XSIP/ISIP Mandate: Member Type: MFI/MFD

Mandatory/ Non
Parameters TYPE Length Sample Mandatory Fields
MFD MFI
CLIENT CODE VARCHAR 10 Yes Yes
AMOUNT MONEY Yes Yes
Mandate Type CHAR 1 X / I /N (XSIP/ISIP/Net Banking) Yes Yes
ACCOUNT NO. VARCHAR 20 Yes Yes
A/C TYPE SB/CB/NE/NO Yes Yes
IFSC CODE VARCHAR 11 Yes Yes
MICR CODE VARCHAR 9 No No
START DATE DATE DD/MM/YYYY Yes Yes
DD/MM/YYYY Default date would be
END DATE DATE Yes Yes
current date + 100 yrs.

STP REGISTRATION (Depreciated – Legacy Use only use the Enhanced STP API)
Parameters Type Length Sample
Client Code Varchar 10
From Bse Scheme Code Varchar 20
To Bse Scheme Code Varchar 20
Buy / Sell Type Varchar 10 Fresh/Additional
Transaction Mode Varchar 1 P- Physical
Folio Number Varchar 15
Internal Ref Number Varchar 10
Start Date Date 10
Frequency Type Varchar 20 Weekly / Monthly / Quarterly
No Of Transfers Int 8
Installment Amount Numeric 25,3
First Order Today Varchar 1 Y/N
Sub Broker Code Varchar 15
EUIN Declaration Varchar 1 Y/N
EUIN Number Varchar 7
Remarks Varchar 100
Sub Broker - ARN Varchar 20
Mobile No. Int 10 Non-mandatory
Email Id Varchar 50 Non-mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 65

 SWP REGISTRATION
Parameters Type Length Sample
Client Code Varchar 10
Bse Scheme Code Varchar 20
Transaction Mode Varchar 1 D- Demat, P- Physical
Folio Number Varchar 15
Internal Ref Number Varchar 10
Start Date Date 10
Number Of Withdrawls Int 8
Frequency Type Varchar 20 Weekly / Monthly / Quarterly
Installment Amount Numeric 25,3
Installment Units Numeric 25,3
First Order Today Varchar 1 Y/N
Sub Broker Code Varchar 15
EUIN Declaration Varchar 1 Y/N
EUIN Number Varchar 7
Remarks Varchar 100
Sub Broker - ARN Varchar 20
Mobile No. Int 10 Non-mandatory
Email Id Varchar 50 Non-mandatory
Bank Account No. Varchar 20 Mandatory

STP CANCELLATION ( Depreciated Legacy use Only)

Parameters Type Length Sample
STP registration no Varchar 8 98488
client code Varchar 10 10178
remarks Varchar 100

SWP CANCELLATION
Parameters Type Length Sample
SWP registration no Varchar 8 75896
client code Varchar 10 10178
remarks Varchar 100

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 66

 CLIENT ORDER PAYMENT STATUS
Parameters Type Length Sample
Client Code Varchar 10 10178
Order No BigInt 1815505
BSEMF - when MF Order is placed
Segment varchar 10
SGB - when SGB order is placed

CLIENT REDEMPTION SMS AUTHENTICATION ( Depreciated)

Particular Type Length
Membercode Varchar 20
Clientcode Varchar 10

CKYC UPLOAD (Depreciated)

Pipe Separated Values as per Section: CKYC UPLOAD of the BSE StAR MF File Structure Document/ Web File
Structure Document

SYSTEMATIC PLAN AUTHENTICATION (Registration/ Cancellation) (Depreciated)

Parameters Type Length Sample
Action varchar 10 NEW/CXL
Member code varchar 10
Client code varchar 10
Logout URL varchar 15 Optional

ORDER REJECTION (Depreciated)

Parameters Type Length Sample
member code varchar 10
Client code varchar 10
order no bigint 10
settlement no varchar 7

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 67

 MUTUAL FUND Additional Services Request Response
The Method used for MUTUAL FUND Additional Services Request Response is MFAPI

Parameters Type Length Remarks

Status Code Varchar 3 100- Success
101- Failure
Response /Remarks Varchar 1000 FATCA – Verbose Messages/ Error Reason
UCC MFD– Verbose Messages/ Error Reason
PYMT GTY – Payment Gateway Link
CHNG PASS - – Verbose Messages/ Error Reason
UCC MFI– Verbose Messages/ Error Reason
MANDATE REGISTRATION – Verbose Messages (Table
Below)/ Error Reason
STP REGISTRATION – Verbose Messages/ Error Reason
SWP REGISTRATION – Verbose Messages/ Error Reason
STP CANCELLATION – Verbose Messages/ Error Reason
SWP CANCELLATION – Verbose Messages/ Error Reason
CLIENT ORDER PAYMENT STATUS – Verbose Messages
(Table Below)/ Error Reason
CLIENT REDEMPTION SMS– Authentication URL/ Error
Reason
CKYC UPLOAD– Verbose Messages/ Error Reason
ORDER REJECTION – Verbose Messages/ Error Reason

MANDATE REGISTRATION RESPONSE

Mandate Registration ID is given in Verbose Message in case of Success.

For XSIP Mandate ID Mandate ID Length is less than 15 digits

For ISIP Mandate ID length = 15 digit and First THREE Char starts with ‘BSE’ like ‘BSE521824730118’

CLIENT ORDER PAYMENT RESPONSE STATUS

Status Code Response /Remarks
101 INVALID SEGMENT VALUE

101 INVALID ORDER NUMBER

101 INVALID ORDER NUMBER FOR GIVEN MEMBER

101 INVALID ORDER NUMBER FOR GIVEN CLIENT

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 68

 100 PAYMENT NOT INITIATED FOR GIVEN ORDER

100 AWAITING FOR FUNDS CONFIRMATION (Mode)

100 APPROVED (Mode)

100 REJECTED (Mode)

ERROR MESSAGES DESCRIPTION

INVALID USER ID Incorrect Login ID
PASSWORD EXPIRED Incorrect Passkey
PASSWORD EXPIRED Incorrect User ID
INVALID PARAM STRING FORMAT Request string is not proper format
MEMBER CODE MANDATORY Blank member code
CLIENT CODE MANDATORY Blank client code
INVALID MEMBER CODE Incorrect member code
INVALID CLIENT CODE Incorrect client code
INVALID ACTION CODE Incorrect action code
INVALID PARAM STRING FORMAT when the request string is not proper format
FAILED: INVALID STP REGISTRATION NUMBER Wrong SWP registration number
SWP registration number which is already cancelled
FAILED: SWP ALREADY CANCELLED on the system
SWP registration number is used for which the
SWP CANCELLATION REQUEST ALREADY cancellation is already initiated but authentication
INITIATED from the client is not received
FAILED: PAYMENT ALREADY RECIEVED FOR when the funds are already received for the given
ORDER ID- order no
FAILED: ORDER ALREADY MARKED AS INVALID
FOR ORDER ID- when the order is already invalid
FAILED: TIME EXCEEDED FOR PAYMENT when the order rejection time is exceeded for the
REJECTION FOR ORDER ID- given order
FAILED: ORDER CANCELLATION NOT ALLOWED
ON when the order cancellation is not allowed
FAILED: ORDER NOT FOUND when the order that is passed is not available
FAILED: ORDER NOT FOUND FOR ORDER ID- when the order that is passed is not available

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 69

 MUTUAL FUND ENHANCED UCC
REGISTRATION WEB SERVICE MESSAGE
STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 70

 StAR MF Enhanced UCC Registration Structure API for MFI & MFD Members

URL https://bsestarmfdemo.bseindia.com/StarMFCommonAPI/ClientMaster/Registration

StAR MF Enhanced UCC Registration Structure API for MFI & MFD Members

API Structure Details

Request Parameter : (JSON Format)

Sample
Parameter Name Type Length Mandatory JSON Name
Values
UserId Varchar 20 Mandatory UserId
Member CODE Varchar 20 Mandatory MemberCode
Password Varchar Mandatory Password
Registration type Varchar 10 NEW/MOD Mandatory RegnType
Parameter String Mandatory Param
Filler 1 Varchar 50 Non - mandatory Filler1
Filler 2 Varchar 50 Non - mandatory Filler2

Response Parameter : (JSON Format)

Parameter Name Type Length Description Sample values JSON Name

STATUS flag Varchar 10 Success flag 0 - Success & 1 - Failure Status
BSE Remarks Varchar 1000 Return Remarks Verbose Messages Remarks
Filler 1 Varchar 50 Filler1
Filler 2 Varchar 50 Filler2

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 71

 MUTUAL FUND NEW ENHANCED UCC REGISTRATION WEBSERIVCE
STRUCTURE

URL https://bsestarmfdemo.bseindia.com/StarMFCommonAPI/ClientMaster/Registration

New Client Registration

Request Parameter (JSON Format)

{
"UserId" : "1000001",
"MemberCode" : "10000",
"Password" : "@123456",
"RegnType" : "NEW",
"Param" : "T0001|FirstName||LastName|01|M|01/01/1970|01|SI|||||||||||||N||||AFEPK2130F|
|||||||P||||||||SB|11415||HDFC0000001|Y|||||||||||||||||||||FirstName LastName|01|ADD 1|ADD 2|
ADD 3|MUMBAI|MA|400001|INDIA|22721233||||[email protected]|P||||||||||||9999999999||||||||||||||||
|||K||||||||||||N||P|||SE|SE|",
"Filler1" : "",
"Filler2" : ""
}

Response Parameter (JSON Format)

{
"Status": "0",
"Remarks": "CLIENT REGISTERED SUCCESSFULLY",
"Filler1": "",
"Filler2": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 72

 New Client Modification/ Old Client UCC Upgrade

Request Parameter (JSON Format)

{
"UserId" : "1000001",
"MemberCode" : "10000",
"Password" : "@123456",
"RegnType" : "MOD",
"Param" : "T0001|FirstName||LastName|01|M|01/01/1970|01|SI|||||||||||||N||||AFEPK2130F|
|||||||P||||||||SB|11415||HDFC0000001|Y|||||||||||||||||||||FirstName LastName|01|ADD 0|ADD 2|
ADD 3|MUMBAI|MA|400001|INDIA|22721233||||[email protected]|P||||||||||||9999999999||||||||||| ||||
|| ||K||||||||||||N||P|||SE|SE|",
"Filler1" : "",
"Filler2" : ""
}

Response Parameter (JSON Format)

{
"Status": "0",
"Remarks": "CLIENT UPDATED SUCCESSFULLY",
"Filler1": "",
"Filler2": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 73

MFI & MFD New Common Client Registration Parameter Structure
Sr Old Field
Data Field
No Field Name Mandatory Remarks Type Length Number Old Field Name

MFI MFD

1 Client Code (UCC) Mandatory char 10 1 1 CLIENT CODE

2 Primary Holder When Upgrading

Mandatory char 5 5
First Name Old UCC to New
UCC, Entire Name
Primary Holder in old format i.e
3 Optional 70
Middle Name CLIENT APP.
NAME 1 to be
4 Primary Holder entered in Primary
Last Name Optional
Holder First Name

5 Tax Status 2 3 3 CLIENT TAX

Mandatory Refer Tax Status char
STATUS

Mandatory for
Conditional Individual and Minor
6 Gender clients char 1 9 9
Mandatory
M/F/O CLIENT GENDER

Primary Holder
7 DOB/Incorporatio Mandatory DD/MM/YYYY char 10 8 8
n CLIENT DOB

8 Occupation Code 2 4 4 CLIENT

Refer Occupation
Mandatory char OCCUPATION
Code
CODE

9 Holding Nature Refer Holding (SI/ JO/ 2 2 2 CLIENT HOLDING

Mandatory char
AS)

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 74

 Second Holder Conditional Mandatory if Mode
10 char
First Name Mandatory of Holding JO/AS

Second Holder
11 Optional 70 6 6
Middle Name

Second Holder
12 Optional
Last Name CLIENT

Third Holder First

13 Optional char
Name

14 Third Holder CLIENT APP.

Optional 70 7 7
Middle Name NAME 3

15 Third Holder Last

Optional
Name

Second Holder CKYC CKYC

16 Optional DD/MM/YYYY DATE 10 field field Joint Holder 1
DOB DOB
(7) (7)

CKYC CKYC
17 Third Holder DOB Optional DD/MM/ DATE 10 field field Joint Holder 2
YYYY (8) (8) DOB

Guardian First Conditional Mandatory for Minor

18 char
Name Mandatory Clients

19 Guardian Middle
Optional char 120 10 10 Guardian's Name
Name

Guardian Last
20 Optional char
Name

CKYC CKYC Guardian CKYC

21 Guardian DOB Optional DD/MM/YYYY DATE 10 field field
DOB
(9) (9)

22 Primary Holder 1 NEW NEW NEW

Mandatory Y/N Varchar
PAN Exempt

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 75

23 Second Holder 1 NEW NEW NEW
Mandatory Y/N Varchar
PAN Exempt

24 Third Holder PAN 1 NEW NEW NEW

Mandatory Y/N Varchar
Exempt

25 Guardian PAN 1 NEW NEW NEW

Mandatory Y/N Varchar
Exempt

Mandatory if Primary
Primary Holder Conditional
26 Holder PAN Exempt char 10 11 11
PAN Mandatory
flag N. CLIENT PAN

Mandatory if Second
Second Holder
27 Optional Holder PAN Exempt char 10 42 61
PAN
flag N. CLIENT PAN2

Mandatory if Third
28 Third Holder PAN Optional char 10 43 62
PAN Exempt flag N CLIENT PAN3

Mandatory if
Conditional
29 Guardian PAN Guardian PAN char 10 14 14 CLIENT GUARDIAN
Mandatory
Exempt flag N. PAN

Mandatory if
PRIMARY Holder PAN
Primary Holder- Conditional
30 Exempt flag Y. Refer Varchar 2 NEW NEW
Exempt Category Mandatory
PAN Exempt
Category NEW

Mandatory if
SECOND HOLDER
Second Holder Conditional
31 PAN Exempt flag Y. Varchar 2 NEW NEW
Exempt Category Mandatory
Refer PAN Exempt
Category NEW

Mandatory if THIRD
Third Holder Conditional HOLDER PAN Exempt
32 Varchar 2 NEW NEW
Exempt Category Mandatory flag Y. Refer PAN
Exempt Category NEW

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 76

 Mandatory if
Guardian PAN
Guardian Exempt Conditional
33 Exempt flag Y. Refer Varchar 2 NEW NEW NEW
Category Mandatory
PAN Exempt
Category

34 Client Type P / D (P- Physical /D- 1 NEW 15 Client Type

Mandatory Varchar
Demat)

Conditional Mandatory if client

35 PMS CHAR 1 NEW NA
Mandatory type D (Y/N) NEW

Conditional Mandatory if client CLIENT DEFAULT

36 Default DP char 4 15 16
Mandatory type D (CDSL/NSDL) DP

Conditional Mandatory if Default CLIENT CDSL DP

37 CDSL DPID char 8 16 17
Mandatory DP is CDSL ID

Conditional Mandatory if Default CLIENT CDSL

38 CDSLCLTID char 16 17 18
Mandatory DP is CDSL CLIENT ID

Mandatory if PMS
Conditional
39 CMBP Id Flag is ‘Y’ and client Number 16 NEW NEW
Mandatory
Default DP is NSDL NEW

Conditional Mandatory if Default CLIENT NSDL DP

40 NSDLDPID char 8 18 19
Mandatory DP if NSDL ID

Conditional Mandatory if Default CLIENT NSDL

41 NSDLCLTID char
Mandatory DP if NSDL 8 19 20 CLIENT ID

42 Account Type 1 Mandatory Refer Account Type varchar 2 23 21 CLIENT ACC TYPE

43 Account No 1 Mandatory varchar 40 24 22 CLIENT ACC NO

44 MICR No 1 Optional varchar 9 25 23 CLIENT MICR NO

45 IFSC Code 1 11 26 24 CLIENT NEFT

Mandatory varchar
CODE

46 Default Bank Flag Mandatory Y/N varchar 1 NA 25 Default bank flag

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 77

47 Account Type 2 2 NA 26 CLIENT ACC TYPE
Optional Refer Account Type varchar
2

Conditional Mandatory if Client

48 Account No 2 varchar
Mandatory Acctype 2 is available 40 NA 27 CLIENT ACC NO 2

CLIENT MICR NO
49 MICR No 2 Optional varchar
9 NA 28 2

Mandatory if Client CLIENT

Conditional Acctype 2 is available NEFT/IFSC
50 IFSC Code 2 varchar
Mandatory and MICR not CODE 2
available 11 NA 29

Mandatory if Client
Conditional
51 Default Bank Flag Acctype 2 is available varchar Default bank flag
Mandatory
(Y/N) 1 NA 30

52 Account type 3 2 NA 31 CLIENT ACC TYPE

Optional Refer Account Type varchar
3

Conditional Mandatory if Client

53 Account No 3 varchar
Mandatory Acctype 3 is available 40 NA 32 CLIENT ACC NO 3

CLIENT MICR NO
54 MICR No 3 Optional varchar
9 NA 33 3

Mandatory if Client CLIENT

Conditional Acctype 3 is available NEFT/IFSC
55 IFSC Code 3 varchar
Mandatory and MICR not CODE 3
available 11 NA 34

Mandatory if Client
Conditional
56 Default Bank Flag Acctype 3 is available varchar Default bank flag
Mandatory
(Y/N) 1 NA 35

57 Account type 4 2 NA 36 CLIENT ACC TYPE

Optional Refer Account Type varchar
4

Conditiona Mandatory if Client

58 Account No 4 l Acctype 4 is varchar
Mandatory available 40 NA 37 CLIENT ACC NO 4

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 78

 CLIENT MICR NO
59 MICR No 4 Optional varchar
9 NA 38 4

Mandatory if Client CLIENT

Conditiona
Acctype 4 is NEFT/IFSC
60 IFSC Code 4 l varchar
available and MICR CODE 4
Mandatory
not available 11 NA 39

Conditiona Mandatory if Client

61 Default Bank Flag l Acctype 4 is varchar Default bank flag
Mandatory available (Y/N) 1 NA 40

62 Account type 5 2 NA 41 CLIENT

Optional Refer Account Type varchar
ACC TYPE 5

Conditiona Mandatory if Client

63 Account No 5 l Acctype 5 is varchar
Mandatory available 40 NA 42 CLIENT ACC NO 5

CLIENT
64 MICR No 5 Optional varchar
9 NA 43 MICR NO 5

Mandatory if Client CLIENT

Conditiona
Acctype 5 is NEFT/IFSC
65 IFSC Code 5 l varchar
available and MICR CODE 5
Mandatory
not available 11 NA 44

Conditiona Mandatory if Client

66 Default Bank Flag l Acctype 5 is varchar
Mandatory available (Y/N) 1 NA 45 Default bank flag

67 Cheque name 35 27 46 CLIENT CHEQUE

Optional varchar
NAME

68 Div pay mode 01/02/03/04/05 2 41 60 CLIENT DIV PAY

Mandatory varchar
Refer DIVPAYMODE MODE

Conditiona
Not mandatory for
69 Address 1 l varchar
NRI
Mandatory 40 28 47 CLIENT ADD 1

70 Address 2 Optional varchar 40 29 48 CLIENT ADD 2

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 79

71 Address 3 Optional varchar 40 30 49 CLIENT ADD 3

72 City Not mandatory for 35 31 50 CLIENT CITY

Mandatory varchar
NRI

73 State Not mandatory for 2 32 51 CLIENT STATE

Mandatory varchar
NRI

74 Pincode Not mandatory for 6 33 52 CLIENT PIN CODE

Mandatory varchar
NRI

75 Country Not mandatory for 35 34 53 CLIENT COUNTRY

Mandatory varchar
NRI

76 Resi. Phone Not mandatory for 15 35 54 CLIENT RESI

Optional varchar
NRI PHONE

77 Resi. Fax Not mandatory for 15 36 55 CLIENT RESI FAX

Optional varchar
NRI

78 Office Phone Not mandatory for 15 37 56 CLIENT OFFICE

Optional varchar
NRI PHONE

79 Office Fax Not mandatory for 15 38 57 CLIENT OFFICE

Optional varchar
NRI FAX

80 Email Mandatory varchar 50 39 58 CLIENT EMAIL

P-Physical/E- CLIENT
Email/M-Mobile COMMUNICATIO
Communication
81 Mandatory Refer varchar N MODE
Mode
Communication
Mode 1 40 59

Mandatory for NRI,

Conditional
82 Foreign Address 1 Except for Seafarer. varchar CM_FOREIGN
Mandatory
Refer Tax Status 40 45 64 ADD 1

83 Foreign Address 2 40 46 65 CM_ FOREIGN

Optional varchar
ADD 2

84 Foreign Address 3 40 47 66 CM_ FOREIGN

Optional varchar
ADD 3

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 80

 Foreign Address Conditional CM_ FOREIGN
85 Mandatory for NRI varchar
City Mandatory 35 48 67 CITY

Foreign Address Conditional CM_ FOREIGN PIN

86 Mandatory for NRI varchar
Pincode Mandatory 10 49 68 CODE

Foreign Address Conditional CM_ FOREIGN

87 Mandatory for NRI varchar
State Mandatory 35 50 69 STATE

Foreign Address Conditional CM_ FOREIGN

88 Mandatory for NRI varchar
Country Mandatory 3 51 70 COUNTRY

89 Foreign Address 15 52 71 CM_ FOREIGN

Optional varchar
Resi Phone RESI PHONE

90 Foreign Address 15 53 72 CM_ FOREIGN

Optional varchar
Fax RESI FAX

91 Foreign Address 15 54 73 CM_ FOREIGN

Optional varchar
Off. Phone OFF PHONE

92 Foreign Address 15 55 74 CM_ FOREIGN

Optional varchar
Off. Fax OFF FAX

93 Indian Mobile No. Mandatory varchar 10 75 CM_MOBILE

94 Nominee 1 Name Optional varchar 40 12 12 CLIENT NOMINEE

Nominee 1 Conditional Mandatory if client CLIENT NOMINEE

95 varchar
Relationship Mandatory nominee available 40 13 13 RELATION

Nominee 1 Conditional Mandatory if client

96 Number
Applicable(%) Mandatory nominee available 5,2 NEW NEW NEW

Nominee 1 Minor Conditional Mandatory if client

97 Char
Flag Mandatory nominee available 1 NEW NEW NEW

Mandatory only if
Conditional
98 Nominee 1 DOB Nominee minor flag Date
Mandatory
Y NEW NEW NEW

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 81

 Mandatory if
Nominee 1 Conditional
99 Nominee minor flag Char
Guardian Mandatory
Y 35 NEW NEW NEW

100 Nominee 2 Name Optional Char 40 NEW NEW NEW

Nominee 2 Conditional Mandatory if

101 Char
Relationship Mandatory Nominee 2 available 40 NEW NEW NEW

Nominee 2 Conditional Mandatory if

102 Number
Applicable(%) Mandatory Nominee 2 available 5,2 NEW NEW NEW

Mandatory if
Conditional Nominee 2 available
103 Nominee 2 DOB Date
Mandatory
DD/MM/YYYY 10 NEW NEW NEW

Nominee 2 Minor Conditional Mandatory if

104 Varchar
Flag Mandatory Nominee 2 available 1 NEW NEW NEW

Nominee 2 Conditional Mandatory if

105 Char
Guardian Mandatory Nominee 2 available 35 NEW NEW NEW

106 Nominee 3 Name Optional Char 40 NEW NEW NEW

Nominee 3 Conditional Mandatory if

107 Char
Relationship Mandatory Nominee 3 available 40 NEW NEW NEW

Nominee 3 Conditional Mandatory if

108 Number
Applicable(%) Mandatory Nominee 3 available 5,2 NEW NEW NEW

Mandatory if
Conditional Nominee 3 available
109 Nominee 3 DOB Date
Mandatory
DD/MM/YYYY 10 NEW NEW NEW

Nominee3 Minor Conditional Mandatory if

110 Varchar
Flag Mandatory Nominee 3 available 1 NEW NEW NEW

Nominee3 Conditional Mandatory if

111 Char
Guardian Mandatory Nominee 3 available 35 NEW NEW NEW

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 82

 (K/C/B/E) (K - KRA CKYC CKYC
Compliant C- CKYC field field
Primary Holder (10) (10) KYC Type First
112 Mandatory Compliant B- CHAR
KYC Type Holder
BIOMETRIC KYC E-
Aadhaar Ekyc PAN) 1

Primary Holder CKYC CKYC

Conditional Mandatory if primary
113 CKYC Numeric field field First Holder CKYC
Mandatory holder KYC type 'C' (3) (3)
Number 14 Number

(K/C/B/E) (K - KRA
Compliant C- CKYC CKYC CKYC
Second Holder KYC Type
114 Optional Compliant CHAR 1 field field
KYC Type Second Holder
B-BIOMETRIC KYC (11) (11)
E- Aadhaar Ekyc PAN)

Second Holder
Conditional Mandatory if second CKYC CKYC Second holder
115 CKYC Numeric 14 field field
Mandatory holder KYC type 'C' CKYC Number
(4) (4)
Number

(K/C/B/E) (K - KRA
Compliant C- CKYC CKYC CKYC
Third Holder KYC KYC Type Third
116 Optional Compliant CHAR 1 field field
Type Holder
B-BIOMETRIC KYC (12) (12)
E- Aadhaar Ekyc PAN)

Third Holder CKYC Conditional Mandatory if third CKYC CKYC Third holder CKYC
117 Numeric 14 field field
Number Mandatory holder KYC type 'C' Number
(5) (5)

(K/C/B/E) (K - KRA
Compliant C- CKYC CKYC CKYC
Guardian KYC field field KYC Type
118 Optional Compliant CHAR 1
Type Guardian
B-BIOMETRIC KYC (13) (13)
E- Aadhaar Ekyc PAN)

Guardian CKYC Conditional Mandatory if CKYC CKYC Guardian CKYC

119 Numeric 14 field field
Number Mandatory Guardian KYC type 'C' Number
(6) (6)

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 83

 Primary Holder
Conditional Mandatory if Primary
120 KRA Exempt Ref. Varchar
Mandatory Holder Pan Exempt
No. 10 NEW NEW NEW

Second Holder
Conditional Mandatory if Second
121 KRA Exempt Ref. Varchar
Mandatory Holder Pan Exempt
No. 10 NEW NEW NEW

Third Holder KRA Conditional Mandatory if Third

122 Varchar
Exempt Ref. No Mandatory Holder Pan Exempt 10 NEW NEW NEW

Guardian Exempt Conditional Mandatory if

123 Varchar
Ref. No Mandatory Guardian Pan Exempt 10 NEW NEW NEW

124 Aadhaar Updated Optional Y/N Char 1 NEW NEW NEW

125 Mapin Id. Optional varchar 16 44 63 MAPIN No.

Investor onboarding
126 Paperless_flag Mandatory Char 1
P- Paper/ Z- paperless NEW NEW NEW

Mandatory for Non -

Individual & HUF for
127 LEI No Optional Varchar
orders above Rs.50
crores 20 NEW NEW NEW

Conditional Mandatory if LEI No

128 LEI Validity Date
Mandatory is given 10 NEW NEW NEW

SE - Self
SP - Spouse
DC - Dependent
Children
DS - Dependent
Mandatory if Mobile
Filler 1 ( Mobile Siblings
129 Conditional No. Varchar 2 NEW NEW
Declaration Flag ) DP - Dependent
Mandatory provided
Parents
GD - Guardian
PM - PMS
CD - Custodian
PO - POA

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 84

 SE - Self
SP - Spouse
DC - Dependent
Children
Mandatory if Email DS - Dependent
Filler 2 (Email Id. provided Siblings
130 Conditional Varchar 2 NEW NEW
Declaration Flag ) DP - Dependent
Mandatory
Parents
GD - Guardian
PM - PMS
CD - Custodian
PO - POA

131 Filler 3

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 85

NEW CLIENT Parameter Validations

ACCOUNT TYPE

Account Code Description

SB Savings Bank
Current Bank
CB
NE NRE
NO NRO

CLIENT HOLDING

CODE DETAILS
SI Single
JO Joint
AS Anyone or Survivor

DIVIDEND PAYMODE
CODE Description
01 Cheque
02 Direct Credit
03 ECS
04 NEFT
05 RTGS

COMMUNICATION MODE

CODE DETAILS
P Physical
E Electronic
M MOBILE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 86

 TAX STATUS WITH ACCOUNT TYPE

Tax Code Tax Name Account Type

01 Individual SB/CB

02 On behalf of minor
SB/CB
03 HUF SB/CB
04 Company CB
05 AOP CB
06 Partnership Firm CB
07 Body Corporate CB
08 Trust CB
09 Society CB
10 Others CB
11 NRI-Others NE/NO
12 DIF CB
13 Sole Proprietorship SB/CB
21 NRE NE
22 OCB CB
23 FII NE/NO
24 NRO NO
25 Overseas Corp. Body - Others NE/NO
26 NRI Child NE/NO
27 NRI - HUF (NRO) NO
28 NRI - Minor (NRO) NO
29 NRI - HUF (NRE) NE
31 Provident Fund CB
32 Super Annuation Fund CB
33 Gratuity Fund CB
34 Pension Fund CB
36 Mutual Funds FOF Schemes CB
37 NPS Trust CB
38 Global Development Network NE/NO
39 FCRA NE/NO

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 87

 41 QFI - Individual NE/NO
42 QFI - Minors NE/NO
43 QFI - Corporate CB
44 QFI - Pension Funds CB
45 QFI - Hedge Funds CB
46 QFI - Mutual Funds CB
47 LLP CB
48 Non-Profit organization [NPO] CB
51 Public Limited Company CB
52 Private Limited Company CB
53 Unlisted Company CB
54 Mutual Funds CB
55 FPI - Category I NE/NO
56 FPI - Category II NE/NO
57 FPI - Category III NE/NO
58 Financial Institutions CB
59 Body of Individuals CB
60 Insurance Company CB
61 OCI - Repatriation NE
62 OCI - Non Repatriation NO
70 Person of Indian Origin NE/NO
72 Government Body CB
73 Defense Establishment CB
74 Non - Government Organisation CB
75 Bank/Co-Operative Bank CB
76 Seafarer NRE NE
77 Seafarer NRO NO

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 88

 TAX STATUS

Tax
Code Tax Name
01 Individual
02 On behalf of minor
03 HUF
04 Company
05 AOP
06 Partnership Firm
07 Body Corporate
08 Trust
09 Society
10 Others
11 NRI-Others
12 DFI
13 Sole Proprietorship
21 NRE
22 OCB
23 FII
24 NRO
25 Overseas Corp. Body - Others
26 NRI Child
27 NRI - HUF (NRO)
28 NRI - Minor (NRO)
29 NRI - HUF (NRE)
31 Provident Fund
32 Super Annuation Fund
33 Gratuity Fund
34 Pension Fund
36 Mutual Funds FOF Schemes
37 NPS Trust
38 Global Development Network
39 FCRA
41 QFI - Individual
42 QFI - Minors

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 89

 43 QFI - Corporate
44 QFI - Pension Funds
45 QFI - Hedge Funds
46 QFI - Mutual Funds
47 LLP
48 Non-Profit organization [NPO]
51 Public Limited Company
52 Private Limited Company
53 Unlisted Company
54 Mutual Funds
55 FPI - Category I
56 FPI - Category II
57 FPI - Category III
58 Financial Institutions
59 Body of Individuals
60 Insurance Company
61 OCI - Repatriation
62 OCI - Non Repatriation
70 Person of Indian Origin
72 Government Body
73 Defense Establishment
74 Non - Government Organisation
75 Bank/Co-Operative Bank
76 Seafarer NRE
77 Seafarer NRO

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 90

 OCCUPATION CODE

CODE DETAILS
01 Business
02 Services
03 Professional
04 Agriculture
05 Retired
06 Housewife
07 Student
08 Others

PAN EXEMPT CATEGORY

Category Description
01 SIKKIM Resident
02 Transactions carried out on behalf of STATE GOVT
03 Transactions carried out on behalf of CENTRAL GOVT
04 COURT APPOINTED OFFICIALS
05 UN Entity/Multilateral agency exempt from paying tax in India
06 Official Liquidator
07 Court Receiver
08 Investment in Mutual Funds Upto Rs. 50,000/- p.a. including SIP

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 91

 COUNTRY CODE

Code Country name

001 Afghanistan
002 Aland Islands
003 Albania
004 Algeria
005 American Samoa
006 Andorra
007 Angola
008 Anguilla
009 Antarctica
010 Antigua And Barbuda
011 Argentina
012 Armenia
013 Aruba
014 Australia
015 Austria
016 Azerbaijan
017 Bahamas
018 Bahrain
019 Bangladesh
020 Barbados
021 Belarus
022 Belgium
023 Belize
024 Benin
025 Bermuda
026 Bhutan
027 Bolivia
028 Bosnia And Herzegovina
029 Botswana
030 Bouvet Island

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 92

 031 Brazil
032 British Indian Ocean Territory
033 Brunei Darussalam
034 Bulgaria
035 Burkina Faso
036 Burundi
037 Cambodia
038 Cameroon
039 Canada
040 Cape Verde
041 Cayman Islands
042 Central African Republic
043 Chad
044 Chile
045 China
046 Christmas Island
047 Cocos (Keeling) Islands
048 Colombia
049 Comoros
050 Congo
051 Congo, The Democratic Republic Of The
052 Cook Islands
053 Costa Rica
054 Cote DIvoire
055 Croatia
056 Cuba
057 Cyprus
058 Czech Republic
059 Denmark
060 Djibouti
061 Dominica
062 Dominican Republic
063 Ecuador
064 Egypt
065 El Salvador

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 93

 066 Equatorial Guinea
067 Eritrea
068 Estonia
069 Ethiopia
070 Falkland Islands (Malvinas)
071 Faroe Islands
072 Fiji
073 Finland
074 France
075 French Guiana
076 French Polynesia
077 French Southern Territories
078 Gabon
079 Gambia
080 Georgia
081 Germany
082 Ghana
083 Gibraltar
084 Greece
085 Greenland
086 Grenada
087 Guadeloupe
088 Guam
089 Guatemala
090 Guernsey
091 Guinea
092 Guinea-Bissau
093 Guyana
094 Haiti
095 Heard Island And Mcdonald Islands
096 Holy See (Vatican City State)
097 Honduras
098 Hong Kong
099 Hungary
100 Iceland

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 94

 101 India
102 Indonesia
103 Iran, Islamic Republic Of
104 Iraq
105 Ireland
106 Isle Of Man
107 Israel
108 Italy
109 Jamaica
110 Japan
111 Jersey
112 Jordan
113 Kazakhstan
114 Kenya
115 Kiribati
116 Korea, Democratic Peoples Republic Of
117 Korea, Republic Of
118 Kuwait
119 Kyrgyzstan
120 Lao Peoples Democratic Republic
121 Latvia
122 Lebanon
123 Lesotho
124 Liberia
125 Libyan Arab Jamahiriya
126 Liechtenstein
127 Lithuania
128 Luxembourg
129 Macao
130 Macedonia, The Former Yugoslav Republic Of
131 Madagascar
132 Malawi
133 Malaysia
134 Maldives
135 Mali

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 95

 136 Malta
137 Marshall Islands
138 Martinique
139 Mauritania
140 Mauritius
141 Mayotte
142 Mexico
143 Micronesia, Federated States Of
144 Moldova, Republic Of
145 Monaco
146 Mongolia
147 Montserrat
148 Morocco
149 Mozambique
150 Myanmar
151 Namibia
152 Nauru
153 Nepal
154 Netherlands
155 Netherlands Antilles
156 New Caledonia
157 New Zealand
158 Nicaragua
159 Niger
160 Nigeria
161 Niue
162 Norfolk Island
163 Northern Mariana Islands
164 Norway
165 Oman
166 Pakistan
167 Palau
168 Palestinian Territory, Occupied
169 Panama
170 Papua New Guinea

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 96

 171 Paraguay
172 Peru
173 Philippines
174 Pitcairn
175 Poland
176 Portugal
177 Puerto Rico
178 Qatar
179 Reunion
180 Romania
181 Russian Federation
182 Rwanda
183 Saint Helena
184 Saint Kitts And Nevis
185 Saint Lucia
186 Saint Pierre And Miquelon
187 Saint Vincent And The Grenadines
188 Samoa
189 San Marino
190 Sao Tome And Principe
191 Saudi Arabia
192 Senegal
193 Serbia And Montenegro
194 Seychelles
195 Sierra Leone
196 Singapore
197 Slovakia
198 Slovenia
199 Solomon Islands
200 Somalia
201 South Africa
202 South Georgia And The South Sandwich Islands
203 Spain
204 Sri Lanka
205 Sudan

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 97

 206 Suriname
207 Svalbard And Jan Mayen
208 Swaziland
209 Sweden
210 Switzerland
211 Syrian Arab Republic
212 Taiwan, Province Of China
213 Tajikistan
214 Tanzania, United Republic Of
215 Thailand
216 Timor-Leste
217 Togo
218 Tokelau
219 Tonga
220 Trinidad And Tobago
221 Tunisia
222 Turkey
223 Turkmenistan
224 Turks And Caicos Islands
225 Tuvalu
226 Uganda
227 Ukraine
228 United Arab Emirates
229 United Kingdom
230 United States of America
231 United States Minor Outlying Islands
232 Uruguay
233 Uzbekistan
234 Vanuatu
235 Venezuela
236 Viet Nam
237 Virgin Islands, British
238 Virgin Islands, U.S.
239 Wallis And Futuna
240 Western Sahara

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 98

 241 Yemen
242 Zambia
243 Zimbabwe

STATES

CODE STATE
AN Andaman & Nicobar
AR Arunachal Pradesh
AP Andhra Pradesh
AS Assam
BH Bihar
CH Chandigarh
CG Chhattisgarh
GO GOA
GU Gujarat
HA Haryana
HP Himachal Pradesh
JM Jammu & Kashmir
JK Jharkhand
KA Karnataka
KE Kerala
MP Madhya Pradesh
MA Maharashtra
MN Manipur
ME Meghalaya
MI Mizoram
NA Nagaland
ND New Delhi
OR Orissa
PO Pondicherry

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 99

 PU Punjab
RA Rajasthan
SI Sikkim
TG Telengana
TN Tamil Nadu
TR Tripura
UP Uttar Pradesh
UC Uttaranchal
WB West Bengal
DN Dadra and Nagar Haveli
DD Daman and Diu
LD Lakshadweep
OH Others

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 100
 MUTUAL FUND StAR MF ENHANCED
STP REGISTRATION API MESSAGE
STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 101
 MUTUAL FUND StAR MF ENHANCED STP REGISTRATION API MESSAGE
STRUCTURE
Introduction

Currently the only STP available through API is an Exchange STP which is treated as systematic switch and
the transactions triggered are treated as switch by RTA. The new API allows an Additional ‘STP – AMC’
Product which is presently available only through the Exchange Website

The New API is a JSON based API Request and does not require a get password method for session
generation like the earlier APIs.

The document contains

1. The Structure of the various fields required by the API

2. Sample Exchange STP registration API request and response JSON body
3. Sample Exchange STP Cancellation API request and response JSON body
4. Sample AMC STP registration API request and response JSON body
5. Sample AMC STP Cancellation API request and response JSON body

The webservice Post URL is as given below

URL https://bsestarmfdemo.bseindia.com/StarMFFileUploadService/StarMFFileUploadService.svc

The following Header needs to be added in the request for Authorization

SrNo Header Description

1 APIKEY VmxST1UyRkhUbkpOVldNOQ==

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 102
 StAR MF Enhanced STP Registration API Structure

Request Field Parameters: (Field Details)

S. No Field Name Type Length Sample
1 Login Varchar 20
2 Member ID Varchar 20
3 Password Varchar 20
4 Transaction Type Varchar 3 NEW/ CXL
5 STP TYPE Varchar 4 EXCH/AMC
6 Client Code Varchar 10
7 From BSE Scheme Varchar 20
Code
8 To BSE Scheme Code Varchar 20
9 Buy / Sell Type Varchar 10 Fresh/Additional
10 Transaction Mode Varchar 1 P- Physical, (C- CDSL, N-NSDL
only for AMC STP)
11 Folio Number Varchar 15
12 STP registration No Bigint In case of fresh STP this field
should contain 0.
13 Internal Ref Number Varchar 10
14 Start Date Date 10
15 Frequency Type Varchar 20 Daily/ Weekly / Monthly /
Quarterly
16 No Of Transfers Int 8 In case of Daily 0
17 Installment Amount Numeric 25,3
18 Units Numeric
19 First Order Today Varchar 1 Y/N
20 Sub Broker Code Varchar 15
21 EUIN Declaration Varchar 1 Y/N
22 EUIN Number Varchar 7
23 Remarks Varchar 100
24 End Date Date 10 Only for Daily
25 Sub Broker - ARN Varchar 20
26 Filler1(Mobile No) Varchar 10 10 Digit Indian Mobile No.
used for verification.
Non-Mandatory.
27 Filler2( Email ID) Varchar 50 Email ID of the Client used
for verification.
Non-Mandatory.
28 Filler3 Varchar 100
29 Filler4 Varchar 100
30 Filler5 Varchar 100

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 103
 Response Field Parameters : (Field Details)

S.No Parameters Type Length Description Sample

1 Transaction code Varchar 3 Transaction Code as given
in the request
2 SWP registration no Bigint
3 Bse remarks Varchar 1000 Bse Response Return
remarks
4 Success flag Varchar 1 Order success flag 0 - Success &
1 - failure

5 Internal reference Varchar 20

number
6 From Order No Bigint From Order Registration No
(Only for First Order Today
EXCH STP)
7 To Order No Bigint To Order Registration No
(Only for First Order Today
EXCH STP)
8 Filler1 Varchar 100
9 Filler2 Varchar 100
10 Filler3 Varchar 100
11 Filler4 Varchar 100
12 Filler5 Varchar 100

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 104
StAR MF EXCHANGE & STP Registration and Cancellation API JSON Request &
Response
The webservice Post URL is as given below

URL https://bsestarmfdemo.bseindia.com/starmfapi/api/stp/stpregistration

SrNo Header Description

1 APIKEY VmxST1UyRkhUbkpOVldNOQ==

NEW EXCHANGE STP REGISTRATION

Request (JSON Format)

{
"LoginId" : "1000001",
"MemberCode" : "10000",
"Password" : "123456",
"TransType" : "NEW",
"STPType" : "EXCH",
"ClientCode" : "CLIENT1",
"FromBSESchemeCode" : "02-DP",
"ToBSESchemeCode" : "02G",
"BuySellType" : "Fresh",
"TransactionMode" : "P",
"FolioNo" : "112345",
"STPRegNo" : "",
"IntRefNo" : "123",
"StartDate" : "10/10/2021",
"FrequencyType" : "MONTHLY",
"NoOfTransfers" : "12",
"InstAmount" : "5000",
"InstUnit" : "",
"FirstOrderToday" : "Y",
"SubBrokerCode" : "",
"EUINDeclaration" : "N",
"EUINNumber" : "",
"Remarks" : "test",
"EndDate" : "",
"SubBrokerARN" : "",
MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 105
 "Filler1" : "",
"Filler2" : "",
"Filler3" : "",
"Filler4" : "",
"Filler5" : ""
}

Response (JSON Format)

{
"TransactionCode": "NEW",
"STPRegNo": "39409",
"BSERemarks": "STP REGISTRATION DONE SUCCESSFULLY",
"SuccessFlag": "0",
"IntRefNo": "123",
"FromOrderNo": "6309357",
"ToOrderNo": "6309358",
"Filler1": "",
"Filler2": "",
"Filler3": "",
"Filler4": "",
"Filler5": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 106
NEW EXCHANGE STP CANCELLATION

Request (JSON Format)

{
"LoginId" : "1000001",
"MemberCode" : "10000",
"Password" : "123456",
"TransType" : "CXL",
"STPType" : "EXCH",
"ClientCode" : "CLIENT1",
"FromBSESchemeCode" : "02-DP",
"ToBSESchemeCode" : "02G",
"BuySellType" : "Fresh",
"TransactionMode" : "P",
"FolioNo" : "112345",
"STPRegNo" : "",
"IntRefNo" : "123",
"StartDate" : "10/10/2021",
"FrequencyType" : "MONTHLY",
"NoOfTransfers" : "12",
"InstAmount" : "5000",
"InstUnit" : "",
"FirstOrderToday" : "Y",
"SubBrokerCode" : "",
"EUINDeclaration" : "N",
"EUINNumber" : "",
"Remarks" : "test",
"EndDate" : "",
"SubBrokerARN" : "",
"Filler1" : "",
"Filler2" : "",
"Filler3" : "",
"Filler4" : "",
"Filler5" : ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 107
Response (JSON Format)

{
"TransactionCode": "CXL",
"STPRegNo": "39409",
"BSERemarks": "STP CANCELLATION DONE SUCCESSFULLY",
"SuccessFlag": "0",
"IntRefNo": "123",
"FromOrderNo": "",
"ToOrderNo": "",
"Filler1": "",
"Filler2": "",
"Filler3": "",
"Filler4": "",
"Filler5": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 108
NEW AMC STP REGISTRATION

Request (JSON Format)

{
"LoginId" : "1000001",
"MemberCode" : "10000",
"Password" : "123456",
"TransType" : "NEW",
"STPType" : "AMC",
"ClientCode" : "CLIENT1",
"FromBSESchemeCode" : "CDOGR-GR",
"ToBSESchemeCode" : "HDACGPG-GR",
"BuySellType" : "Fresh",
"TransactionMode" : "P",
"FolioNo" : "112345",
"STPRegNo" : "",
"IntRefNo" : "123",
"StartDate" : "10/10/2021",
"FrequencyType" : "MONTHLY",
"NoOfTransfers" : "12",
"InstAmount" : "5000",
"InstUnit" : "",
"FirstOrderToday" : "Y",
"SubBrokerCode" : "",
"EUINDeclaration" : "N",
"EUINNumber" : "",
"Remarks" : "test",
"EndDate" : "",
"SubBrokerARN" : "",
"Filler1" : "",
"Filler2" : "",
"Filler3" : "",
"Filler4" : "",
"Filler5" : ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 109
Response (JSON Format)

{
"TransactionCode": "NEW",
"STPRegNo": "39410",
"BSERemarks": "AMC STP REGISTRATION DONE SUCCESSFULLY",
"SuccessFlag": "0",
"IntRefNo": "123",
"FromOrderNo": "6309430",
"ToOrderNo": "6309431",
"Filler1": "",
"Filler2": "",
"Filler3": "",
"Filler4": "",
"Filler5": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 110
NEW AMC STP CANCELLATION

Request (JSON Format)

{
"LoginId" : "1000001",
"MemberCode" : "10000",
"Password" : "123456",
"TransType" : "CXL",
"STPType" : "AMC",
"ClientCode" : "CLIENT1",
"FromBSESchemeCode" : "CDOGR-GR",
"ToBSESchemeCode" : "HDACGPG-GR",
"BuySellType" : "Fresh",
"TransactionMode" : "P",
"FolioNo" : "112345",
"STPRegNo" : "",
"IntRefNo" : "123",
"StartDate" : "10/10/2021",
"FrequencyType" : "MONTHLY",
"NoOfTransfers" : "12",
"InstAmount" : "5000",
"InstUnit" : "",
"FirstOrderToday" : "Y",
"SubBrokerCode" : "",
"EUINDeclaration" : "N",
"EUINNumber" : "",
"Remarks" : "test",
"EndDate" : "",
"SubBrokerARN" : "",
"Filler1" : "",
"Filler2" : "",
"Filler3" : "",
"Filler4" : "",
"Filler5" : ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 111
Response (JSON Format)

{
"TransactionCode": "CXL",
"STPRegNo": "39410",
"BSERemarks": "STP AMC CANCELLATION DONE SUCCESSFULLY",
"SuccessFlag": "0",
"IntRefNo": "123",
"FromOrderNo": "",
"ToOrderNo": "",
"Filler1": "",
"Filler2": "",
"Filler3": "",
"Filler4": "",
"Filler5": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 112
 MUTUAL FUND AOF IMAGE UPLOAD
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 113
MUTUAL FUND AOF IMAGE UPLOAD WEB SERVICES MESSAGE
STRUCTURE

The Mutual Fund Image Upload Web Service is available to upload the Account opening Form Image as
per format which has been provided in the Exchange Notice for the Members.

The Web Service through which Image Upload Web services request and response can be facilitated is
available at.

URL https://bsestarmfdemo.bseindia.com/StarMFFileUploadService/StarMFFileUploadService.svc

MUTUAL FUND AOF Image Upload Services Login Request

The Method used for MUTUAL FUND Image Upload Login Request is getPassword

Request Parameters
Parameters Type Length Sample Values Mandatory
User ID Varchar 20 12301 mandatory
Member ID Varchar 20 123 mandatory
Password Varchar 30 mf@abc mandatory
Passkey Varchar 10 abcdef1234 mandatory

MUTUAL FUND AOF Image Upload Login Request Response

The Method used for MUTUAL FUND Image Upload Login Request Response is getPassword

Response Parameters
Parameters Type Length Remarks
Filler Varchar Filler
ResponseString Varchar 500 Encrypted Password/Error Reason
Status Code Varchar 3 100- Success
101- Failure

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 114
Notes
1. Member has to be Authenticated before sending any messages
2. Pass Key Validity can be Time based or One Time.
3. Member will have to enter the Web Service ID and password provided to them with a pass key (
Alpha numeric with no special characters ) each time they login.
4. Pass key can be different each time they login
5. Once user provides all the above / required details and submits it the Exchange, a response code
will be sent to the member.
6. If the login is successful then response code “100” will be sent and also an encrypted password will
be sent to the member.
7. If the login is not successful then response code “101” will be sent.
8. This encrypted password will be unique each time the member logins into BSE web service.
9. Member has to use this encrypted password whenever they punches the order.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 115
MUTUAL FUND AOF IMAGE UPLOAD Services Login Request/Response Sample

Sample Request (SOAP Format)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:tem="http://tempuri.org/"
xmlns:star="http://schemas.datacontract.org/2004/07/StarMFFileUploadService">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/IStarMFFileUploadService/GetPassword</wsa:Action>
<wsa:To>https://bsestarmfdemo.bseindia.com/StarMFFileUploadService/StarMFFileUploadService.
svc/Secure</wsa:To></soap:Header>
<soap:Body>
<tem:GetPassword>
<tem:Param>
<star:MemberId>1234</star:MemberId>
<star:Password>Abc@123</star:Password>
<star:UserId>123401</star:UserId>
</tem:Param>
</tem:GetPassword>
</soap:Body>
</soap:Envelope>

Sample Response (SOAP Format)

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-
envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/IStarMFFileUploadService/GetPassword
Response</a:Action>
</s:Header>
<s:Body>
<GetPasswordResponse xmlns="http://tempuri.org/">
<GetPasswordResult xmlns:b="http://schemas.datacontract.org/2004/07/StarMFFileUplo
adService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<b:Filler i:nil="true"/>
<b:ResponseString>qRZoNjext+mCsLhbKHbguBKjP2tcx26mGoGICK3A==</b:ResponseString>
<b:Status>100</b:Status>
</GetPasswordResult>
</GetPasswordResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 116
Sample Request (JSON Format)

{
"MemberId":"1234",
"Password":"Abc@123",
"UserId":"123401"
}

Sample Response (JSON Format)

{
"Filler": null,
"ResponseString": "qRZoNjextpqCC0+NXhbKHvxR1fO6oJ9EeGRp4Beknxw==",
"Status": "100"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 117
MUTUAL FUND Image Upload Services Request
The Method used for MUTUAL FUND Image Upload Request is UploadFile

Request Parameters
Parameters Field Type Length Remarks
Flag Varchar 10 At Present Only UCC Will Come Here
User Id Varchar 20 Login Id
Encrypted Password Varchar 10 Encrypted Password
Member Code Varchar 20 Member Code
Client Code Varchar 10 Client Code
File Name Varchar 20 Image Name
Document Type Varchar 3 Nrm/Ria
Base64 String for SOAP based.
Base64 String
Filebytes Byte Array for JSON based. (Byte Array
or Byte Array
supporting only dot net)
Filler 1 Filler
Filler 2 Filler

MUTUAL FUND Image Upload Services Request Response

The Method used for MUTUAL FUND Image Upload Request Response is UploadFile

Response Parameters
Parameters Type Length Remarks
Filler Varchar Filler
ResponseString Varchar 500 Encrypted Password/Error Reason
Status Code Varchar 3 100- Success
101- Failure

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 118
MUTUAL FUND AOF IMAGE UPLOAD Services Request/Response Sample

Sample Request (SOAP Format)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:tem="http://tempuri.org/" xmlns:bses="http://schemas.datacontract.org/2004/07/StarMFFile
UploadService">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/IStarMFFileUploadService/UploadFile</wsa:Action>
<wsa:To>https://bsestarmfdemo.bseindia.com/StarMFFileUploadService/StarMFFileUploadService.svc
/Secure</wsa:To></soap:Header>
<soap:Body>
<tem:UploadFile>
<tem:data>
<bses:ClientCode>clientcode</bses:ClientCode>
<bses:DocumentType>NRM</bses:DocumentType>
<bses:EncryptedPassword>qRZoNjextpqbggg/CCjkrAt0+qOqKc0Im9Q==</bses:EncryptedPassword>
<bses:FileName>1234clientcode01082023.tiff</bses:FileName>
<bses:Filler1></bses:Filler1>
<bses:Filler2></bses:Filler2>
<bses:Flag>UCC</bses:Flag>
<bses:MemberCode>1234</bses:MemberCode>
<bses:UserId>123401</bses:UserId>
<bses:pFileBytes>/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRo
fHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyM
jIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAT3B4ADASIAAhEBAxEB/8QAHAAAAgMBAQEBAAAAAAA
AAAAAAwQBAgUGAAcI/8QAShAAAQQBAwMDAgQEBAUDAQIPAQACAxEEEiExBUFREyJhBnEUMoGRQqGxwRUjUtEHM2Lh8BYkc
vFDgpIlNFNjojVEcwgXVJPSsv/EABoBAAMBAQEBAAAAAAAAAAAAAAABAgMEBQb/xAAzEQEBAAICAgICAQMDAwMEAwAAAQI
RAyESMQRBEyJRBTJhFEJxI4GhkeHwJFKx0VPB8f/aAAwDAQACEQMRAD8A4eqNFFjaLsrresfSpc4y4TSQeW91zr8HJhfod
E8EbVpK8ng5+Pmm8a59Ks8BN4zCZm/JpKtBYaIII8hPYgL5GAGqcNyV1SJ0X9IlaWDL6E7CRdG0rJGYzZBq+U3iQmRwd2H
dZ5ddqxjdflY0bbkmaGncVuT+gWZP1olrmYwIvl55/QdlXJhaCA0VYN/dZLyYhTx7qTwymjy6GbM5kmsaS7/raHD9ivAkp
QS78pmN4IslVe0aEKvFKI9Vtu2kDfhB1b2qvftsUtEbklgGONBJd/EsjIymtut1aWXSKtZGXNZ/AvLyAM3Db4CIMRq8vJU
1xit8L34ZvheXlGjQcYIbscLy8loBuxwgPxwvLyNGVkxwlZVCPwNWlCNl5eVwGmqxXl5MgnpGfgry8gMTNOxXNZ55Xl5TT
c3mHlYeS7leXkBkzvKzZnry8nCJSPKA568vvfvnfkbnoSdKiULioteXkyRam15eQEqbXl5BpBVwvLyAK1EC8vINKgry8lT
VKqV5eUmqoK8vl5Bjgr1ry8g/JpKtBYaIII8hPYgL5GAGqcNyV1SJ0X9IlaWDL6E7CRdG0rJGYzZBq+U3iQmRwd2HdZ5dd
qxjdflY0bbkmaGncVuT+gWZP1olrmYwIvl55/QdlXJhaCA0VYN/xAAzEQEBAAICAgICAQMDAwMEAwAAAQIRAyESMQRBEyJ
RBTJhFEJxI4GhkeHwJFKx0VPB/9k=</bses:pFileBytes>
</tem:data>
</tem:UploadFile>
</soap:Body>
</soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 119
Sample Response (SOAP Format)

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-
envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/IStarMFFileUploadService/UploadFileR
esponse</a:Action>
</s:Header>
<s:Body>
<UploadFileResponse xmlns="http://tempuri.org/">
<UploadFileResult xmlns:b="http://schemas.datacontract.org/2004/07/StarMFFileUploa
dService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<b:Filler i:nil="true"/>
<b:ResponseString> IMAGE SAVED SUCCESSFULLY </b:ResponseString>
<b:Status>100</b:Status>
</UploadFileResult>
</UploadFileResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 120
Sample Request (JSON Format)

{
"ClientCode":"ucc01",
"DocumentType":"NRM",
"EncryptedPassword":"qRZoNjextpqriRa68i73jjrBPc3+HB2XjUod1tfHJzWy5MD4TPoWUQ==",
"FileName":"10996ucc0105042022.tiff",
"Filler1":"",
"Filler2":"",
"Flag":"UCC",
"MemberCode":"10996",
"UserId":"1099601",
"pFileBytes":[81,
109,
70,
122,
90,
83,
65,
50,
78,
67,
66,
84,
100,
72,
74,
108,
89,
87,
48,
61]
}

Sample Response (JSON Format)

{
"Filler": null,
"ResponseString": "IMAGE SAVED SUCCESSFULLY",
"Status": "100"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 121
MUTUAL FUND Image Upload Notice/ Naming Convention

The Image should contain the Account Opening Details, Further details are provided in the Notice.

URL:https://www.bseindia.com/markets/MarketInfo/DispNewNoticesCirculars.aspx?page=2016
0606-8

Notice Details

In order to provide ease to MFIs/MFDs, the Exchange is pleased to provide the following facilities:

I) Auto Filled AOF Download

MFIs/MFDs are given the provision to download Auto Filled Account Opening Form (AOF) in
pdf. The details shall be taken from the Client Master and shall be prepopulated in the AOF Form.

The provision to download Auto Filled Account Opening Form (AOF) in pdf format is available
on BSE StAR MF Platform in the following link :

Admin – AOF Download

II) Online Image upload facility

The images as a one-time process to be uploaded for all the Holders either at the Client Registration
level or at the time of order placement on T day before 4:30 pm. The BSE StAR MF Platform
shall automatically create the relevant files for all RTAs.

The provision to image upload is available on BSE StAR MF Platform in the following link :

Admin – Image Upload

The Client Code to be entered and the other details such as Client Name and Pan Number shall be
auto populated.

The format for image upload is : MemberCodeClientcodeDDMMYYYY.TIFF

Eg. Member code is 10000, Client code is 123456 and Date 3rd June 2016

Then the tiff file name should be 1000012345603062016.tiff

The Report for all the images uploaded is available in the following link :

Daily Downloads – New Reports – Image Upload Report .

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 122
 MUTUAL FUND SCAN IMAGE UPLOAD
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 123
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD WEBSERVICES MESSAGE
STRUCTURE

The Mutual Fund Scan Mandate Image Upload Web Service is available to upload the Image as per format
which has been provided in the Exchange Notice for the Members.

The Web Service through which Image Upload Web services request and response can be facilitated is
available at.

URL https://bsestarmfdemo.bseindia.com/StarMFFileUploadService/StarMFFileUploadService.svc

MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request

The Method used for MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request is
PasswordRequest

Request Parameters
Parameters Type Length Sample Values Mandatory
User id Varchar 20 123401 mandatory
Memberid Varchar 20 1234 mandatory
Password Varchar 30 Abc@123 mandatory

MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request

Response
The Method used for MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request Response is
PasswordRequest

Response Parameters
Parameters Type Length Remarks
Filler Varchar Filler
ResponseString Varchar 500 Encrypted Password/Error Reason
Status Code Varchar 3 100- Success
101- Failure

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 124
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login
Request/Response Sample

Sample Request (SOAP Format)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:tem="http://tempuri.org/"
xmlns:star="http://schemas.datacontract.org/2004/07/StarMFFileUploadService">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/IStarMFFileUploadService/GetPassword</wsa:Action>
<wsa:To>https://bsestarmfdemo.bseindia.com/StarMFFileUploadService/StarMFFileUploadService.
svc/Secure</wsa:To></soap:Header>
<soap:Body>
<tem:GetPassword>
<tem:Param>
<star:MemberId>1234</star:MemberId>
<star:Password>Abc@123</star:Password>
<star:UserId>123401</star:UserId>
</tem:Param>
</tem:GetPassword>
</soap:Body>
</soap:Envelope>

Sample Response (SOAP Format)

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-
envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/IStarMFFileUploadService/GetPassword
Response</a:Action>
</s:Header>
<s:Body>
<GetPasswordResponse xmlns="http://tempuri.org/">
<GetPasswordResult xmlns:b="http://schemas.datacontract.org/2004/07/StarMFFileUplo
adService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<b:Filler i:nil="true"/>
<b:ResponseString>qRZoNjext+mCsLhbKHbguBKjP2tcx26mGoGICK3A==</b:ResponseString>
<b:Status>100</b:Status>
</GetPasswordResult>
</GetPasswordResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 125
Sample Request (JSON Format)

{
"MemberId":"1234",
"Password":"Abc@123",
"UserId":"123401"
}

Sample Response (JSON Format)

{
"Filler": null,
"ResponseString": "qRZoNjextpqCC0+NXhbKHvxR1fO6oJ9EeGRp4Beknxw==",
"Status": "100"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 126
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request
The Method used for MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request is
MandateScanFileData

Request Parameters
Parameters Type Length Remarks
Flag SCAN_MANDATE
Member code Varchar 20
Client code Varchar 10
Mandate ID Varchar 20
Imagename Varchar 100
Mandate type Varchar 5 XSIP
Image type Varchar 11
Encrypted password 500
Pfilebytes
Filler1 (Utility Code) Varchar 500
Filler2 (Agency Code) Varchar 500

MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request Response

The Method used for MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request Response is
MandateScanFileData

Response Parameters
Parameters Type Length Remarks
Filler Varchar Filler
ResponseString Varchar 500 Encrypted
Password/Error Reason
Status Code Varchar 3 100- Success
101- Failure

Values for Utility Code & Sponsor Bank Code

Utility Code Agency Code

YESB00709000028661 FINLOGIC

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 127
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Service Request/Response
Sample

Sample Request (SOAP Format)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-
envelope" xmlns:tem="http://tempuri.org/" xmlns:star="http://schemas.datacontract.org/
2004/07/StarMFFileUploadService">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"><wsa:Action>http://tempu
ri.org/IStarMFFileUploadService/UploadMandateScanFile</wsa:Action><wsa:To>https://bses
tarmfdemo.bseindia.com/StarMFFileUploadService/StarMFFileUploadService.svc/Secure</wsa
:To></soap:Header>
<soap:Body>
<tem:UploadMandateScanFile>
<tem:Data>
<star:ClientCode>clientcode</star:ClientCode>
<star:EncryptedPassword>qRZoNjextpqCC0+NbUXxnhwq2uaA==</star:EncryptedPassword>
<star:Filler1>YESB00709000028661</star:Filler1>
<star:Filler2>FINLOGIC</star:Filler2>
<star:Flag>SCAN_MANDATE</star:Flag>
<star:ImageName>564789.tiff</star:ImageName>
<star:ImageType>image/tiff</star:ImageType>
<star:MandateId>564789</star:MandateId>
<star:MandateType>XSP</star:MandateType>
<star:MemberCode>10996</star:MemberCode>
<star:pFileBytes>/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw
8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAT3B4ADASIAAhEBAxEB/8
QAHAAAAgMBAQEBAAAAAAAAAAAAAwQBAgUGAAcI/8QAShAAAQQBAwMDAgQEBAUDAQIPAQACAxEEEiExBUFREyJh
BnEUMoGRQqGxwRUjUtEHM2Lh8BYkcvFDgpIlNFNjojVEcwgXVJPSsv/EABoBAAMBAQEBAAAAAAAAAAAAAAABAg
MEBQb/xAAzEQEBAAICAgICAQMDAwMEAwAAAQIRAyESMQRBEyJRBTJhFEJxI4GhkeHwJFKx0VPB8f/aAAwDAQAC
EQMRAD8A4eqNFFjaLsrresfSpc4y4TSQeW91zr8HJhfodE8EbVpK8ng5+Pmm8a59Ks8BN4zCJ0X9IlaWDL6E7C
RdG0rJGYzZBq+U3iQmRwd2HdZ5ddqxjdflY0bbkmaGncVuT+gWZP1olrmYwIvl55/QdlXJhaCA0VYN/dZLyYhT
x7qTwymjy6GbM5kmsaS7/raHD9ivAkpQS78pmN4IslVe0aEKvFKI9Vtu2kDfhB1b2qvftsUtEbklgGONBJd/Es
jIymtut1aWXSKtZGXNZ/MqxxXjEzZb3GrpLbvKlrHbEjkWEzFFq7K7dLvSceBrr1EtppIpt2ew+PumWw1wEWGH
43TIiWGWVrO0o2JXERAoJoRIrYu1crPdIj6JHZMxY0rcf1/Rk9Eyel6uk6ddatN8XW9JkwEEtIog0QjiXI/Afg
vVf+FE3riK/aH6dN/9k=</star:pFileBytes>
</tem:Data>
</tem:UploadMandateScanFile>
</soap:Body>
</soap:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 128
Sample Response (SOAP Format)

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-
envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/IStarMFFileUploadService/Upl
oadMandateScanFileResponse</a:Action>
</s:Header>
<s:Body>
<UploadMandateScanFileResponse xmlns="http://tempuri.org/">
<UploadMandateScanFileResult xmlns:b="http://schemas.datacontract.org/2004
/07/StarMFFileUploadService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<b:Filler i:nil="true"/>
<b:ResponseString>IMAGE SAVED SUCCESSFULLY</b:ResponseString>
<b:Status>100</b:Status>
</UploadMandateScanFileResult>
</UploadMandateScanFileResponse>
</s:Body>
</s:Envelope>

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 129
Sample Request (JSON Format)

{
"ClientCode":"ucc01",
"EncryptedPassword":"qRZoNjextpqriRa68i73jjrBPc3+HB2XTAT5OrUhxZ0STiUN1eTA7g==",
"Filler1":"YESB00709000028661",
"Filler2":"FINLOGIC",
"Flag":"SCAN_MANDATE",
"ImageName":"751518.tiff",
"ImageType":"image/tiff",
"MandateId":"751518",
"MandateType":"",
"MemberCode":"10996",
"pFileBytes":[81,
109,
70,
122,
90,
83,
65,
50,
78,
67,
66,
84,
100,
72,
74,
108,
89,
87,
48,
61]
}

Sample Response (JSON Format)

{
"Filler": null,
"ResponseString": "IMAGE SAVED SUCCESSFULLY",
"Status": "100"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 130
MUTUAL FUND Scan Image Upload Notice for Naming Convention & Format
The Notice contains the Image Naming Convention & format.

URL:
https://www.bseindia.com/markets/MarketInfo/DispNewNoticesCirculars.aspx?page=20180215-
14

Notice Details

This is with reference to our Notice No. 20140514-3 dated May 14, 2014 on Launch of XSIP facility on BSE
StAR MF and Notice No. 20151130-25 dated November 30, 2015 on Introduction of new NACH/ECS
Mandate Form for XSIP Facility, wherein the process of Mandate Registration was explained.
The Exchange is pleased to inform about the introduction of Scan-Mandate on BSE StAR MF platform for
MFIs/MFDs/RIAs. This facility shall be made available with effect from Feb 15, 2018. Members must
ensure that the mandate has to be scanned as per the following specification, else, it may get rejected by
the NPCI.
Path: Systematic Investment >> Mandate >> Scan Mandate Upload
• Naming convention of the file format:
“Mandateid”
E.g. 662255
• The mandate has to be as per NPCI’s format i.e. 8” * 3 2/3”.
• It is mandatory to restrict the mandate size/format to below mentioned specification:
A) TIFF Image
• The Image should be in black & white.
• The Image should be in TIFF Format
• DPI for the Image is 200
• The Image size is less than 30kb for TIFF
B) JPEG Image
• The Image should be in grayscale.
• The Image should be in JPEG Format.
• DPI for the Image should be 100.
• The Image size is less than 30kb for JPEG.
Members must also ensure that the mandate has to be processed either in PHYSICAL OR in SCAN
MODE. E.g. If the mandate Number 12345 is already given as SCAN MANDATE, it cannot be given again
in PHYSICAL MODE and vice versa.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 131
 MUTUAL FUND DIRECT PAYMENT
GATEWAY REQUEST AND RESPONSE
SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 132
MUTUAL FUND DIRECT PAYMENT GATEWAY MESSAGE STRUCTURE
(Depreciated – Legacy Use only use the Single Payment Gateway API)

This API has been superseded by the Single Payment API and is available for
legacy use only

In Addition to the Existing Payment Gateway Services the exchange provides the facility in which the
member/ vendor allow his Clients to directly select the orders and Bank Details and access the Bank
Payment Gateway from their application itself.

The Web Service through which Direct Bank Payment Gateway request and response can be facilitated is
available at.

URL https://bsestarmfdemo.bseindia.com/StarMFPaymentGatewayService/StarMFPaymentGatewayService.svc

Description:

- Login details:
• Login id
• Member id
• Password
• Passkey

- Order\payment details
• Member code
• Client code
• Mode of payment
• Bank ID
• Account number
• IFSC
• Order number(s)
• Total amount
• Logout url

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 133
 ❖ Mode of payment and bank ID is available as a bank mapping table.
❖ IF there are multiple order for a client then the order numbers can be sent in either of the two
format:
• Plain Text - If given in plane text then the multiple order numbers can be given in one
row only with splitter.
• JSON - If given in JSON format then order numbers can be passed in array

Sample structure

Plain Text:

Member code| client code| mode of payment|Bank ID| account number| IFSC| order number1, order
number 2, order number 3|logout URL

JSON:

Member code =””

Client code =””

Mode of payment = “”

Bank id = “”

Account number = “”

IFSC = “”

Order number(s) = {order number 1, order number 2, order number 3}

Logout URL = “”

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 134
DIRECT PAYMENT GATEWAY Authentication
MUTUAL FUND DIRECT PAYMENT GATEWAY Authentication Request

Request parameters

Parameters Type Length Sample Values Mandatory

Web Service Id Varchar 20 12301 mandatory
Memberid Varchar 20 123 mandatory
Password Varchar 30 mf@abc mandatory
Passkey Varchar 20 abcdef1234 mandatory

MUTUAL FUND DIRECT PAYMENT GATEWAY Authentication Request

Response

Parameters Type Length Remarks

Filler Varchar 100
Authentication Success Code Varchar 3 100- Success
101- Failure
Encrypted Password/Error Reason Varchar 500

Notes

1. Member has to be Authenticated before sending any messages

2. Pass Key Validity can be Time based or One Time.
3. Member will have to enter the Web Service ID and password provided to them with a pass key (
Alpha numeric with no special characters ) each time they login.
4. Pass key can be different each time they login
5. Once the member provides all the above / required details and clicks on the submit button, a
response code will be sent to the user.
6. If the login is successful then response code “100” will be sent and also an encrypted password will
be sent to the user.
7. If the login is not successful then response code “101” will be sent.
8. This encrypted password will be unique each time the member logins into BSE web service.
9. Member has to use this encrypted password whenever places request for Additional Services.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 135
DIRECT PAYMENT GATEWAY URL Request

MUTUAL FUND DIRECT PAYMENT GATEWAY URL Request

Parameters Type Length Remarks

Member Code varchar 20
Client Code varchar 10
Mode Of Payment varchar 10 DIRECT/NODAL
Bank Id varchar 5
Account Number varchar 20
IFSC varchar 11
Order Number(s) varchar
Total Amount MONEY
Logout Url varchar 1000

MUTUAL FUND DIRECT PAYMENT GATEWAY URL Request Response

Parameters Type Length Remarks

FILLER 100
Bank Page in
Response String
HTML format
100- success
Status Code varchar 3
101- failure

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 136
ERROR CODES

PARAMETERS DESCRIPTION
when user passes values other than "DIRECT/NODAL" in
INVALID PAYMENT MODE mode column
when user passes wrong encrypted password or when user
passes the encrypted password which was generated for last
PASSWORD EXPIRED session
INVALID MEMBER CODE when user passes wrong member code
INVALID CLIENT CODE when user passes wrong client code
when user passes wrong account number i.e. the same is not
INVALID CLIENT ACCOUNT NUMBER match with client master
SELECT AT LEAST ONE ORDER when user doesn't select any order number for payment
when user passes the wrong order number or that order
number that is not associated to client for which the payment
INVALID ORDER NUMBER has to be initiated
when the amount doesn't match with the total amount of the
INVALID TOTAL ORDER AMOUNT orders that are sent
ORDER NUMBER ALLREADY when user passes the order number for whim the payment
INITIATED has already been initiated
PAYMENT DONE FOR THIS ORDER when user passes the order number for whim the payment
NUMBER has already been done
INVALID LOGOUT URL FORMAT when user passes the invalid urn format
when user passes wrong encrypted password or when user
passes the encrypted password which was generated for last
INVALID ENCRYPTED PASSWORD session

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 137
 MUTUAL FUND CHILD ORDER
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 138
MUTUAL FUND CHILD ORDER WEB SERVICES MESSAGE STRUCTURE

The Mutual Fund Child Order Web Service is available to fetch the orders details generated as
installments for the SIP/XSIP/ISIP/STP/SWP order types using the Child Order Service for the Members.

The Web Service through which Child Order Web services request and response can be facilitated is
available at.

URL https://bsestarmfdemo.bseindia.com/StarMFWebService/StarMFWebService.svc

MUTUAL FUND Child Order Services Login Request

The Method used for MUTUAL FUND Child Order Login Request is GetPasswordForChildOrder >
PasswordRequest

REQUEST STRUCTURE
Parameters Type Length Sample Values
MemberId Varchar 20 123
Passkey Varchar 10 abcdef1234
Password Varchar 30 mf@abc
RequestType Varchar 20 ChildOrder
UserId Varchar 20 12301

MUTUAL FUND Child Order Login Request Response

The Method used for MUTUAL FUND Child Order Login Request Response is
GetPasswordForChildOrderResponse > Response

RESPONSE STRUCTURE
Parameters Type Length Remarks
Status Code Varchar 3 100- Success
101- Failure
Encrypted Password/Error Reason Varchar 500

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 139
Notes
1. Member has to be Authenticated before sending any messages
2. Pass Key Validity can be Time based or One Time.
3. Member will have to enter the Web Service ID and password provided to them with a pass key (
Alpha numeric with no special characters ) each time they login.
4. Pass key can be different each time they login
5. Once user provides all the above / required details and submits it the Exchange, a response code
will be sent to the member.
6. If the login is successful then response code “100” will be sent and also an encrypted password will
be sent to the member.
7. If the login is not successful then response code “101” will be sent.
8. This encrypted password will be unique each time the member logins into BSE web service.
9. Member has to use this encrypted password whenever they punches the order.

MUTUAL FUND Child Order Login Request/Response Sample

REQUEST PARAMETER (JSON Format)

{
"MemberId":"99999",
"PassKey":"BSE",
"Password":"Abc@123",
"RequestType":" CHILDORDER ",
"UserId":"9999901"
}

RESPONSE PARAMTER (JSON Format)

{
"Filler": null,
"ResponseString":" ScGpdNmUHi5rA5PitbWz3lpDbIGAVSlnIEOuzCXppiza3HyKXCv10A==",
"Status": "100"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 140
MUTUAL FUND Child Order Services Request
The Method used for MUTUAL FUND Child Order Services Request is ChildOrderDetails >
ChildOrderRequest

REQUEST STRCUTURE

Parameters Type Length Sample Values

ClientCode Varchar Ucc0123
Date Varchar DD MMM YYYY
EncryptedPassword Varchar encrypted password
MemberCode Varchar 20 123
RegnNo Varchar Systematic plan registration no.
SystematicPlanType Varchar SIP/XSIP/ISIP/STP/SWP

MUTUAL FUND Child Order Services Response

The Method used for MUTUAL FUND Child Order Services Response is ChildOrderDetailsResponse
> ChildOrderResponse

RESPONSE STRUCTURE

Parameters Type Length Remarks

ChildOrderDetails Varchar max Child Order Details in the form of array

Message Varchar 100 Success/Error Verbose Message

100 - success
Status Varchar 3
101 - failure

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 141
MUTUAL FUND Child Order Services Request/Response Sample

REQUEST PARAMETER (JSON Format)

"Date": "07 JUL 2017",

"MemberCode": "99999",
"ClientCode": "457",
"SystematicPlanType": "XSIP" SystematicPlanType ( SIP, XSIP, ISIP, STP, SWP)
"RegnNo": "75342",
"EncryptedPassword": "ScGpdNmUHi5rA5PitbWz3lpDbIGAVSlnIEOuzCXppiza3HyKXCv10A==",
}

RESPONSE PARAMETER (JSON Format)

{
"ChildOrderDetails": [{
Amount: "500.0000",
BSESchemeCode: "539-GR",
BuySell: "P",
BuySellType: "FRESH",
ClientCode: "457",
ClientName: "rajesh singhal",
DPTxnType: "P",
EUINFlag: "Y",
EUINNumber: "E123465",
FirstOrderTodayFlag: "N",
FolioNo: "1485369",
IntRefNo: "1",
KYCFlag: "Y",
MemberCode: "99999",
OrderNumber: "758516",
OrderType: "XSP",
Quantity: "0.0000",

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 142
 RTASchemeCode: "539",
SchemeName: "DSP BLACKROCK DYNAMIC ASSET ALLOCATION FUND - REGULAR -
GROWTH",
SubBrokerARNCode: "ARN-159357",
SubBrokerCode: "",
SubOrderType: "NRM"
}],
"Message": "Child Order Details for Registration Number : 75342",
"Status": "100" ( 100 : Success , 101 : Failure)

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 143
 MUTUAL FUND MANDATE STATUS
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 144
MUTUAL FUND MANDATE STATUS WEB SERVICES AUTHENTICATION
MESSAGE STRUCTURE

The Mutual Fund Mandate Status Web Service is available to fetch the Status of an individual Mandate
or a list of mandates as per filters defined by the Members.

The Web Service through which Mandate Status Web services request and response can be facilitated is
available at.

URL https://bsestarmfdemo.bseindia.com/StarMFWebService/StarMFWebService.svc

MUTUAL FUND Mandate Status Services Login Request

The Method used for MUTUAL FUND Mandate Status services Request is GetAccessToken >
PasswordRequest

REQUEST STRUCTURE
Parameters Type Length Sample Values
Requesttype Varchar 20 Mandate
UserId Varchar 20 12301
Memberid Varchar 20 123
Password Varchar 30 mf@abc
Passkey Varchar 20 abcdef1234

MUTUAL FUND Mandate Status Login Request Response

RESPONSE STRUCTURE
Parameters Type Length Remarks
100- success
Status code Varchar 3
101- failure
Encrypted password/error
Varchar 500
reason

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 145
MUTUAL FUND Mandate Status Login Request/Response Sample

REQUEST PARAMETER (JSON Format)

{
"RequestType":"MANDATE",
"UserId": "457",
"MemberId": "99999",
"Password": "@1234",
"PassKey": "BSE"
}

RESPONSE PARAMETER (JSON Format)

{
"Filler": null,
"ResponseString": "ScGpdNmUHi5rA5PitbWz3lpDbIGAVSlnIEOuzCXppiza3HyKXCv10A=="
"Status": "100"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 146
MUTUAL FUND MANDATE STATUS WEB SERVICES MESSAGE STRUCTURE

MUTUAL FUND Mandate Status Services Request

The Method used for MUTUAL FUND Mandate Status Services Request is MandateDetailsRequest

REQUEST STRUCTURE
Parameters Type Length Remarks
From date Varchar 10 DD/MM/YYYY
To date Varchar 10 DD/MM/YYYY
Member code Varchar 10
Client code Varchar 10
Mandate ID Varchar 15

MUTUAL FUND Mandate Status Services Request Response

RESPONSE STRUCTURE
Particulars Type Length Remarks
Mandate code Varchar 10
Client code Varchar 10
Client name Varchar 70
Member code Varchar 10
Bank name Varchar 200
Bank branch Varchar 200
Amount Money
Regn date Date 11 MMM DD YYYY HH:MM:SS
Status Varchar 100 status table
Umrn no Varchar 40
Remarks Varchar 1000
Approved date Date DD/MM/YYYY
Bank account number Varchar 20
Mandate collection type Varchar 50
Mandate type Varchar 10 ISIP/XSIP
Date of upload Date MMM DD YYYY HH:MM:SS

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 147
Status Table

STATUS TABLE
REGISTERED BY MEMBER
APPROVED
REJECTED
INITIAL REJECTION
UNDER PROCESSING
RETURNED BY EXCHANGE
RECEIVED BY SPONSOR BANK
REJECTION AT NPCI PRIOR TO DESTINATION BANK
CANCELLED BY INVESTOR
APPROVED BY SPONSOR BANK
REJECTED BY SPONSOR BANK

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 148
MUTUAL FUND Mandate Status Service Request/Response Sample

REQUEST PARAMETER (JSON Format)

{
"FromDate": "01/01/2018",
"ToDate":"30/01/2018",
"MemberCode": "99999",
"ClientCode": "457",
"MandateId": "", (Optional)
"EncryptedPassword": "ScGpdNmUHi5rA5PitbWz3lpDbIGAVSlnIEOuzCXppiza3HyKXCv10A==",

RESPONSE PARAMETER (JSON Format)

{
"MandateDetails": [{
"MandateId": "2654",
"ClientCode": "789",
"ClientName": "test ban PAN client",
"MemberCode": "10073",
"BankName": "HDFC BANK",
"BankBranch": "TULSIANI CHMBRS - NARIMAN PT",
"Amount": "5000.0000",
"RegnDate": "Jan 20 2018 4:12PM",
"Status": "RECEIVED BY EXCHANGE AND ASSIGNED TO HSBC BANK",
"UMRNNo": "",
"Remarks": "",
"ApprovedDate": "",
"BankAccNo": "102369874123",
"CollectionType": "",
"MandateType": "XSP",
"UploadDate": ""
}],
"Message": "Mandate Details ",
"Status": "100" ( 100 : Success , 101 : Failure)
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 149
MUTUAL FUND Mandate Status Service Request/Response Error Codes

Error Codes Description

FAILED: INVALID FROM DATE If the user passes invalid from date
FAILED: INVALID TO DATE If the user passes invalid to date
FAILED: USER NOT EXISTS When wrong user ID is given
FAILED: INVALID MEMBER CODE When user passes wrong member code
FAILED: INVALID CLIENT CODE FOR When user passes the client code that is not mapped to the
GIVEN MEMBER CODE member
FAILED: ACCESS TOKEN EXPIRED When the user passes the wrong token
FAILED: INVALID MANDATE ID When user passes the wrong mandate ID
FAILED: INVALID MANDATE ID FOR
GIVEN MEMBER CODE AND CLIENT
CODE When user passes the mandate ID that Is not mapped to client

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 150
 MUTUAL FUND REPORTS
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 151
- MUTUAL FUND PROVISIONAL ORDER MESSAGE STRUCTURE
This API has been DEPRECIATED and is no longer Available

MUTUAL FUND ORDER STATUS REPORT MESSAGE STRUCTURE

The Mutual Fund Order Status Web Service is available to fetch the Order Status of an individual Order
or a list of Orders as per filters for a specific date defined by the Members.

The Web Service through which Order Status Web services request and response can be facilitated is
available at.

URL https://bsestarmfdemo.bseindia.com/StarMFWebService/StarMFWebService.svc

MUTUAL FUND Order Status Services Request

The Method used for MUTUAL FUND Order Status services Request is OrderStatus >
OrderRequest

Request parameters

Parameters Type Length Mandatory-non- Remarks

mandatory
Member Code Varchar 10 mandatory
UserID Varchar 20 mandatory
Password Varchar 30 mandatory
From Date Varchar 10 mandatory DD/MM/YYYY Same as from Date
To Date Varchar 10 mandatory DD/MM/YYYY Same as to Date
Client Code Varchar 20 non-mandatory
Transaction Type Varchar 5 conditional P/R
Order type Varchar 10 mandatory All/NRM/SIP/XSIP/ISIP/STP/SWP
Sub - Order type Varchar 10 mandatory All/NRM/SPOR/SWITCH
Order Status Varchar 10 mandatory All/VALID/INVALID
Settlement Type Varchar 10 mandatory ALL/L0/L1/OTHERS
If Order ID is sent all other Fields are
Order No Varchar 20 non-mandatory ignored.
Filler 1 non-mandatory
Filler 2 non-mandatory
Filler 3 non-mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 152
MUTUAL FUND Order Status Request Response
The Method used for MUTUAL FUND Order Status Report Web services Response is
OrderStatusResponse > OrderResponse

Parameters Type Length Remarks

100- success
Status code Varchar 3
101- failure

Encrypted password/error reason Varchar 500

Param

Parameters
The Method used for MUTUAL FUND Order Status Report Web services Response is
ArrayOfOrderDetails > OrderDetails

S. No Field Name Type Size Remarks

1 Member Code Varchar 10

2 Date DATE DD/MM/YYYY

3 Time VARCHAR 8 HH:MI:SS
4 Order No. Varchar 16
5 Sett. No. VARCHAR 7 0901 - Financial Year000N - Sr No
6 Client Code Varchar 10
7 Client Name Varchar 100

8 Scheme Code Varchar 20

9 Scheme Name Varchar 200

10 Isin Varchar 12
P - PURCHASE
11 Buy/Sell Varchar 1
R - REDEMTION
12 Amount NUMERIC 2 DECIMALS
13 Units NUMERIC 3 DECIMALS
14 Dp Trans. Varchar 10 PHYSICAL / DEMAT

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 153
15 Dp/Folio No. Varchar 16
16 Folio No. Varchar 16
17 Entry By Varchar 20
18 Order Status Varchar 10 VALID / INVALID

19 Order Remark Varchar 200

20 Internal Ref No Varchar 10

21 Settlement Type Varchar 2

22 Order Type Varchar 3 NRM/SIP

23 Sip Regn No Bigint

24 Sip Regn Date Date DD/MM/YYYY

25 Subbrcode Varchar 15
26 Euin Varchar 10
27 Euin Decl Varchar 1

28 All Units Flag Varchar 1

29 Dpc Flag Varchar 1 Y

30 Order Sub Type Varchar 6 NRM/SWITCH/SPREAD

31 First Order Today Varchar 1 Y/N

Purchase /
32 Redeem(Fresh Char 10 Fresh/Additional
/Additional)

33 Member Remarks Char 200 Max 200 chars

Y or N. Mandatory in case of any purchases above

34 KYC Flag Char 1
Rs.50000/-

Y or N. Mandatory field. In case of purchases it

should be a N. in case of any redemption above
35 MIN Redemption Flag Char 1
50 units it should be N, in case of units below 50
units it should be Y. Will be N in case of Physical.

36 Sub- Broker ARN Varchar 20 non - mandatory field, it should start with ARN

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 154
ERROR CODES
ERROR CODES DESCRIPTION
FAILED: USER ID MANDATORY Blank User ID
FAILED: MEMBER CODE MANDATORY Blank Member ID
FAILED: PASSWORD MANDATORY Blank Password
FAILED: USER IS DISABLED. CONTACT ADMIN when the user ID is disabled
FAILED: YOU HAVE EXCEEDED MAXIMUM LOGIN
ATTEMPTS. CONTACT ADMIN when the user has put wrong password
FAILED:INVALID ACCOUNT INFORMATION when invalid credentials are passed
FAILED: THE MEMBER IS SUSPENDED. CONTACT ADMIN when the member is suspended
FAILED: ACCESS TEMPORARILY SUSPENDED. KINDLY BEAR
WITH US when the user ID is disabled
FAILED: LOGIN PASSWORD EXPIRED. KINDLY RESET LOGIN
PASSWORD when the user has put wrong password
when the date format is not passed in
FAILED: INVALID FROM DATE proper format
when the date format is not passed in
FAILED: INVALID TO DATE proper format
when the client code is not mapped to
FAILED: INVALID CLIENT CODE FOR GIVEN MEMBER CODE member code given the request string
when the user passes wrong transaction
FAILED: INVALID TRANSACTION TYPE type
FAILED: INVALID ORDER TYPE when the user passes wrong order type
FAILED: INVALID ORDER STATUS when the user passes wrong order status
when the user passes wrong settlement
FAILED: INVALID SETTLEMENT TYPE type
when the user does not exist in BSE
FAILED: USER NOT EXISTS starmf system

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 155
MUTUAL FUND ALLOTMENT STATEMENT MESSAGE STRUCTURE

The Mutual Fund Allotment Statement Web Service is available to fetch the Allotment Statement Report
of an individual Order or a list of Orders as per filters for a specific date defined by the Members.

The Web Service through which Allotment Statement Web services request and response can be
facilitated is available at.

URL https://bsestarmfdemo.bseindia.com/StarMFWebService/StarMFWebService.svc

MUTUAL FUND Allotment Statement Services Request

The Method used for MUTUAL FUND Allotment Statement services Request is AllotmentStatement
> AllotmentStatementRequest

Request parameters

Parameters Type Length Mandatory-non- Remarks

mandatory
Member Code Varchar 10 mandatory
UserID Varchar 20 mandatory
Password Varchar 30 mandatory
From Date Varchar 10 mandatory DD/MM/YYYY Same as from Date
To Date Varchar 10 mandatory DD/MM/YYYY Same as to Date
Client Code Varchar 20 non-mandatory
Transaction Type Varchar 5 conditional P/R
Order type Varchar 10 mandatory All/NRM/SIP/XSIP/ISIP/STP/SWP
Sub - Order type Varchar 10 mandatory All/NRM/SPOR/SWITCH
Order Status Varchar 10 mandatory All/VALID/INVALID
Settlement Type Varchar 10 mandatory ALL/L0/L1/OTHERS
If Order ID is sent all other Fields
Order No Varchar 20 non-mandatory are ignored.
Filler 1 non-mandatory
Filler 2 non-mandatory
Filler 3 non-mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 156
MUTUAL FUND Allotment Statement Request Response
The Method used for MUTUAL FUND Allotment Statement Report Web services Response is
AllotmentStatementResponse > AllotmentStatementResponse

Parameters Type Length Remarks

100- success
Status code Varchar 3
101- failure

Encrypted password/error reason Varchar 500

Param

Parameters
The Method used for MUTUAL FUND Allotment Statement Report Web services Response is
ArrayOfAllotmentDetails > AllotmentDetails

S.No. Field Name Type Size Remarks

1 Reportdate Varchar 8 YYYY-MM-DD

2 Orderno Number 16
3 Setttype Varchar 2 MF
4 Settno Varchar 7 0910 - FINANCIAL YEAR
00N
5 Orderdate Varchar 8 YYYY-MM-DD
6 Schemecode Varchar 20

7 Isin Varchar 12
8 Amount Number 2 DECIMALS
9 Qty Number 3 DECIMALS
10 Memberid Varchar 10
11 Branchcode Varchar 10

12 Userid Number
13 Foliono Varchar 16
14 Rtaschemecode Varchar 10

15 Rtatransno Varchar 20

16 Clientcode Varchar 10

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 157
17 Clientname Varchar 70

18 Beneficiaryid Varchar 16

19 Allotted nav Number 4 DECIMALS

20 Allotted unit Number 3 DECIMALS

21 Allotment amt Number 2 DECIMALS

22 Validflag Varchar 1 Y - VALID

N - INVALID
23 Remarks Varchar 200
24 Stt Number 4 DECIMALS
25 Internal ref no Varchar 10

26 Order type Varchar 3 NRM/SIP

27 Sip regn no Bigint
28 Sip regn date Date DD/MM/YYYY

29 Subbrcode Varchar 15
30 Euin Varchar 10
31 Euin decl Varchar 1
32 Dpc flag Varchar 1
33 DP trans Varchar 1 P/C/N
34 Order sub type Varchar 10

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 158
ERROR CODES
ERROR CODES DESCRIPTION
FAILED: USER ID MANDATORY Blank User ID
FAILED: MEMBER CODE MANDATORY Blank Member ID
FAILED: PASSWORD MANDATORY Blank Password
FAILED: USER IS DISABLED. CONTACT ADMIN when the user ID is disabled
FAILED: YOU HAVE EXCEEDED MAXIMUM LOGIN
ATTEMPTS. CONTACT ADMIN when the user has put wrong password
FAILED:INVALID ACCOUNT INFORMATION when invalid credentials are passed
FAILED: THE MEMBER IS SUSPENDED. CONTACT ADMIN when the member is suspended
FAILED: ACCESS TEMPORARILY SUSPENDED. KINDLY BEAR
WITH US when the user ID is disabled
FAILED: LOGIN PASSWORD EXPIRED. KINDLY RESET LOGIN
PASSWORD when the user has put wrong password
when the date format is not passed in
FAILED: INVALID FROM DATE proper format
when the date format is not passed in
FAILED: INVALID TO DATE proper format
when the client code is not mapped to
FAILED: INVALID CLIENT CODE FOR GIVEN MEMBER CODE member code given the request string
when the user passes wrong transaction
FAILED: INVALID TRANSACTION TYPE type
FAILED: INVALID ORDER TYPE when the user passes wrong order type
FAILED: INVALID ORDER STATUS when the user passes wrong order status
when the user passes wrong settlement
FAILED: INVALID SETTLEMENT TYPE type
when the user does not exist in BSE
FAILED: USER NOT EXISTS starmf system

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 159
MUTUAL FUND REDEMPTION STATEMENT MESSAGE STRUCTURE

The Mutual Fund Redemption Statement Web Service is available to fetch the Redemption Statement
Report of an individual Order or a list of Orders as per filters for a specific date defined by the Members.

The Web Service through which Redemption Statement Web services request and response can be
facilitated is available at.

URL https://bsestarmfdemo.bseindia.com/StarMFWebService/StarMFWebService.svc

MUTUAL FUND Redemption Statement Services Request

The Method used for MUTUAL FUND Redemption Statement services Request is
RedemptionStatement > RedemptionStatementRequest

Request parameters

Parameters Type Length Mandatory-non- Remarks

mandatory
Member Code Varchar 10 mandatory
UserID Varchar 20 mandatory
Password Varchar 30 mandatory
From Date Varchar 10 mandatory DD/MM/YYYY Same as from Date
To Date Varchar 10 mandatory DD/MM/YYYY Same as to Date
Client Code Varchar 20 non-mandatory
Transaction Type Varchar 5 conditional P/R
Order type Varchar 10 mandatory All/NRM/SIP/XSIP/ISIP/STP/SWP
Sub - Order type Varchar 10 mandatory All/NRM/SPOR/SWITCH
Order Status Varchar 10 mandatory All/VALID/INVALID
Settlement Type Varchar 10 mandatory ALL/L0/L1/OTHERS

If Order ID is sent all other Fields

Order No Varchar 20 non-mandatory are ignored.
Filler 1 non-mandatory
Filler 2 non-mandatory
Filler 3 non-mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 160
MUTUAL FUND Redemption Statement Request Response
The Method used for MUTUAL FUND Redemption Statement Report Web services Response is
RedemptionStatementResponse > RedemptionStatementResponse

Parameters Type Length Remarks

100- success
Status code Varchar 3
101- failure

Encrypted password/error reason Varchar 500

Param

Parameters
The Method used for MUTUAL FUND Redemption Statement Report Web services Response is
ArrayOfOrderDetails > RedemptionStatementResponse

S.no. Field name Type Size Remarks

1 Reportdate Varchar 8 YYYY-MM-DD
2 Orderno Number 16
3 Setttype Varchar 2 MF
4 Settno Varchar 7 0910 - FINANCIAL YEAR
00N
5 Orderdate Varchar 8 YYYY-MM-DD
6 Schemecode Varchar 20
7 Isin Varchar 12
8 Amount Number 2 DECIMALS
9 Qty Number 3 DECIMALS
10 Memberid Varchar 10
11 Branchcode Varchar 10
12 Userid Number
13 Foliono Varchar 16
14 Rtaschemecode Varchar 10
15 Rtatransno Varchar 20
16 Clientcode Varchar 10
17 Clientname Varchar 70

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 161
18 Beneficiaryid Varchar 16
19 Allotted Nav Number 4 DECIMALS

20 Allotted Unit Number 3 DECIMALS

21 Allotment Amt Number 2 DECIMALS

22 Validflag Varchar 1 Y - VALID

N - INVALID
23 Remarks Varchar 200
24 Stt Number 4 DECIMALS
25 Dpc Flag Varchar 1
26 DP Trans VARCHAR 1 P/C/N
27 Order Type Varchar 3 NRM/SIP
28 Order Sub Type Varchar 10

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 162
ERROR CODES

ERROR CODES DESCRIPTION

FAILED: USER ID MANDATORY Blank User ID
FAILED: MEMBER CODE MANDATORY Blank Member ID
FAILED: PASSWORD MANDATORY Blank Password
FAILED: USER IS DISABLED. CONTACT ADMIN when the user ID is disabled
FAILED: YOU HAVE EXCEEDED MAXIMUM LOGIN
ATTEMPTS. CONTACT ADMIN when the user has put wrong password
FAILED:INVALID ACCOUNT INFORMATION when invalid credentials are passed
FAILED: THE MEMBER IS SUSPENDED. CONTACT ADMIN when the member is suspended
FAILED: ACCESS TEMPORARILY SUSPENDED. KINDLY BEAR
WITH US when the user ID is disabled
FAILED: LOGIN PASSWORD EXPIRED. KINDLY RESET LOGIN
PASSWORD when the user has put wrong password
when the date format is not passed in
FAILED: INVALID FROM DATE proper format
when the date format is not passed in
FAILED: INVALID TO DATE proper format
when the client code is not mapped to
FAILED: INVALID CLIENT CODE FOR GIVEN MEMBER CODE member code given the request string
when the user passes wrong transaction
FAILED: INVALID TRANSACTION TYPE type
FAILED: INVALID ORDER TYPE when the user passes wrong order type
FAILED: INVALID ORDER STATUS when the user passes wrong order status
when the user passes wrong settlement
FAILED: INVALID SETTLEMENT TYPE type
when the user does not exist in BSE
FAILED: USER NOT EXISTS starmf system

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 163
 MUTUAL FUND e-NACH MANDATE
AUTHENTICATION URL
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 164
MUTUAL FUND e-NACH MANDATE AUTHENTICATION URL WEB
SERVICES AUTHENTICATION MESSAGE STRUCTURE

The Mutual Fund e-NACH Mandate Authentication URL Web Service is available to fetch the e-NACH
Mandate Authentication URL of an individual Mandate to be authenticated by a Member.

The Web Service through which e-NACH Mandate Authentication URL Web services request and
response can be facilitated is available at.

URL https://bsestarmfdemo.bseindia.com/StarMFWebService/StarMFWebService.svc

MUTUAL FUND e-NACH Mandate Authentication URL Services Request

The Method used for MUTUAL FUND e-NACH Mandate Authentication URL services Request is
EMandateAuthURL > EMandateAuthURLRequest

Request parameters (JSON Format)

Field Name Type Length Remarks Mandatory /
Non-Mandatory
UserID Varchar 20 mandatory
Member code Varchar 10 mandatory
Password Varchar 30 mandatory
Client code Varchar 10 mandatory
Mandate ID Varchar 25 BSE mandate ID mandatory

MUTUAL FUND e-NACH Mandate Authentication URL Response

The Method used for MUTUAL FUND e-NACH Mandate Authentication URL services Request is
EMandateAuthURLResponse > EMandateAuthURLResult

Response Parameter
Field Name Type Length Remarks
100- Success
Status Varchar 3 101- Faliure
Response
string Varchar 500
filler

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 165
Sample Code

Request Parameter : (JSON Format)

{
"ClientCode":"String content",
"MandateID":"String content",
"MemberCode":"String content",
"Password":"String content",
"UserId":"String content"
}

Response (JSON Format)

{
"Fillers":"String content",
"ResponseString":"String content",
"Status":"String content"
}

Error Codes
ERROR CODES DESCRIPTION
FAILED: USER ID MANDATORY When user ID is not passed in the request string
FAILED: MEMBER CODE MANDATORY When member code is not passed in the request string
FAILED: PASSWORD MANDATORY When password is not passed in the request string
FAILED: USER IS DISABLED. CONTACT ADMIN When the user ID is disabled
FAILED: YOU HAVE EXCEEDED MAXIMUM
LOGIN ATTEMPTS. CONTACT ADMIN When the user has put wrong password
FAILED:INVALID ACCOUNT INFORMATION When invalid credentials are passed
FAILED: THE MEMBER IS SUSPENDED.
CONTACT ADMIN When the member is suspended
FAILED: ACCESS TEMPORARILY SUSPENDED.
KINDLY BEAR WITH US When the user ID is disabled
FAILED: LOGIN PASSWORD EXPIRED. KINDLY
RESET LOGIN PASSWORD When the user has put wrong password
INVALID MEMBER CODE FOR GIVEN When the mandate passed does not belong to the
MANDATE ID member code given
INVALID CLIENT CODE FOR GIVEN MANDATE When the mandate passed does not belong to the client
ID code given
ENACHURL NOT GENERATED When the URL for that mandate is not generated
FAILED: USER DOES NOT EXIST When the user does not exist in BSE starmf system

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 166
 MUTUAL FUND MANDATE SHIFT
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 167
MUTUAL FUND MANDATE SHIFT WEB SERVICES AUTHENTICATION
MESSAGE STRUCTURE

MUTUAL FUND e-NACH Mandate Authentication URL Services Request

The Method used for MUTUAL FUND Mandate Shift Service Request is > MandateShift(POST)

SrNo Header Description

1 APIKEY VmxST1UyRkhUbkpOVldNOQ==

URL https://bsestarmfdemo.bseindia.com/StarMFAPI/api/Mandate/MandateShift

Request Parameter

Mandatory/Non
Parameters TYPE Length Sample
Mandatory Fields

this ID should be unique

Unique ID VARCHAR 30 Yes
for each API call

MEMBER CODE VARCHAR 10 Yes

USER CODE VARCHAR 20 Yes
PASSWORD VARCHAR 30 Yes
CLIENT CODE VARCHAR 10 Yes

VARCHAR 10 Yes
REGISTRATION TYPE always XSIP
REGISTRATION BIGINT Yes
NUMBER

VARCHAR 15 Yes
FROM MANDATE ID
TO MANDATE ID VARCHAR 15 Yes

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 168
Response Structure

Parameters TYPE Length Sample

Unique ID VARCHAR 20

STATUS VARCHAR 10 Status : 0 = Success /1= Failed

REMARKS VARCHAR 1000

Sample Code

Request Parameters :

{
"UniqueId": "2019010400003"
"MemberCode": "10073"
"UserCode": "1007301"
"Password": "@1234"
"ClientCode": "789"
"RegnType": "XSIP"
"RegnNo": "990890"
"FromMandateId": "1694"
"ToMandateId": "1551"
}

Response : (JSON)

{
"UniqueId": "2019010400003"
"Status": "0"
"Remarks": "MANDATE SHIFTING DONE SUCCESSFULLY"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 169
 MUTUAL FUND CHEQUE COLLECTION
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 170
MUTUAL FUND AXIS BANK CHEQUE COLLECTION WEB SERVICES
AUTHENTICATION MESSAGE STRUCTURE

The Mutual Fund Axis Bank Cheque collection API allows the Member to provide its branches and users
to Register and Map the client cheque to the Orders and generate Challans.

The generated challans can be provided to the Bank along with the Cheque for cheque payment

The Web Service through which AXIS BANK Cheque Collection Web services request and response can
be facilitated is available at

Cheque Collection API URL

URL https://bsestarmfdemo.bseindia.com/StarMFChequeCollection/service.svc

Cheque Collection API Flow

Flow API Details Method Names

1 Member Cheque Collection Entry ChequeCollectionOrderInitiate (POST)

Member Cheque Collection

2 Deposit Challan Creation Entry ChequeCollectionGroupIdInitiate (POST)

Member Cheque Collection

3 Deposit Challan Generation Entry ChequeCollectionDepositChallan (POST)

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 171
Member Cheque Collection Entry – Website

The process for Cheque collection entry is where the Member selects the client, orders and cheque
details

1.) Client Selection: Where the Member selects the client

2.) Member views the Orders and selects the orders for which the cheque has to be entered for

3.) The Member then selects the Client’s Registered Bank Account details and the enters the
Cheque Date, Amount and selects the deposit bank.

Member Cheque Collection Entry – API

Request

Mandatory/ Non
Parameters TYPE Length Sample
Mandatory Fields

Unique ID varchar 30 M
member ID varchar 10 M
user ID varchar 20 M
password varchar 30 M
client code varchar 10 M
array of order no varchar M
total order amount varchar M
IFSC varchar 11 M
account number varchar 20 M
cheque no varchar 6 M
cheque date varchar 10 DD/MM/YYYY M

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 172
 cheque amount varchar M
deposit bank varchar 10 axis bank M
FILLER 1 varchar 50 NM
FILLER 2 varchar 50 NM
FILLER 3 varchar 50 NM

Response

Parameters TYPE Length sample

GROUP id VARCHAR 30
BSE REMARKS VARCHAR 1000
Status VARCHAR 10 Status : 0 = Success /1= Failed

Sample Code
Request

{
UniqueId: "2019011000002",
MemberId: "10097",
UserId: "1009701",
Password: "@1234",
ClientCode: "456",
OrderNo: ["1862292", "1862293"],
TotalAmount: "15000",
IFSCCode: "HDFC0000001",
AccNo: "456665645556",
ChequeNo: "100521",
ChequeDate: "10/01/2019",
ChequeAmount: "15000",
DepositBank: "axis bank",
Filler1: null,
Filler2: null,
Filler3: null
}

Response :
{
"BseRemarks": "Cheque Entry completed , Please verify details and Generate Deposit Slip from
Cheque Deposit Challan Menu",
"GroupId": "19011000001",
"Status": "0"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 173
Member Cheque Collection Deposit Challan Creation Entry – Website (PDF File
Download)

The Member can generate the Cheque Deposit Challan Slip and group the multiple cheques for a single
Deposit challan creation.

Member Cheque Collection Deposit Challan Creation Entry – API (PDF File
Download)

Request Parameter

Mandatory/Non
Parameters TYPE Length Sample
Mandatory Fields
Unique ID varchar 30 M
member ID varchar 10 M
user ID varchar 20 M
password varchar 30 M
array Of group id max 10 M

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 174
Response Parameter

Parameters TYPE Length Sample

DEPOSIT CHALLAN NO VARCHAR 30

BSE REMARKS VARCHAR 1000
Status VARCHAR 10 Status : 0 = Success /1= Failed

Sample Code

Request :

UniqueId: "201901100013",
MemberId: "10097",
UserId: "1009701",
Password: "@1234",
GroupId: ["19011000001", "19011000002"]

Response :

"BseRemarks": "Verification completed , Please select the process type Deposit Challan , to generate the
deposit slip",
"DepositChallanNo": ["201901100002"],
"Status": "0"

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 175
Member Cheque Collection Deposit Challan Generation Entry – Website

The Deposit Challan is generated as a PDF file to be printed and provided with the cheque to the Deposit
Bank for Client Payment

Member Cheque Collection Deposit Challan Generation Entry – API

Request Parameter

Mandatory/Non
Parameters TYPE Length Sample Mandatory
Fields

Unique ID varchar 30 M
member ID varchar 30 M
user ID varchar 10 M
password varchar 20 M
deposit challan varchar 30 M

Response Parameter

Parameters TYPE Length Sample

PDF base64
BSE REMARKS VARCHAR 1000
Status VARCHAR 10 Status : 0 = Success /1= Failed

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 176
Sample Code

Request :

UniqueId: "201901100022",
MemberId: "10097",
UserId: "1009701",
Password: "@1234",
DepositChallanNo: "201901100002"

Response :

"BseRemarks": "DEPOSIT CHALLAN PDF GENERATED",

"PDF": "",
"Status": "0"

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 177
 MUTUAL FUND SINGLE PAYMENT
GATEWAY API
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 178
SINGLE INTEGRATED PAYMENT WEBSERVICE MESSAGE STRUCTURE
THROUGH API FOR ALL PAYMENT METHODS

The single payment API interface allows the members to use all payment methods using a single
API.

URL https://bsestarmfdemo.bseindia.com/StarMFSinglePaymentAPI/Single/Payment

Structure for Single Payment API Interface

Request Parameter
Parameters Type Length Remarks
Login ID varchar 20 Mandatory
Password varchar 20 Mandatory
Member Code varchar 20 Mandatory
Client Code varchar 10 Mandatory
Mode Of Payment varchar 10 DIRECT/NODAL/NEFT/UPI
Bank Id varchar 5 Mandatory for DIRECT/NODAL/UPI
Account Number varchar 20 Mandatory
IFSC varchar 11 Mandatory
Order Number(s) varchar Mandatory
Total Amount MONEY Mandatory (should be equal to sum of all
order values)
Internal ref no varchar 20 Non-Mandatory
NEFT Reference varchar 50 Mandatory if Mode is NEFT
Mandate ID varchar 50 Not available presently , For Future USE
VPA ID varchar 50 Mandatory if Mode is UPI
Logout Url/ Loopback varchar 1000 Mandatory for DIRECT/NODAL
URL
Allow LoopBack varchar 1 Not available presently, For Future USE
Success/Failure If Y an Additional variable will be sent as
redirection in the Loopback URL
?Status=SUCCESS/FAILURE/INPROCESS
This is only for Payment Gateway and UPI
where real time status is available
Only if (DIRECT/NODAL/UPI) is selected in
Mode of Payment.
FILLER 1
FILLER 2
FILLER 3
FILLER 4

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 179
FILLER 5

Response

Parameters Type Length Remarks

Bank Page in HTML
format(DIRECT/NODAL)
Response String Or
Verbose Message
(UPI/NEFT/Payment Error)
100- success
Status Code varchar 3
101- failure
Internal Reference No varchar 20

FILLER 1

FILLER 2

FILLER 3

FILLER 4

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 180
Sample Code

Request :
{
"LoginId" : "XXXXX",
"Password" : "XXXXX",
"membercode" : "XXXX",
"clientcode" : "456fefe",
"modeofpayment" : "NEFT",
"bankid" : "ibk",
"accountnumber" : "XXXXXXXXXXX",
"ifsc" : "IBKL0000001",
"ordernumber" : "1994507|1994508",
"totalamount" : "5000",
"internalrefno" : "123456987",
"NEFTreference" : "1",
"mandateid" : "",
"vpaid" : "",
"loopbackURL" : "",
"allowloopBack" : "",
"filler1" : "",
"filler2" : "",
"filler3" : "",
"filler4" : "",
"filler5" : ""
}

Response :
{
"responsestring": "Payment initiated done through NEFT",
"statuscode": "100",
"internalrefno": "123456987",
"filler1": "",
"filler2": "",
"filler3": "",
"filler4": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 181
NET BANKING BANK CODES

PAY Bank merged and new

BANK NAME BANK ID
MODE Bank ID to be passed
DIRECT Kotak Mahindra Bank 162
DIRECT HDFC Bank Limited HDF
DIRECT ICICI Bank ICI
DIRECT State Bank of India SBI
DIRECT Axis Bank UTI
DIRECT YES Bank YBK
DIRECT IndusInd Bank IDS
NODAL Andhra Bank ADB UBI
NODAL Andhra Bank Corporate ADC
NODAL Allahabad Bank ALB INB
NODAL Allahabad Bank Corporate ALC
NODAL Andhra Pragathi Grameena Bank APG
NODAL AU Small Finance Bank AUB
NODAL Axis Bank Corporate AXC
NODAL Bank of Baroda-Corporate BBC
NODAL Bank of Bahrain and Kuwait BBK
NODAL Bank of Baroda- Retail BBR
NODAL Bassein Catholic Bank BCB
NODAL Bandhan Bank Corporate BDC
NODAL Bandhan Bank BDN
NODAL Bank Of India BOI
NODAL Bank of Maharashtra BOM
NODAL Central Bank of India CBI
NODAL Canara Bank CNB
NODAL Capital Bank CPB
NODAL Cosmos Bank COB
NODAL Corporate Punjab National Bank CPN
NODAL Corporation Bank Corporate CR2
NODAL Corporation Bank CRP UBI
NODAL Catholic Syrian Bank CSB
NODAL City Union Bank CUB
NODAL Deutsche Bank DBK
NODAL DIGI Bank DBS
NODAL Development Credit Bank DCB
NODAL Dena Bank Net Banking DEN BBR
NODAL Dhanlakshmi Bank Corporate DL2

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 182
NODAL Dhanlakshmi Bank DLB
NODAL Equitas Bank EQB
NODAL ESAF Small Finance Bank ESF
NODAL Federal Bank FBK
NODAL Fincare Small Finance Bank FNC
NODAL HDFC UPI HD4
NODAL Gujarat State Cooperative Bank GSB
NODAL HSBC HSB
NODAL UPI IC4
NODAL IDBI Bank IDB
NODAL IDBI Bank Corporate IDC
NODAL IDFC Bank Netbanking IDN
NODAL Indian Bank INB
NODAL Indian Overseas Bank IOB
NODAL Jammu & Kashmir Bank Limited JKB
NODAL Jana Small Finance Bank JNB
NODAL Janata Sahakari Bank JSB
NODAL Karnataka Bank KBL
NODAL Kalupur Coop Bank KLB
NODAL Karur Vysya Bank Limited KVB
NODAL Karnataka Vikas Gramin Bank KVG
NODAL Lakshmi Vilas Bank Corporate LVC
NODAL Lakshmi Vilas Bank Retail LVR
NODAL Maharashtra Gramin Bank MGB
NODAL North East Small Finance Bank NEB
NODAL NKGSB Bank NKB
NODAL Nutan Nagarik Sahakari Bank NUT
NODAL ORIENTAL BANK OF COMMERCE OBC PNB
NODAL Pragathi Krishna Bank PKB
NODAL Punjab National Bank PNB
NODAL Punjab and Sind Bank PSB
NODAL Ratnakar Bank RBL
NODAL RBL Bank Coporate RTC
NODAL SCB Net Banking SCB
NODAL South Indian Bank Ltd SIB
NODAL SBM Bank SOM
NODAL Suryoday Small Finance Bank SRB
NODAL Surat Bank SUR
NODAL Sutex Bank SUT
NODAL Shamrao Vithal Bank Corporate SV2
NODAL Shamrao Vithal Co.Operative Bank Ltd SVC

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 183
NODAL Saraswat Bank SWB
NODAL Syndicate Bank SYD CNB
NODAL Thane Bharat Sahakari Bank TBB
NODAL TJSB TJB
NODAL Tamilnad Mercantile Bank Ltd TMB
NODAL TNSC Bank TNC
NODAL Union Bank of India UBI
NODAL Union Bank of India Corporate UB2
NODAL UCO Bank UCO
NODAL United Bank of India UNI PNB
NODAL Ujjivan Bank UJV
NODAL Utkarsh Bank UTK
NODAL Vijaya Bank VJB BBR
NODAL Varachaa Bank VRB
NODAL YES Bank Corporate YBC
NODAL The Zoroastrian Co-op Bank ZOB

New BANK ID
MERGED BANK DETAILS OLD BANK ID
to be passed
Corporation bank merged with Union bank of India CRP UBI
Oriental Bank of Commerce merged with Punjab National bank OBC PNB
Syndicate Bank merged with Canara Bank SYD CNB
Dena Bank merged with Bank of Baroda DEN BBR
United Bank of India merged with Punjab National bank UNI PNB
Andhra Bank merged with Union Bank of India ADB UBI
Vijaya Bank merged with Bank of Baroda VJB BBR
Allahabad Bank with Indian Bank ALB IND

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 184
UPI BANK CODES

ServiceType BankName BankCode

UPI ABHYUDAYA COOPERATIVE BANK LIMITED ACB
UPI ADITYA BIRLA IDEA PAYMENTS BANK LTD ABPB
UPI AIRTEL PAYMENTS BANK LIMITED AIRP
UPI ALLAHABAD BANK ALD
UPI Allahabad Bank - Retail Net Banking ALB
UPI ALLAHABAD BANK CORPORATE ALC
UPI Andhra Bank ADB
UPI ANDHRA PRADESH GRAMEENA VIKAS BANK APGX
UPI ANDHRA PRAGATHI GRAMEENA BANK APG
UPI APNA SAHAKARI BANK LIMITED ASB
UPI AU SMALL FINANCE BANK AUB
UPI Axis Bank UTI
UPI BANDHAN BANK LIMITED BDB
UPI Bank of Baroda - Corporate Banking BBC
UPI Bank of Baroda - Retail Net Banking BBR
UPI Bank Of India BOI
UPI Bank of Maharashtra BOM
UPI BASSEIN CATHOLIC COOPERATIVE BANK LIMITED BAC
UPI Canara Bank CNB
UPI Catholic Syrian Bank CSB
UPI Central Bank of India CBI
UPI CITI BANK CIT
UPI CITY UNION BANK LIMITED CUB
UPI Corporation Bank CRP
UPI DCB BANK LIMITED DCB
UPI Dena Bank DEN
UPI DEVELOPMENT BANK OF SINGAPORE DBS
UPI Dhanlakshmi Bank DLB
UPI DOMBIVLI NAGARI SAHAKARI BANK LIMITED DNS
UPI Equitas Small Finance Bank Ltd EQB
UPI Equitas Small Finance Bank Ltd ESF
UPI Federal Bank FBK
UPI FINO PAYMENTS BANK LTD FINO
UPI G P PARSIK BANK PJS
UPI HDFC BANK HDF
UPI HSBC BANK HSB
UPI ICICI Bank - Retail Net Banking ICI
UPI IDBI Bank - Retail Net Banking IDB
MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 185
UPI IDFC BANK LIMITED IDF
UPI Indian Bank INB
UPI Indian Overseas Bank IOB
UPI IndusInd Bank IDS
UPI JALGAON JANATA SAHAKARI BANK LIMITED JJS
UPI Jammu & Kashmir Bank JKB
UPI Janata Sahakari Bank JSB
UPI JIO PAYMENTS BANK LIMITED JIOP
KALLAPPANNA AWADE ICHALKARANJI JANATA SAHAKARI BANK
UPI LIMITED KAI
UPI KALYAN JANATA SAHAKARI BANK KJS
UPI KAPOL COOPERATIVE BANK LIMITED KCB
UPI Karnataka Bank Ltd KBL
UPI KARNATAKA VIKAS GRAMEENA BANK KVG
UPI Karur Vysya Bank KVB
UPI KERALA GRAMIN BANK KLG
UPI Kotak Bank 162
UPI Lakshmi Vilas Bank LVB
UPI Laxmi Vilas Bank - Corporate Net Banking LVC
UPI Laxmi Vilas Bank - Retail Net Banking LVR
UPI MAHANAGAR COOPERATIVE BANK MCB
UPI MAHARASHTRA GRAMIN BANK MGBX
UPI NKGSB BANK NKB
UPI Oriental Bank of Commerce OBC
UPI PAYTM PAYMENTS BANK LTD PYTM
UPI PRAGATHI KRISHNA GRAMIN BANK PKG
UPI PRATHAMA BANK PRT
UPI Punjab & Maharastra Coop Bank PMC
UPI Punjab & Sind Bank PSB
UPI Punjab National Bank - Corporate Banking CPN
UPI Punjab National Bank - Retail Net Banking PNB
UPI RAJKOT NAGRIK SAHAKARI BANK LIMITED RNS
UPI Ratnakar Bank - Retail Net Banking RBL
UPI RBL Bank Limited RAT
UPI Saraswat Bank SWB
UPI SHAMRAO VITHAL BANK CORPORATE SV2
UPI South Indian Bank SIB
UPI Standard Chartered Bank SCB
UPI State Bank of India SBI
UPI SUTEX COOPERATIVE BANK LIMITED SUT
UPI Syndicate Bank SYD
UPI Tamilnad Mercantile Bank Ltd. TMB
UPI TELANGANA STATE COOP APEX BANK TSA
MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 186
UPI THE COSMOS CO OPERATIVE BANK LIMITED COS
UPI THE GUJARAT STATE COOPERATIVE BANK LIMITED GSC
UPI THE HASTI COOP BANK LTD HCB
UPI THE MEHSANA URBAN COOPERATIVE BANK MSN
UPI THE NAINITAL BANK LIMITED NTB
UPI THE NAV JEEVAN CO-OP BANK LTD. NJCX
UPI THE SHAMRAO VITHAL COOPERATIVE BANK SVC
UPI THE SURAT PEOPLES COOPERATIVE BANK LIMITED SPC
UPI THE TAMIL NADU STATE APEX COOPERATIVE BANK TNS
UPI THE THANE BHARAT SAHAKARI BANK LIMITED TBS
UPI THE VARACHHA COOPERATIVE BANK LIMITED VAR
UPI THE VIJAY CO OPERATIVE BANK LTD. VIJX
UPI THE VISHWESHWAR SAHAKARI BANK LIMITED VSB
UPI TJSB Bank TJB
UPI TJSB SAHAKARI BANK LTD TJS
UPI UCO Bank UCO
UPI Ujjivan Small Finance Bank Limited UJV
UPI Union Bank of India UBI
UPI United Bank of India UNI
UPI VASAI VIKAS SAHAKARI BANK LIMITED VVS
UPI Vijaya Bank VJB

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 187
 MUTUAL FUND CHEQUE IMAGE
UPLOAD API FOR NRI MINOR

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 188
MUTUAL FUND CHEQUE IMAGE UPLOAD API WEB SERVICE MESSAGE
STRUCTURE FOR NRI MINOR

URL https://bsestarmfdemo.bseindia.com/StarMFImageUpload/api/ImageUpload/ImageUploadBase64

Method 1 : ImageUploadBase64
Request Parameter : (JSON Format)

This Method requires the Image to be Uploaded as a Base64 String

Parameters Type Length Remarks Mandatory /

Non-Mandatory
User ID Varchar 20 Mandatory
Password ID Varchar 10 Mandatory
Member Code Varchar 10 Mandatory
Client Code Varchar 10 Mandatory
Image Name Varchar 100 Mandatory
Base 64 String String Mandatory
Filler 1 Varchar 50 Non- Mandatory
Filler 2 Varchar 50 Non-Mandatory

Response Parameter : (JSON Format)

Parameters Type Length Remarks

0- Success
Status Varchar 3 1- Failure
remarks varchar 1000
filler 1 varchar 50
filler 2 varchar 50

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 189
Method 2 : ImageUploadByte
URL https://bsestarmfdemo.bseindia.com/StarMFImageUpload/api/ImageUpload/ImageUploadByte

Request Parameter : (JSON Format)

This Method requires the Image to be Uploaded as an Unsigned Byte Array

Parameters Type Length Remarks Mandatory /

Non-Mandatory
User ID Varchar 20 Mandatory
Password ID Varchar 10 Mandatory
Member Code Varchar 10 Mandatory
Client Code Varchar 10 Mandatory
Image Name Varchar 100 Mandatory
Byte Array Byte Mandatory
Filler 1 Varchar 50 Non- Mandatory
Filler 2 Varchar 50 Non-Mandatory

Response Parameter : (JSON Format)

Parameters Type Length Remarks

0- Success
Status Varchar 3 1- Failure
remarks varchar 1000
filler 1 varchar 50
filler 2 varchar 50

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 190
API Methods Name :

SrNo API Name Description

1 ImageUploadBase64 Cheque Upload for NRI and Minor using Base64 String

Method 1 : ImageUploadBase64

Request Parameter : (JSON Format)

{
"UserId" : "1007689",
"Password" : "@1234",
"MemberCode" : "10076",
"clientcode" : "980",
"ImageName" : "10076980.pdf",
"FileData" : "",
"Filler1" : "",
"Filler2" : ""
}

Response (JSON Format)

{
"Status": "1",
"Remarks": "",
"Filler1": null,
"Filler2": null
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 191
 SrNo API Name Description
2 ImageUploadByte Cheque Upload for NRI and Minor using Unsigned Byte Array

Method 2 : ImageUploadByte

Request Parameter : (JSON Format)

{
"UserId" : "1007689",
"Password" : "@1234",
"MemberCode" : "10076",
"clientcode" : "980",
"ImageName" : "10076980.pdf",
"FileData" : "",
"Filler1" : "",
"Filler2" : ""
}

Response Parameter : (JSON Format)

{
"Status": "1",
"Remarks": "",
"Filler1": null,
"Filler2": null
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 192
 MUTUAL FUND SIP XSIP PAUSE API
WEB SERVICE MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 193
MUTUAL FUND SIP XSIP PAUSE API WEB SERVICE MESSAGE STRUCTURE

URL https://bsestarmfdemo.bseindia.com/StarMFAPI/api/Pause/PauseSIP

SrNo Header Description

1 APIKEY VmxST1UyRkhUbkpOVldNOQ==

Request Parameter : (JSON Format)

Parameter Name Type Length Sample values Mandatory

Login ID Varchar 20 Mandatory
Member CODE Varchar 20 Mandatory
Password Varchar Mandatory
Client code Varchar 10 Mandatory
Registration type Varchar 5 (SIP/XSIP) Mandatory
Registration number Bigint Mandatory
Modification type Varchar 50 (PAUSE) Mandatory
No of instalments Numeric Mandatory
Filler 1 Varchar 50 Non - Mandatory
Filler 2 Varchar 50 Non - Mandatory
Filler 3 Varchar 50 Non - Mandatory
Filler 4 Varchar 50 Non - Mandatory
Filler 5 Varchar 50 Non - Mandatory

Response Parameter : (JSON Format)

Parameter Name Type Length Description Sample values
Registration number Bigint
Bse remarks Varchar 1000 Bse Response Return remarks
STATUS flag Varchar 1 Order success flag 0 - Success & 1 - failure
Filler Varchar 50

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 194
Pause SIP/ XSIP API JSON Request & Response Example

SrNo Header Description

1 APIKEY VmxST1UyRkhUbkpOVldNOQ==

Request (JSON Format)

{
"LoginId" : "1000001",
"MemberCode" : "10000",
"Password" : "@1234",
"ClientCode" : "Client1",
"RegistrationType" : "SIP",
"RegistrationNumber" : "1234567",
"ModificationType" : "PAUSE",
"NoOfInstalments" : "3",
"filler1" : "NULL",
"filler2" : "NULL",
"filler3" : "NULL",
"filler4" : "NULL",
"filler5" : "NULL"
}

Response (JSON Format)

{
“RegistrationNumber” : “1234567”,
“BseRemarks” : “DATA SAVED SUCCESSFULLY”
“StatusFlag” : “0”,
“filler” : “”
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 195
 MUTUAL FUND SIP TO XSIP SHIFT API
WEB SERVICE MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 196
MUTUAL FUND SIP TO XSIP SHIFT API WEB SERVICE MESSAGE
STRUCTURE

Method : SIPtoXSIPShift(POST)

SrNo Header Description

1 APIKEY VmxST1UyRkhUbkpOVldNOQ==

URL https://bsestarmfdemo.bseindia.com/StarMFAPI/api/SIP/SIPtoXSIPShift

REQUEST STRUCTURE
Mandatory/Non
Parameters TYPE Length Sample
Mandatory Fields

Unique ID this ID should be unique for

VARCHAR 30 yes
each API call
MEMBER CODE VARCHAR 10 Yes
USER CODE VARCHAR 20 Yes
PASSWORD VARCHAR 30 Yes
SIP Regn Number VARCHAR 7 yes
Mandate ID VARCHAR 7 yes
Brokerage MONEY no
filler 1 VARCHAR 50 no
filler 2 VARCHAR 50 no

RESPONSE STRUCTURE
Parameters TYPE Length sample

Unique ID VARCHAR 20

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 197
 STATUS VARCHAR 10 Status : 0 = Success /1= Failed

REMARKS VARCHAR 1000

SAMPLE CODE

Request Details : (JSON)

{
"UniqueId" : 111,
"MemberCode" : 10076,
"UserCode" : 1007601,
"Password" : "@1234",
"SIPRegnNumber" : 1012568,
"MandateID" : 3560,
"Brokerage" : 0,
"filler1" : "",
"filler2" : ""
}

Response Details : (JSON )

{
"UniqueId": "111",
"Status": "1",
"Remarks": "DUPLICATE UNIQUE ID"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 198
Additional Resources

The StAR MF UAT Environment Web site is available at

https://bsestarmfdemo.bseindia.com/

You can create your clients after logging in to the StAR MF Website.

Also, the Documentation regarding File Structures is available at

https://www.bsestarmf.in/BSE%20StARMF%20File%20Structures.pdf

If requested UAT Environment credentials can be created and provided for IML /Web Service

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 199
STANDARD ERROR CODES
GET PASSWORD
ERROR MESSAGES DESCRIPTION
USER ID SHOULD NOT BE BLANK Blank value in user Id field
MEMBER ID SHOULD NOT BE BLANK Blank value in member Id field
PASSWORD SHOULD NOT BE BLANK Blank value in password field
PASSKEY SHOULD NOT BE BLANK Blank value in passkey field
USER IS DISABLED. CONTACT ADMIN User is blocked or disabled
YOU HAVE EXCEEDED MAXIMUM LOGIN
ATTEMPTS. CONTACT ADMIN User has entered wrong password more than 5 times
INVALID ACCOUNT INFORMATION Incorrect Login details
INVALID USER ID Incorrect Login ID
THE MEMBER IS SUSPENDED. CONTACT
ADMIN when the given member is blocked or inactive
THE BRANCH IS SUSPENDED. CONTACT
ADMIN when the given member branch is blocked or inactive]
ACCESS TEMPORARILY SUSPENDED. KINDLY
BEAR WITH US when forced login is "YES"
PASSWORD EXPIRED when the user password has expired
USER NOT EXISTS when user doesn't pass proper login details

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 200
MFAPI
ERROR MESSAGES DESCRIPTION
INVALID USER ID Incorrect Login ID
PASSWORD EXPIRED Incorrect Passkey
PASSWORD EXPIRED Incorrect User ID
PASSWORD EXPIRED Login Session Expired, Re-login is required
INVALID PARAM STRING FORMAT Request string is not proper format
MEMBER CODE MANDATORY Blank member code
CLIENT CODE MANDATORY Blank client code
INVALID MEMBER CODE Incorrect member code
INVALID CLIENT CODE Incorrect client code
INVALID MANDATE NUMBER when user passes wrong mandate ID
INVALID MANDATE NUMBER FOR GIVEN
CLIENT CODE Mandate number does not belong to the given client
INVALID ACTION CODE Incorrect action code
Incorrect values in mode column i.e other than
INVALID PAYMENT MODE "DIRECT/NODAL"
Incorrect Client account number i.e. Account does not
INVALID CLIENT ACCOUNT NUMBER match with the client master
SELECT AT LEAST ONE ORDER No orders number are sent for payment
Incorrect order number or given order number is not
associated to the client for which the payment has to
INVALID ORDER NUMBER be initiated

Amount doesn't match with the total amount of the

INVALID TOTAL ORDER AMOUNT orders that are sent

Order number sent for which the payment has already

ORDER NUMBER ALREADY INITIATED been initiated
The payment has already been done for the order
PAYMENT DONE FOR THIS ORDER NUMBER number sent.
INVALID LOGOUT URL FORMAT Invalid URL format provided
Invalid encrypted password sent or when user passes
the encrypted password which was generated for last
INVALID ENCRYPTED PASSWORD session.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 201
 MUTUAL FUND REDEMPTION
TWO FACTOR AUTHENTICATION API
WEB SERVICE MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 202
MUTUAL FUND REDEMPTION TWO FATOR AUTHENTICATION API WEB
SERVICE MESSAGE STRUCTURE

Introduction

Redemption authentication messages are to be sent to MFI/MFD/RIA clients for all non
demat redemption orders placed by them. The One Time Password is sent for redemption
authentication to the mobile and email ID as per the AMC database. The Exchange shall
provide a webservice for Members to display the OTP confirmation screen to authenticate
the redemption Orders being placed by the Members of the Exchange.

Overview
Members can consume the Exchange webservice to open the Redemption Transactions
Authentication details for the Client to enter the OTP and confirm his transactions.

The exchange shall send the webpage link to be opened in the member website or mobile
app.

Technology

This will be using JSON based message structures to send and receive data to the Exchange.

Members shall send API requests to the exchange

Members to open the link sent by Exchange in their App/ Website.

On success full confirmation link to be redirected to Loopback URL.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 203
Structure for Redemption 2FA Authentication API

URL https://bsestarmfdemo.bseindia.com/BSEMFWEBAPI/api/2FAAuthController/_2FAAuthunetication/w

REQUEST STRUCTURE
Parameters Type Length Remarks
Login ID varchar 20 Mandatory
Password varchar 20 Mandatory
Member Code varchar 20 Mandatory
Client Code varchar 10 Mandatory
Logout Url/ Loopback varchar 1000 Mandatory
URL
Internal ref no varchar 20 Non-Mandatory
Allow LoopBack varchar 1 Not available presently, For Future USE If
Success/Failure Y an Additional variable will be sent as
redirection in the Loopback URL
?Status=SUCCESS/FAILURE/PENDING

RESPONSE STRUCTURE

Parameters Type Length Remarks

LoopbackReturnUrl varchar 1000 The URL for Loopback

The Error / Success
ErrorDescription varchar 200
Description
100 - success
StatusCode varchar 3
101 - failure

Internal Reference No varchar 20 Internal reference sent

The URL for 2FA

Authentication to be
Return URL varchar 100
opened in the member
site or app

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 204
 No of Pending
Total Redemption Orders to be
varchar 20 Orders to be
Authenticated
Authenticated

Sample Code

Request (Json):
{
"LoginID": "XXXXXXX",
"Password": "XXXXXX",
"MemberCode": "XXXXX",
"ClientCode": "client1",
"LoopbackReturnUrl": "https://www.bseindia.com",
"InternalRefrenceNo": "123456",
"AllowLoopBack": "Y"
}

Response (Json) :

{
"LoopbackReturnUrl":"https://www.bseindia.com",
"ErrorDescription":"LOGIN DONE SUCCESSFULLY",
"StatusCode":"100",
"InternalRefrenceNo":"123456",
"ReturnUrl":"https://bsestarmfdemo.bseindia.com/2FA_RedemptionOrder.aspx?S
CITunalQzLM
hkSnh6Z3Mm8xMNZXIctbyCwW4XUk2l%2bLNAHArIH4GqZMB7wVYXmtHAYktZBU
oWBLm9eUyZ
KfjCf4g0lm754ygJxAXPZ%2bZA6GPFzRFDS0Pg%3d%3d",
"PendingAuthOrder":"5"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 205
 MUTUAL FUND SUBSCRIPTION
TWO FACTOR AUTHENTICATION API
WEB SERVICE MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 206
MUTUAL FUND SUBSCRIPTION TWO FATOR AUTHENTICATION API WEB
SERVICE MESSAGE STRUCTURE

URL https://bsestarmfdemo.bseindia.com/BSEMFWEBAPI/api/_2FA_AuthenticationController/_2FA_Authentication/w

Introduction

Two Factor Authentication Subscription are to be sent to MFI/MFD/RIA clients for all specific Purchase
details. Clients are to verify the details using a One Time Password sent for authentication to the
mobile and email ID of the client. The Exchange shall provide a webservice for Members to allow the
clients to connect to the 2FA portal for clients to verify their Orders and Nomination using the OTP.

Overview
Members can consume the Exchange webservice to open the 2FA page Transactions Authentication
details for the Client to enter the OTP and confirm his transactions.

The Exchange shall send the webpage link to be opened in the member website or mobile app.

Technology
This will be using JSON based message structures to send and receive data to the Exchange.

Members shall send API requests to the Exchange.

URL and all pending data sent to member on request.

Members to open the link sent by Exchange in their App/ Website.

On successful confirmation link to be redirected to Loopback URL with the Client verified data.

Message Flow
1. Client enter the orders for himself.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 207
2. Member/Vendor invokes the 2FA Authentication API to fetch the BSE 2FA webpage for authenticating
the Orders changes.
3. Member gets the URL and a list of all pending Orders for which 2FA is to be completed.
4. This BSE Page is displayed in his Website or Mobile APP.
5. Client navigates to the various orders and has to enter the OTP on the authentication page to confirm
the order.
6. Once the OTP is confirmed, then the order is sent for further processing.
7. Client clicks on Sumit button.
8. The member gets the list of purchased orders and verified in the POST data submitted to the post
URL.

Structure for 2FA Authentication API

Request Parameter

Parameters Type Length Remarks

loginId varchar 20 Mandatory
Password varchar 20 Mandatory
Membercode varchar 20 Mandatory
Clientcode varchar 10 Mandatory
primaryholder varchar 1 Mandatory (1/2/3)
loopbackURL varchar 1000 Non-Mandatory (For Future use only)
Internalrefno varchar 20 Mandatory
allowloopBack varchar 1 Non-Mandatory (For Future use only)
If Y an Additional variable will be sent as
redirection in the Loopback URL
?Status=SUCCESS/FAILURE/PENDING

Note :- Please note that presently loopback URL will not have any re-direction. It will be Server-To-
Server Post data for Status.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 208
Response Parameter

Parameters Type Length Remarks

100- success
ResponseCode varchar 3
101- failure

WebPage in HTML
format Or Verbose Message
ResponseString varchar
( Error)

internalrefno Varchar 20 Internal reference number

provided in request

Post Data to be Submitted to the Response Parameter

Parameters Type Length Remarks

WebPage in HTML format

Response String Or
Verbose Message ( Error)

100- success
Status Code Varchar 3
101- failure

Internal Reference No Varchar 20

Orders JSON Array List of Orders

OrderNo Key Array Order No.

Order Value Key Object Pair Order Number

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 209
Type JSON Object

Type Value JSON Object Type of Order

Status JSON Object

JSON Object 1st Digit - Primary Holder

2nd Digit – Secondary Holder
3rd Digit – Third Holder

0/1 – Holder Approved Yes or

No

E.g.
100 – Only Primary Holder has
authenticated.
111 – All Three Holders have
authenticated.
101 – Only Primary Holder and
Third Holder has authenticated.
110 – Primary Holder and
Second Holder has
authenticated.
011 – Only secondary Holder
and Third Holder has
authenticated.
001 – Only Third has
authenticated.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 210
Sample Code

Request (JSON)
{
"loginId" : "XXXXX",
"password" : "XXXXX",
"membercode" : "XXXX",
"clientcode" : "456fefe",
"primaryholder": "1",
"loopbackURL" : "",
"internalrefno" : "123456987",
"allowloopBack" : "",
}

Response (JSON)

{
"responsestring": "HTML",
"statuscode": "100",
"internalrefno": “123456987”
}

Post Data to Post URL on Client Journey Completion

{
"statuscode": "100",
"internalrefno": "123456987",
"Orders": [
{
"orderno": "8739152",
"Type": "Purchase",
"status": "111"
}
]

Note:- This will contain the Orders that the Client has verified in his journey.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 211
MUTUAL FUND NOMINATION API WEB
SERVICE MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 212
 MUTUAL FUND NOMINATION API WEB SERVICE MESSAGE STRUCTURE

Introduction

As per latest SEBI Circular, mutual fund investors to either provide “Nomination” details OR they
need to confirm on “Opting out of nomination”. The Nominee API webservice structure is
available in the JSON based format.

There are three Nomination API Webservice Structures.

1) BSE StAR MF Nominee Registration API Webservice Message Structure

Members can access the Nomination Registration API webservice for adding nominee details
to their existing UCCs.

2) BSE StAR MF Nominee Image Upload API Webservice Message Structure

Nomination Image Upload API webservice is avail to members who wish to do uploading of
images with wet signature or e-sign. Members can contact their BSE StAR MF Relationship
Manager to confirm whether this API webservice is applicable to them.

3) BSE StAR MF Nominee 2FA API Webservice Message Structure

Nomination 2FA API webservice can be access for two factor authentication to be done for
UCCs nominee details. It is highly recommended for members to take exemptions and to use
their own 2FA methods for validations using the Nomination 2FA API webservice structure.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 213
MUTUAL FUND NOMINEE REGISTRATION API WEBSERVICE MESSAGE
STRUCTURE

NOMINEE REGISTRATION STRUCTURE

Nomination Registration API URL

URL https://bsestarmfdemo.bseindia.com/BSEMFWEBAPI/api/mfupload/Registation/w

REQUEST PARAMETER (JSON FORMAT)

FIELD FIELD
PARAMETER TYPE LENGTH DESCRIPTION MANDATORY

TYPE value for Nomination

Type Varchar 20 Mandatory
registration is ‘NOMINEE’
UserId Varchar 20 User id Mandatory

MemberCode Varchar 20 Member id Mandatory

Password Varchar Password Mandatory

‘NEW’ for New Nominee

Registration.
RegnType Varchar 10 ‘MOD’ for Nominee detail Mandatory
Modifications for existing
nominee records.
FILLER1 Varchar 50 Filler Non-Mandatory

FILLER2 Varchar 50 Filler Non-Mandatory

FILLER3 Varchar 50 Filler Non-Mandatory

Array of Individual records. Max

Param String Mandatory
array Record is 50.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 214
Individual Records of ‘Param’ field of Request Parameter

FIELD FIELD
PARAMETER NAME DESCRIPTION MANDATORY
TYPE LENGTH

ClientCode Varchar 10 Client code Mandatory

NominationOpt Varchar 1 Nomination Opt : Y/N Mandatory
Nomination
Authentication Modes:
NominationAuthMode Varchar 1 W - Wet Signature; Mandatory
E - eSign;
O - OTP authentication
NomineePAN1 Varchar 10 Nominee 1 PAN Optional
Nominee 1 Guardian
NomineeGuardianPAN1 Varchar 10 Optional
PAN
NomineePAN2 Varchar 10 Nominee 2 PAN Optional
Nominee 2 Guardian
NomineeGuardianPAN2 Varchar 10 Optional
PAN
NomineePAN3 Varchar 10 Nominee 3 PAN Optional
Nominee 3 Guardian
NomineeGuardianPAN3 Varchar 10 Optional
PAN
Mandatory if
UCC Holding
SecondHolderEmail varchar 50 Second Holder Email Id
Nature is either
‘JO’ or ‘AS’
Second Holder Email
Declaration flag.
SE - Self;
SP - Spouse; DC
- Dependent
Children.
Mandatory if
DS - Dependent
SecondHolderEmailDeclaration Varchar 2 Second Holder
Siblings;
Email is provided
DP - Dependent
Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA
MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 215
 Second Holder Mobile Mandatory if
number UCC Holding
SecondHolderMobileNo Number 10
Nature is either
‘JO’ or ‘AS’
Second Holder Mobile
Declaration flag.
SE - Self;
SP - Spouse; DC
- Dependent
Children. Mandatory if
DS - Dependent Second Holder
SecondHolderMobileNoDeclaration Varchar 2
Siblings; Mobile No. is
DP - Dependent provided
Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA
Third Holder Email Id Mandatory if
ThirdHolderEmail varchar 50 Third Holder
available in UCC
Third Holder Email
Declaration flag.
SE - Self;
SP - Spouse; DC
- Dependent
Children.
Mandatory if
DS - Dependent
ThirdHolderEmailDeclaration Varchar 2 Third Holder
Siblings;
Email is provided
DP - Dependent
Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA
Third Holder Mobile Mandatory if
ThirdHolderMobileNo Number 10 number Third Holder
available in UCC

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 216
 Third Holder Mobile
Declaration flag.
SE - Self;
SP - Spouse; DC
- Dependent
Children. Mandatory If
DS - Dependent Third Holder
ThirdHolderMobileNoDeclaration Varchar 2
Siblings; Mobile No. is
DP - Dependent provided
Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA

REQUEST RESPONSE PARAMETER (JSON FORMAT)

FIELD FIELD
PARAMETER TYPE LENGTH DESCRIPTION

ErrorMessage Varchar 1000 Array of Individual Records.

Success Flag.
StatusCode Varchar 10 100 – Success
101 - Failure
Type Varchar 20 Type. For Nominee it is ‘NOMINEE’

Remarks Varchar 1000 Verbose remark messages

Filler1 Varchar 50 Filler

Filler2 Varchar 50 Filler

Filler3 Varchar 50 Filler

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 217
Individual Records of ‘ErrorMessage’ field of Request Response Parameter

FIELD FIELD
PARAMETER DESCRIPTION
TYPE LENGTH
CM_MEMBERID Varchar 20 Member code

CM_Code Varchar 10 Client code

CM_NOM_OPT Varchar 1 Nomnation Opt provided

CM_NOM_AUTH_MODE Varchar 1 Nomination Authentication flag

CM_NOM_PAN1 Varchar 10 Nominee 1 PAN

CM_NOM_GUARD_PAN1 Varchar 10 Nominee 1 Guardian PAN

CM_NOM_PAN2 Varchar 10 Nominee 2 PAN

CM_NOM_GUARD_PAN2 Varchar 10 Nominee 2 Guardian PAN

CM_NOM_PAN3 Varchar 10 Nominee 3 PAN

CM_NOM_GUARD_PAN3 Varchar 10 Nominee 3 Guardian PAN

CM_EMAIL2 Varchar 50 Second Holder Email ID

CM_EMAILIDFlag2 Varchar 2 Second Holder Email Declaration flag

CM_MOBILE2 Varchar 10 Second Holder Mobile No.

CM_MOBILEIDFlag2 Varchar 2 Second Holder Mobile Declaration flag

CM_EMAIL3 Varchar 50 Third Holder Email ID

CM_EMAILIDFlag3 Varchar 2 Third Holder Email Declaration flag

CM_MOBILE3 Varchar 10 Third holder Mobile No.

CM_MOBILEIDFlag3 Varchar 2 Third holder Mobile Declaration flag

ErrRemarks Varchar 1000 Verbose Error Remark Message

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 218
BSE StAR MF NOMINATION REGISTRATION API JSON Request & Response

Nominee Registration JSON Request & Response (Sample Format)

1)Array Of Single Nominee Record (New registration)

REQUEST PARAMETER

{
"Type" : "NOMINEE",
"UserId": "<userid>”
"MemberCode":"<membercode>",
"Password": "<password>",
"RegnType" : "NEW",
"FILLER1": "",
"FILLER2":"",
"FILLER3":"",
"Param": [
{
"ClientCode" : "<client code1>",
"NominationOpt" : "<Y/N>",
"NominationAuthMode" : "<O/W/E>",
"NomineePAN1" : "",
"NomineeGuardianPAN1" : "",
"NomineePAN2" : "",
"NomineeGuardianPAN2" : "",
"NomineePAN3" : "",
"NomineeGuardianPAN3" : "",
"SecondHolderEmail" : "",
"SecondHolderEmailDeclaration" : "”,
"SecondHolderMobileNo" : "",
"SecondHolderMobileNoDeclaration" : "”,
"ThirdHolderEmail" : "",
"ThirdHolderEmailDeclaration" : "",
"ThirdHolderMobileNo" : "",
"ThirdHolderMobileNoDeclaration" : ""
}
]
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 219
 RESPONSE PARAMETER

{
"ErrorMessage": [],
"StatusCode": "100",
"Type": "NOMINEE",
"Remarks": "NOMINATION DETAILS REGISTERED SUCCESSFULLY.",
"Filler1": "",
"Filler2": "",
"Filler3": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 220
2)Array Of Multiple Nominee Records (New registration)

REQUEST PARAMETER

{ "Type" : "NOMINEE",
"UserId" : "<userid>",
"MemberCode" : "<membercode>",
"Password" : "<password>",
"RegnType" : "NEW",
"FILLER1" : "",
"FILLER2" : "",
"FILLER3" : "",
"Param" : [
{ "ClientCode" : "<client code1>",
"NominationOpt" : "<Y/N>",
"NominationAuthMode" : "<O/W/E>",
"NomineePAN1" : "",
"NomineeGuardianPAN1" : "",
"NomineePAN2" : "",
"NomineeGuardianPAN2" : "",
"NomineePAN3" : "",
"NomineeGuardianPAN3" : "",
"SecondHolderEmail" : "",
"SecondHolderEmailDeclaration" : "",
"SecondHolderMobileNo" : "",
"SecondHolderMobileNoDeclaration" : "",
"ThirdHolderEmail" : "",
"ThirdHolderEmailDeclaration" : "",
"ThirdHolderMobileNo" : "",
"ThirdHolderMobileNoDeclaration" : ""
},
{ "ClientCode" : "<client code2>",
"NominationOpt" : "<Y/N>",
"NominationAuthMode" : "<O/W/E>",
"NomineePAN1" : "",
"NomineeGuardianPAN1" : "",
"NomineePAN2" : "",
"NomineeGuardianPAN2" : "",
"NomineePAN3" : "",
"NomineeGuardianPAN3" : "",
"SecondHolderEmail" : "",
"SecondHolderEmailDeclaration" : "",
"SecondHolderMobileNo" : "",
"SecondHolderMobileNoDeclaration" : "",
"ThirdHolderEmail" : "",
"ThirdHolderEmailDeclaration" : "",
"ThirdHolderMobileNo" : "",
"ThirdHolderMobileNoDeclaration" : ""
}
]
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 221
 RESPONSE PARAMETER

{
"ErrorMessage": [],
"StatusCode": "100",
"Type": "NOMINEE",
"Remarks": "NOMINATION DETAILS REGISTERED SUCCESSFULLY.",
"Filler1": "",
"Filler2": "",
"Filler3": "" }

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 222
Nominee Modification JSON Request & Response (Sample Format)

1)Array of Single Nominee Record (Modification)

REQUEST PARAMETER

{
"Type" : "NOMINEE",
"UserId": "<userid>”
"MemberCode":"<membercode>",
"Password": "<password>",
"RegnType" : "MOD",
"FILLER1": "",
"FILLER2":"",
"FILLER3":"",
"Param": [
{ "ClientCode" : "<client code1>",
"NominationOpt" : "<Y/N>",
"NominationAuthMode" : "<O/W/E>",
"NomineePAN1" : "",
"NomineeGuardianPAN1" : "",
"NomineePAN2" : "",
"NomineeGuardianPAN2" : "",
"NomineePAN3" : "",
"NomineeGuardianPAN3" : "",
"SecondHolderEmail" : "",
"SecondHolderEmailDeclaration" : "”,
"SecondHolderMobileNo" : "",
"SecondHolderMobileNoDeclaration" : "”,
"ThirdHolderEmail" : "",
"ThirdHolderEmailDeclaration" : "",
"ThirdHolderMobileNo" : "",
"ThirdHolderMobileNoDeclaration" : ""
}
]
}

RESPONSE PARAMETER

{
"ErrorMessage": [],
"StatusCode": "100",
"Type": "NOMINEE",
"Remarks": " NOMINATION DETAILS UPDATED SUCCESSFULLY.",
"Filler1": "",
"Filler2": "",
"Filler3": "" }

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 223
 2)Array Of Multiple Nominee Records (Modification)

REQUEST PARAMETER

{
"Type" : "NOMINEE",
"UserId": "<userid>”
"MemberCode":"<membercode>",
"Password": "<password>",
"RegnType" : "MOD",
"FILLER1": "",
"FILLER2":"",
"FILLER3":"",
"Param": [
{ "ClientCode" : "<client code1>",
"NominationOpt" : "<Y/N>",
"NominationAuthMode" : "<O/W/E>",
"NomineePAN1" : "",
"NomineeGuardianPAN1" : "",
"NomineePAN2" : "",
"NomineeGuardianPAN2" : "",
"NomineePAN3" : "",
"NomineeGuardianPAN3" : "",
"SecondHolderEmail" : "",
"SecondHolderEmailDeclaration" : "”,
"SecondHolderMobileNo" : "",
"SecondHolderMobileNoDeclaration" : "”,
"ThirdHolderEmail" : "",
"ThirdHolderEmailDeclaration" : "",
"ThirdHolderMobileNo" : "",
"ThirdHolderMobileNoDeclaration" : ""
},
{ "ClientCode" : "<client code2>",
"NominationOpt" : "<Y/N>",
"NominationAuthMode" : "<O/W/E>",
"NomineePAN1" : "",
"NomineeGuardianPAN1" : "",
"NomineePAN2" : "",
"NomineeGuardianPAN2" : "",
"NomineePAN3" : "",
"NomineeGuardianPAN3" : "",
"SecondHolderEmail" : "",
"SecondHolderEmailDeclaration" : "",
"SecondHolderMobileNo" : "",
"SecondHolderMobileNoDeclaration" : "",
"ThirdHolderEmail" : "",
"ThirdHolderEmailDeclaration" : "",
"ThirdHolderMobileNo" : "",
"ThirdHolderMobileNoDeclaration" : ""
}
]
}
MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 224
RESPONSE PARAMETER

{
"ErrorMessage": [],
"StatusCode": "100",
"Type": "NOMINEE",
"Remarks": " NOMINATION DETAILS UPDATED SUCCESSFULLY.",
"Filler1": "",
"Filler2": "",
"Filler3": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 225
BSE StAR MF NOMINEE IMAGE UPLOAD WEBSERVICE API MESSAGE
STURCTURE

NOMINEE IMAGE UPLOAD STRUCTURE

The Image should be in PDF format only. Maximum size limit for Nomination Image is 1MB.

Nomination Image Upload API URL

URL https://bsestarmfdemo.bseindia.com/BSEMFWEBAPI/api/upload/dynamicupd/w

REQUEST PARAMETER (JSON FORMAT)

FIELD TYPE FIELD
PARAMETER LENGTH DESCRIPTION MANDATORY

LoginId Varchar 20 User id Mandatory

Password Varchar 10 Password Mandatory

MemberCode Varchar 10 Member code Mandatory

clientCode Varchar 10 Ucc Mandatory

Filler1 Varchar 50 Filler Non-Mandatory

Type name should be ‘NOMINEE’

Type Varchar 20 for Nominee Image upload. Mandatory

Flag Varchar 10 Flag value should be ‘BASE_64’ Mandatory

Nominee image name or file

Filename Varchar 100 Mandatory
name.
Extension Varchar 20 Extension value should be ‘PDF’ Mandatory

BASE_64 String max Base64 string Mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 226
RESPONSE PARAMETER (JSON FORMAT)

FIELD FIELD
PARAMETER TYPE LENGTH DESCRIPTION

Filler1 Varchar 50 Filler

Filler2 Varchar 50 Filler

Type Varchar 20 Type name provided in request.

Success Flag
StatusCode Varchar 10 0 – Success
1 - Failure
Remark Varchar 1000 Verbose Remark Message

BSE StAR MF NOMINEE IMAGE UPLOAD API JSON Request & Response

Nominee Image upload JSON Request & Response - BASE_64 (Sample Format)

REQUEST PARAMETER

{
"LoginId" : "<userid>",
"Password" :"<password>",
"MemberCode": "<membercode>" ,
"clientCode" : "<clientcode>",
"Filler1" :"",
"Type" :"NOMINEE",
"Flag" : "BASE_64",
"Filename":"<Nominee Filename>",
"Extension":"PDF",
"BASE_64":"RGV2ZWxvcGVyIHByb2R1Y3Rpdml0eSBpcyBtZWFzdXJlZCBpbiBjYWZmZWluZSBpbnRha
2
UuIFRoZSBtb3JlIGNvZmZlZSBhIGRldmVsb3BlciBjb25zdW1lcywgdGhlIGhpZ2hlciBpcyB0aGVpciBwcm
9
kdWN0aXZpdHkuIEl0J3MgcnVtb3JlZCB0aGF0IGRldmVsb3BlcnMgYXQgR29vZ2xlIGNvbnN1bWUgdXA
gdG8gdHdvIGh1bmRyZWQgY3VwcyBvZiBjb2ZmZWUgYSBkYXku"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 227
 RESPONSE PARAMETER

{
"Filler1": "",
"Filler2": "",
"Type": "NOMINEE",
"StatusCode": "0",
"Remark": "DATA UPLOADED SUCCESSFULLY"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 228
BSE StAR MF NOMINEE 2FA API WEBSERVICE MESSAGE STRUCTURE

NOMINEE 2FA STRUCTURE

Members can consume the Exchange webservice to open the Nomination

Authentication details for the Client to enter the OTP and confirm the nominee
details.
The exchange shall send the webpage link to be opened in the member website or
mobile app.

Nomination 2FA API URL

URL https://bsestarmfdemo.bseindia.com/BSEMFWEBAPI/api/_2FANOMINEEController/_2FANOMINEE/w

REQUEST PARAMETER (JSON FORMAT)

FIELD FIELD MANDATORY/

PARAMETER TYPE LENGTH DESCRIPTION NON-
MANDATORY
LoginId Varchar 20 User id Mandatory
Password Varchar 20 Password Mandatory

MemberCode Varchar 20 Member Code Mandatory

clientCode Varchar 10 Client code Mandatory

InternalRefrenceNo Varchar 20 Internal reference no. Non-Mandatory

NOT AVAILABLE PRESENTLY, FOR

FUTURE USE.
VALUE = ‘Y’ OR ‘N’.
IF ‘Y’ AN ADDITIONAL VARIABLE
AllowLoopBack Varchar 1 WILL BE SENT AS REDIRECTION IN Mandatory
THE LOOPBACK URL
?STATUS=SUCCESS/
FAILURE/PENDING

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 229
 2FA authentication link should be
send to which type of holder. For
Filler1 50 Primary Holder = ‘1’ Mandatory
For Secondary Holder = ‘2’
For Third Holder = ‘3’
Filler2 50 Filler Non-Mandatory

Filler3 50 Filler Non-Mandatory

Logout URL or Loopback URL to be

provided by member for redirecting
LoopbackReturnUrl Varchar 1000 back to members logout URL/ Mandatory
loopback URL after successful 2FA.

type Varchar 20 Type Name provided in request Mandatory

RESPONSE PARAMETER (JSON FORMAT)

FIELD FIELD
PARAMETER DESCRIPTION
TYPE LENGTH
Filler1 Filler 50 Holder value provided in request ‘Filler1’ parameter

Filler2 Filler 50 Filler

Filler3 Filler 50 Filler

Type Varchar 20 Type Name provided in request

LoopbackReturnUrl Varchar 1000 The URL for Loopback

ErrorDescription Varchar 200 The Error / Success Description

Success Status code

StatusCode Varchar 10 100- success
101- failure

InternalRefrenceNo Varchar 50 Internal reference no.

The URL for 2FA Authentication to be opened in the member

ReturnUrl Varchar 20
site or app

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 230
BSE StAR MF NOMINEE 2FA API JSON Request & Response

Nominee 2FA API JSON Request & Response (Sample Format)

REQUEST PARAMETER

{
"LoginId" : "<user id>",
"Password" :"<password>",
"MemberCode": "<member code>" ,
"clientCode" : "<clientcode>",
"InternalRefrenceNo" :" ",
"AllowLoopBack":"<Y/N>",
"Filler1" :"1",
"Filler2" :" ",
"Filler3" :" " ,
"LoopbackReturnUrl" :"https://www.bseindia.com",
"type" :"NOMINEE"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 231
 MUTUAL FUND COMBINED UCC -
NOMINATION API WEB SERVICE
MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 232
MUTUAL FUND COMBINED UCC- NOMINATION REGISTRATION API
WEBSERVICE STRUCTURE

BSE StAR MF Combined UCC-Nomination API Webservice Structure is a new common ucc & nomination detail
registration structure for all MFIs/ MFDs/RIAs/Vendors. The Structure is in the JSON based format.

URL https://bsestarmfdemo.bseindia.com/BSEMFWEBAPI/api/ClientRegistration/Registration

Request Parameter (Json Format)

Parameter Field Field

Description & Value Mandatory JSON Name
Name Type Length
User Id Varchar 20 User id Mandatory UserId
Member Code Varchar 20 Member id Mandatory MemberCode
Password Varchar Password Mandatory Password
NEW = for new Mandatory
Registration
Varchar 10 registration. RegnType
Type
MOD = for modification.
Parameters shall be as Mandatory
Parameter String Param
pipe separated values.
Filler 1 Varchar 50 Non - mandatory Filler1
Filler 2 Varchar 50 Non - mandatory Filler2

Pipe separated values of “Parameter” field of API Request Structure is as given below:-

Sr. Field
Field Name Mandatory Remarks Data Type
No. Length
1 Client Code (UCC) Mandatory char 10
Primary Holder First
2 Mandatory char 70
Name
Primary Holder Middle
3 Optional char 70
Name
Primary Holder Last
4 Optional char 70
Name
5 Tax Status Mandatory Refer Tax Status char 2
Mandatory for Individual, NRI and
Conditional
6 Gender Minor clients. char 1
Mandatory
M/F/O

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 233
 Primary Holder
7 Mandatory DD/MM/YYYY char 10
DOB/Incorporation
8 Occupation Code Mandatory Refer Occupation Code 2
9 Holding Nature Mandatory Refer Holding (SI/ JO/ AS) char 2
Second Holder First Conditional Mandatory if Holding nature is
10 char 70
Name Mandatory either 'JO' or 'AS'
Second Holder Middle
11 Optional char 70
Name
Second Holder Last
12 Optional char 70
Name
Third Holder First
13 Optional char 70
Name
Third Holder Middle
14 Optional char 70
Name
Third Holder Last
15 Optional char 70
Name
16 Second Holder DOB Optional DD/MM/YYYY DATE 10
17 Third Holder DOB Optional DD/MM/YYYY DATE 10
Conditional
18 Guardian First Name Mandatory for Minor Clients char 120
Mandatory
Guardian Middle
19 Optional char 120
Name
20 Guardian Last Name Optional char 120
21 Guardian DOB Optional DD/MM/YYYY DATE 10
Primary Holder PAN
22 Mandatory Y/N Varchar 1
Exempt
Second Holder PAN
23 Mandatory Y/N Varchar 1
Exempt
Third Holder PAN
24 Mandatory Y/N Varchar 1
Exempt
25 Guardian PAN Exempt Mandatory Y/N Varchar 1
Conditional Mandatory if Primary Holder PAN
26 Primary Holder PAN char 10
Mandatory Exempt flag N.
Mandatory if Second Holder PAN
Exempt flag N.
27 Second Holder PAN Optional char 10
Mandatory if Second Holder name
is provided
Mandatory if Third Holder PAN
Exempt flag N.
28 Third Holder PAN Optional 10
Mandatory if Third Holder name is
provided
Conditional Mandatory if Guardian PAN
29 Guardian PAN char 10
Mandatory Exempt flag N.
Mandatory if PRIMARY Holder PAN
Primary Holder- Conditional
30 Exempt flag Y. Refer PAN Exempt Varchar 2
Exempt Category Mandatory
Category

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 234
 Mandatory if SECOND Holder PAN
Second Holder- Conditional
31 Exempt flag Y. Refer PAN Exempt Varchar 2
Exempt Category Mandatory
Category
Mandatory if THIRD Holder PAN
Third Holder- Exempt Conditional
32 Exempt flag Y. Refer PAN Exempt Varchar 2
Category Mandatory
Category
Mandatory if GAURDIAN Holder
Guardian Exempt Conditional
33 PAN Exempt flag Y. Refer PAN Varchar 2
Category Mandatory
Exempt Category
34 Client Type Mandatory P / D (P- Physical /D- Demat) Varchar 1
35 PMS Optional (Y/N) CHAR 1
Conditional Mandatory if client type D
36 Default DP char 4
Mandatory (CDSL/NSDL)
Conditional
37 CDSL DPID Mandatory if Default DP is CDSL char 8
Mandatory
Conditional
38 CDSLCLTID Mandatory if Default DP is CDSL char 16
Mandatory
Conditional Mandatory if PMS Flag is ‘Y’ and
39 CMBP Id Number 16
Mandatory client Default DP is NSDL
Conditional
40 NSDLDPID Mandatory if Default DP if NSDL char 8
Mandatory
Conditional
41 NSDLCLTID Mandatory if Default DP if NSDL char 8
Mandatory
42 Account Type 1 Mandatory Refer Account Type varchar 2
43 Account No 1 Mandatory varchar 40
44 MICR No 1 Optional varchar 9
45 IFSC Code 1 Mandatory varchar 11
46 Default Bank Flag Mandatory Y/N varchar 1
47 Account Type 2 Optional Refer Account Type varchar 2
Conditional Mandatory if Client Acctype 2 is
48 Account No 2 varchar 40
Mandatory available
49 MICR No 2 Optional varchar 9
Conditional Mandatory if Client Acctype 2 is
50 IFSC Code 2 varchar 11
Mandatory available and MICR not available
Conditional Mandatory if Client Acctype 2 is
51 Default Bank Flag varchar 1
Mandatory available (Y/N)
52 Account type 3 Optional Refer Account Type varchar 2
Conditional Mandatory if Client Acctype 3 is
53 Account No 3 varchar 40
Mandatory available
54 MICR No 3 Optional varchar 9
Conditional Mandatory if Client Acctype 3 is
55 IFSC Code 3 varchar 11
Mandatory available and MICR not available
Conditional Mandatory if Client Acctype 3 is
56 Default Bank Flag varchar 1
Mandatory available (Y/N)

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 235
57 Account type 4 Optional Refer Account Type varchar 2
Conditional Mandatory if Client Acctype 4 is
58 Account No 4 varchar 40
Mandatory available
59 MICR No 4 Optional varchar 9
Conditional Mandatory if Client Acctype 4 is
60 IFSC Code 4 varchar 11
Mandatory available and MICR not available
Conditional Mandatory if Client Acctype 4 is
61 Default Bank Flag varchar 1
Mandatory available (Y/N)
62 Account type 5 Optional Refer Account Type varchar 2
Conditional Mandatory if Client Acctype 5 is
63 Account No 5 varchar 40
Mandatory available
64 MICR No 5 Optional varchar 9
Conditional Mandatory if Client Acctype 5 is
65 IFSC Code 5 varchar 11
Mandatory available and MICR not available
Conditional Mandatory if Client Acctype 5 is
66 Default Bank Flag varchar 1
Mandatory available (Y/N)
67 Cheque name Optional varchar 35
68 Div pay mode Mandatory 01/02/03/04/05 varchar 2
Conditional
69 Address 1 Not mandatory for NRI varchar 40
Mandatory
70 Address 2 Optional varchar 40
71 Address 3 Optional varchar 40
72 City Mandatory Not mandatory for NRI varchar 35
73 State Mandatory Not mandatory for NRI varchar 2
74 Pincode Mandatory Not mandatory for NRI varchar 6
75 Country Mandatory Not mandatory for NRI varchar 35
76 Resi. Phone Optional Not mandatory for NRI varchar 15
77 Resi. Fax Optional Not mandatory for NRI varchar 15
78 Office Phone Optional Not mandatory for NRI varchar 15
79 Office Fax Optional Not mandatory for NRI varchar 15
80 Email Mandatory varchar 50
81 Communication Mode Mandatory P-Physical/E-Email/M-Mobile varchar 1
Special character (-/) Hyphen &
Conditional Oblique to be allowed. Mandatory
82 Foreign Address 1 varchar 40
Mandatory for NRI, Except for Seafarer. Refer
Tax Status
Special character (-/) Hyphen &
83 Foreign Address 2 Optional varchar 40
Oblique to be allowed
Special character (-/) Hyphen &
84 Foreign Address 3 Optional varchar 40
Oblique to be allowed
Conditional
85 Foreign Address City Mandatory for NRI varchar 35
Mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 236
 Foreign Address Conditional
86 Mandatory for NRI varchar 10
Pincode Mandatory
Conditional
87 Foreign Address State Mandatory for NRI varchar 35
Mandatory
Foreign Address Conditional
88 Mandatory for NRI varchar 3
Country Mandatory
Foreign Address Resi
89 Optional varchar 15
Phone
90 Foreign Address Fax Optional varchar 15
Foreign Address Off.
91 Optional varchar 15
Phone
Foreign Address Off.
92 Optional varchar 15
Fax
93 Indian Mobile No. Mandatory varchar 10
94 Nominee 1 Name Optional varchar 40
Nominee 1 Conditional Mandatory if client nominee
95 varchar 40
Relationship Mandatory available
Nominee 1 Conditional Mandatory if client nominee
96 Number 5,2
Applicable(%) Mandatory available
Conditional Mandatory if client nominee
97 Nominee 1 Minor Flag Char 1
Mandatory available
Mandatory only if Nominee minor
Conditional
98 Nominee 1 DOB flag Y Date
Mandatory
DD/MM/YYYY
Conditional
99 Nominee 1 Guardian Mandatory if Nominee minor flag Y Char 35
Mandatory
100 Nominee 2 Name Optional Char 40
Nominee 2 Conditional
101 Mandatory if Nominee 2 available Char 40
Relationship Mandatory
Nominee 2 Conditional
102 Mandatory if Nominee 2 available Number 5,2
Applicable(%) Mandatory
Conditional Mandatory if Nominee 2 available
103 Nominee 2 DOB Date 10
Mandatory DD/MM/YYYY
Conditional
104 Nominee 2 Minor Flag Mandatory if Nominee 2 available Varchar 1
Mandatory
Conditional
105 Nominee 2 Guardian Mandatory if Nominee 2 available Char 35
Mandatory
106 Nominee 3 Name Optional Char 40
Nominee 3 Conditional
107 Mandatory if Nominee 3 available Char 40
Relationship Mandatory
Nominee 3 Conditional
108 Mandatory if Nominee 3 available Number 5,2
Applicable(%) Mandatory
Conditional Mandatory if Nominee 3 available
109 Nominee 3 DOB Date 10
Mandatory DD/MM/YYYY
Conditional
110 Nominee3 Minor Flag Mandatory if Nominee 3 available Varchar 1
Mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 237
 Conditional
111 Nominee3 Guardian Mandatory if Nominee 3 available Char 35
Mandatory
(K/C/B/E) (K - KRA Compliant
Primary Holder KYC C- CKYC Compliant
112 Mandatory CHAR 1
Type B- BIOMETRIC KYC
E- Aadhaar Ekyc PAN)
Primary Holder CKYC Conditional
113 Mandatory if primary holder Numeric 14
Number Mandatory
(K/C/B/E) (K - KRA Compliant
Second Holder KYC C- CKYC Compliant
114 Optional CHAR 1
Type B- BIOMETRIC KYC
E- Aadhaar Ekyc PAN)
Second Holder CKYC Conditional
115 Mandatory if second holder Numeric 14
Number Mandatory

(K/C/B/E) (K - KRA CompliantC-

116 Third Holder KYC Type Optional CKYC CompliantB- BIOMETRIC KYC CHAR 1
E- Aadhaar Ekyc PAN)

Third Holder CKYC Conditional Mandatory if third holder KYC type

117 Numeric 14
Number Mandatory 'C'
(K/C/B/E) (K - KRA Compliant
C- CKYC Compliant
118 Guardian KYC Type Optional CHAR 1
B-BIOMETRIC KYC
E- Aadhaar Ekyc PAN)
Guardian CKYC Conditional
119 Mandatory if Guardian KYC type 'C' Numeric 14
Number Mandatory
Primary Holder KRA Conditional Mandatory if Primary Holder Pan
120 Varchar 10
Exempt Ref. No. Mandatory Exempt
Second Holder KRA Conditional Mandatory if Second Holder Pan
121 Varchar 10
Exempt Ref. No. Mandatory Exempt
Third Holder KRA Conditional Mandatory if Third Holder Pan
122 Varchar 10
Exempt Ref. No Mandatory Exempt
Guardian Exempt Ref. Conditional
123 Mandatory if Guardian Pan Exempt Varchar 10
No Mandatory
124 Aadhaar Updated Optional Y/N Char 1
125 Mapin Id. Optional varchar 16
Investor onboarding P- Paper/ Z-
126 Paperless_flag Mandatory Char 1
paperless
Mandatory for Non - Individual &
127 LEI No Optional Varchar 20
HUF for orders above Rs.50 crores
Conditional
128 LEI Validity Mandatory if LEI No is given Date 10
Mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 238
 Mandatory if Mobile No. is
provided
SE - Self;
SP - Spouse;
DC - Dependent Children.
Filler 1 ( Mobile Conditional
129 DS - Dependent Siblings; Varchar 2
Declaration Flag ) Mandatory
DP - Dependent Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA

Mandatory if Email Id. Provided

SE - Self;
SP - Spouse;
DC - Dependent Children.
Filler 2 (Email Conditional DS - Dependent Siblings;
130 Varchar 2
Declaration Flag ) Mandatory DP - Dependent Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA

131 Nomination Opt Mandatory Nomination Opt : Y/N Varchar 1

132 Nomination Auth Mandatory Nomination Authentication Modes: Varchar 1
Mode W - Wet Signature;
E - eSign;
O - OTP authentication
133 Nominee PAN1 Optional Nominee 1 PAN Varchar 10
134 Nominee Guardian Optional Nominee 1 Guardian PAN Varchar 10
PAN1
135 Nominee PAN2 Optional Nominee 2 PAN Varchar 10
136 Nominee Guardian Optional Nominee 2 Guardian PAN Varchar 10
PAN2
137 Nominee PAN3 Optional Nominee 3 PAN Varchar 10
138 Nominee Guardian Optional Nominee 3 Guardian PAN Varchar 10
PAN3
139 Second Holder Email Mandatory if Second Holder Email Id varchar 50
UCC Holding
Nature is either
‘JO’ or ‘AS’

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 239
140 Second Holder Email Mandatory if Second Holder Email Declaration Varchar 2
Declaration Second Holder flag.
Email is SE - Self;
provided SP - Spouse;
DC - Dependent Children.
DS - Dependent Siblings;
DP - Dependent Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA
141 Second Holder Mobile Mandatory if Second Holder Mobile number Number 10
No UCC Holding
Nature is either
‘JO’ or ‘AS’
142 Second Holder Mobile Mandatory if Second Holder Mobile Declaration Varchar 2
No Declaration Second Holder flag.
Mobile No. is SE - Self;
provided SP - Spouse;
DC - Dependent Children.
DS - Dependent Siblings;
DP - Dependent Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA
143 Third Holder Email Mandatory if Third Holder Email Id varchar 50
Third Holder
available in UCC
144 Third Holder Email Mandatory if Third Holder Mobile Declaration Varchar 2
Declaration Third Holder flag.
Email is SE - Self;
provided SP - Spouse;
DC - Dependent Children.
DS - Dependent Siblings;
DP - Dependent Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA
145 Third Holder Mobile Mandatory if Third Holder Mobile number Number 10
No Third Holder
available in UCC

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 240
146 Third Holder MobileNo Mandatory If Third Holder Mobile Declaration Varchar 2
Declaration Third Holder flag. SE - Self;
Mobile No. is SP - Spouse;
provided DC - Dependent Children.
DS - Dependent Siblings;
DP - Dependent Parents;
GD - Guardian;
PM - PMS;
CD - Custodian;
PO – POA

Response Parameter (Json Format)

Field Field Description

Parameter Name Sample Values JSON Name
Type Length
Success flag 0 - Success &
STATUS flag Varchar 20 Status
1 - Failure
Return Remarks Verbose
BSE Remarks Varchar 20 Remarks
Messages
Filler 1 Varchar 50 Filler1
Filler 2 Varchar 50 Filler2

SAMPLE JSON FORMAT (New Registration)

Request Parameter

{
"UserId" : "<userid>",
"MemberCode" : "<memberid>",
"Password" : "<password>",
"RegnType" : "NEW",
"Param":"clientcode|FirstName||LastName|01|M|01/01/1970|01|SI|||||||||||||N||||AF
EPK2130F||||||||P||||||||SB|11415||HDFC0000001|Y|||||||||||||||||||||FirstName
LastName|01|ADD1|ADD2|ADD3|MUMBAI|MA|400001|INDIA|22721233||||[email protected]
|P||||||||||||9999999999|||||||||||||||||||K||||||||||||N||P|||SE|SE|Y|W|||||||||
|||||",
"Filler1" : "",
"Filler2": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 241
 Response Parameter

{
"Status": "0",
"Remarks": "CLIENT REGISTERED SUCCESSFULLY",
"Filler1": "",
"Filler2": ""
}

SAMPLE JSON FORMAT (Modification)

Request Parameter

{
"UserId" : "<userid>",
"MemberCode" : "<membered>",
"Password" : "<password>",
"RegnType" : "MOD",
"Param" :
"clientcode|FirstName||LastName|01|M|01/01/1970|01|SI|||||||||||||N||||AFEPK2130F
||||||||P||||||||SB|11415||HDFC0000001|Y|||||||||||||||||||||FirstName
LastName|01|ADD1|ADD2|ADD3|MUMBAI|MA|400001|INDIA|22721233||||[email protected]
|P||||||||||||9999999999|||||||||||||||||||K||||||||||||N||P|||SE|SE|Y|W|||||||||
|||||",
"Filler1" : "",
"Filler2" : ""
}

Response Parameter

{
"Status": "0",
"Remarks": "CLIENT UPDATED SUCCESSFULLY",
"Filler1": "",
"Filler2": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 242
 MUTUAL FUND ENHANCED SIP & XSIP
REGISTRATION API WEBSERVICE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 243
MUTUAL FUND ENHANCED SIP & XSIP REGISTRATION API WEBSERVICE
MESSAGE STRUCTURE

StAR MF Enhanced API KEY

Please add the APIKEY Key Value pair in each of the requests in the Header of the request for Authorization of
the request.

SrNo Header Description

1 APIKEY VmxST1UyRkhUbkpOVldNOQ==

Note : A process note on how to configure POSTMAN for API testing is given at the end of the document.

ENHANCED SIP REGISTRATION API STRUCTURE

The Post URL for SIP Registration

URL https://bsestarmfdemo.bseindia.com/StarMFAPI/api/SIP/SIPRegistration

API Structure Details

Request Field Parameters: (Field Details)

Parameter Name Type Length Description Sample values Mandatory

Login ID Varchar 20 BSE user id Mandatory
Member Id Varchar 20 BSE member code Mandatory
Password Varchar BSE password Mandatory
Scheme Code Varchar 20 BSE scheme code Mandatory
Client Code Varchar 20 BSE client code Mandatory
Internalrefno Varchar 20 Internal reference Non-Mandatory
number
Transmode Varchar 1 Demat or physical D/P Mandatory
Dp Transaction Char 1 CDSL/NSDL/Physical C/N/P Mandatory
Mode
Start Date Varchar 10 Start date of the SIP DD/MM/YYYY Mandatory
Frequency Type Varchar 20 Type of frequency MONTHLY/ Mandatory
QUARTERLY/ WEEKLY

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 244
Frequency Allowed Int 1 Rolling frequency 1 Mandatory
Installment Money Instalment amount Mandatory
Amount
No Of Installments Int 4 Number of instalments Mandatory
8/10/12/15 years
– validation
Remarks Varchar 100 Non - mandatory
Folio No Varchar 20 Mandatory in case of
physical SIP
Firstorderflag Char 1 First order today flag Y/N Mandatory
Subbrcode Varchar 15 Sub broker code Non - mandatory
Euin Varchar 20 EUIN number Mandatory
Euin Declaration Varchar 1 EUIN declaration flag Y/N Mandatory
Flag
Dpc Char 1 DPC flag Y/N Mandatory
Sub Broker Arn Varchar 20 Filler 1 will be used as Non - mandatory
sub broker arn code
End Date Varchar 10 End Date for Daily SIP DD/MM/YYYY Mandatory only in
case of daily SIP
Sip Type Varchar 2 01- Regular SIP
02- Power SIP
03- Freedom SIP
Mandatory
07- MITRA XSIP
08- SAMPOORNA XSIP
09- WHITEOAK XSIP
Target Scheme Varchar 20 BSE scheme code Mandatory for SIP
type 03, 07, 08, 09
Target Amount Money Mandatory for SIP
type 03, 07, 08 09
Goal Type Varchar 2 Kindly refer Goal Type Mandatory for SIP
table type “02”
Goal Amount Money 100 Mandatory for SIP
type “02”
Filler 1 ( Primary Varchar 10 Primary Holder Mobile Non-Mandatory
Holder Mobile ) Number
Filler 2 ( Primary Varchar 50 Primary Holder Email Non-Mandatory
Holder Email ) ID
Filler 3 Varchar 50

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 245
 Filler 4 Varchar 50
Filler 5 Varchar 50
Filler 6 Varchar 100
Filler 7 Varchar 100
Filler 8 Varchar 100
Filler 9 Varchar 100
Filler 10 Varchar 100

Goal Type

Goal Type Codes

Kids Marriage 01
Retirement Planning 02
Kids’ Education 03
Tax Savings 04
Dream House 05
Dream Car 06
Dream Vacation 07
Others 08

Response Field Parameters: (Field Details)

Parameter Name Type Length Description Sample values

SIP REG_ID Bigint SIP Registration Number
Bse remarks Varchar 1000 Bse Response Return remarks
Success flag Varchar 1 Order success flag 0 - Success & 1 -
failure
Internal reference Varchar 20
number
Filler 1 Varchar 100
Filler 2 Varchar 100
Filler 3 Varchar 100
Filler 4 Varchar 100
Filler 5 Varchar 100

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 246
StAR MF Enhanced SIP Registration Structure API JSON Request & Response

SIP Registration Structure

Request (JSON Format)

{
"LoginId": "1234501",
"MemberCode": "12345",
"Password": "123456",
"SchemeCode": "02-DP",
"ClientCode": "Client",
"IntRefNo": "1234567",
"TransMode": "P",
"DPTransMode": "P",
"StartDate": "21/07/2021",
"FrequencyType": "MONTHLY",
"FrequencyAllowed": "1",
"InstAmount": "500",
"NoOfInst": "12",
"Remarks": "",
"FolioNo": "123",
"FirstOrderFlag": "Y",
"SubBrCode": "786",
"EUIN": "E123456",
"EUINFlag": "Y",
"DPC": "Y",
"SubBrokerARN": "ARN-58965",
"EndDate": "",
"SIPType": "01",
"TargetScheme": "",
"TargetAmount": "",
"GoalType": "",
"GoalAmount": "",
"Filler1": "",
"Filler2": "",
"Filler3": "",
"Filler4": "",
"Filler5": "",
"Filler6": "",
"Filler7": "",

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 247
 "Filler8": "",
"Filler9": "",
"Filler10": ""
}

Response (JSON Format)

{
"SIPRegId": "451666",
"BSERemarks": "SIP HAS BEEN REGISTERED, SIP REG NO IS : 451666",
"SuccessFlag": "0",
"IntRefNo": "1234567",
"Filler1": "",
"Filler2": "",
"Filler3": "",
"Filler4": "",
"Filler5": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 248
 StAR MF ENAHNCED SIP CANCELLATION API STRUCTURE

API Structure Details

The Post URL for SIP Cancellation

URL https://bsestarmfdemo.bseindia.com/StarMFAPI/api/SIP/SIPCancellation

Request Field Parameters: (Field Details)

Parameter Name Type Length Description Sample values Mandatory

Login ID Varchar 20 mandatory
MemberId varchar 20 BSE member code mandatory
Password varchar mandatory
Client Code varchar 10 mandatory
Registration number bigint mandatory
Internal reference number Varchar 20 non -
mandatory

Response Field Parameters: (Field Details)

Parameter Name Type Length Description Sample values

SIP REG_ID bigint
Bse remarks varchar 1000 Bse Response Return remarks
Success flag varchar 1 Order success flag 0 - Success & 1 - failure
Internal reference number varchar 20

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 249
StAR MF Enhanced SIP Cancellation Structure API JSON Request & Response

SIP Cancellation Structure

Request (JSON Format)

{
"LoginId" : "1234501",
"MemberCode" : "12345",
"Password" : "123456",
"ClientCode" : "client",
"RegnNo" : "419184",
"IntRefNo" : "1234"
}

Response (JSON Format)

{
"SIPRegId": "419184",
"BSERemarks": "SIP WITH REGN NO 419184 IS CANCELLED SUCCESSFULLY",
"SuccessFlag": "0",
"IntRefNo": "1234"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 250
 StAR MF ENHANCED XSIP REGISTRATION API STRUCTURE

API Structure Details

The Post URL for XSIP Registration

URL https://bsestarmfdemo.bseindia.com/StarMFAPI/api/XSIP/XSIPRegistration

Request Field Parameters: (Field Details)

Parameter Name Type Length Description Sample values Mandatory

Login ID Varchar 20 mandatory
MemberId varchar 20 BSE member code mandatory
Password varchar mandatory
SchemeCd varchar 20 BSE scheme code mandatory
ClientCode varchar 20 BSE client code mandatory
INTERNALREFNO varchar 50 internal reference non - mandatory
number
TRANSMODE varchar 1 demat or physical D/P mandatory

DP TRANSACTION char 1 CDSL/NSDL/PHYSICAL C/N/P mandatory

MODE
START DATE varchar 10 start date of the SIP DD/MM/YYYY mandatory

FREQUENCY TYPE varchar 20 type of frequency MONTHLY/ mandatory

QUARTERLY/WEEKLY
frequency allowed int 1 rolling frequency 1 mandatory
INSTALLMENT money installment amount Mandatory
AMOUNT
NO OF int 4 number of Mandatory
INSTALLMENTS installments 8/10/12/15 years –
validation
REMARKS varchar 100 non - mandatory

FOLIO NO varchar 20 mandatory in case of conditional

physical SIP mandatory
FIRSTORDERFLAG char 1 first order today flag Y/N mandatory
SUBBRCODE varchar 15 sub broker code non - mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 251
 EUIN varchar 20 EUIN number mandatory
EUIN varchar 1 EUIN declaration flag Y/N mandatory
DECLERATION
FLAG
DPC char 1 DPC flag Y/N mandatory

Sub Broker ARN varchar 20 Filler 1 Will Be Used non - mandatory

As Sub Broker ARN
Code
End Date varchar 10 End Date for Daily SIP DD/MM/YYYY Mandatory only in
case of daily SIP
Registration Type Varchar 5 ISIP/XSIP mandatory

Brokerage money non - mandatory

Mandate ID Varchar 20 mandatory

XSIP TYPE Varchar 2 01- Regular XSIP Mandatory

02- Power XSIP

03- Freedom XSIP

07- MITRA XSIP

08- SAMPOORNA
XSIP
09- WHITEOAK XSIP

Target Scheme varchar 50 BSE scheme code Mandatory for XSIP

type 03, 07, 08, 09
Target Amount Money Mandatory for XSIP
type 03, 07, 08 09
Goal type Varchar 2 Kindly refer goal Type Mandatory for XSIP
table type “02”
Goal amount money Mandatory for XSIP
type “02”
Filler 1 ( Primary 10 Primary Holder Non-Mandatory
Holder Mobile ) Varchar Mobile number
Filler 2 ( Primary 50 Primary Holder Email Non-Mandatory
Holder Email ) Varchar ID
Filler 3 50

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 252
 Filler 4 50

Filler 5 50

Filler 6 100

Filler 7 100

Filler 8 100

Filler 9 100

Filler 10 100

GOAL TYPE

Goal Type Codes

Kids Marriage 01
Retirement Planning 02
Kids’ Education 03
Tax Savings 04
Dream House 05
Dream Car 06
Dream Vacation 07
Others 08

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 253
Response Field Parameters: (Field Details)

Parameter Name Type Length Description Sample values

XSIP REG_ID bigint
BSE remarks varchar 1000 BSE Response return remarks
Success flag varchar 1 Order success flag 0 - Success & 1 - Failure
Internal reference number varchar 20
Filler 1 varchar 100
Filler 2 varchar 100
Filler 3 varchar 100
Filler 4 varchar 100
Filler 5 varchar 100

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 254
 StAR MF Enhanced XSIP Registration Structure API JSON Request & Response

XSIP Registration Structure

Request (JSON Format)

{
"LoginId": "1234501",
"MemberCode": "12345",
"Password": "123456",
"SchemeCode": "02-DP",
"ClientCode": "client",
"IntRefNo": "1234567",
"TransMode": "P",
"DPTransMode": "P",
"StartDate": "10/02/2022",
"FrequencyType": "MONTHLY",
"FrequencyAllowed": "1",
"InstAmount": "500",
"NoOfInst": "12",
"Remarks": "",
"FolioNo": "123",
"FirstOrderFlag": "Y",
"SubBrCode": "786",
"EUIN": "E123456",
"EUINFlag": "Y",
"DPC": "Y",
"SubBrokerARN": "ARN-58965",
"EndDate": "",
"RegnType": "XSIP",
"Brokerage": "",
"MandateId": "715089",
"XSIPType": "01",
"TargetScheme": "",
"TargetAmount": "",
"GoalType": "",
"GoalAmount": "",
"Filler1": "",
"Filler2": "",
"Filler3": "",
"Filler4": "",
"Filler5": "",
"Filler6": "",
MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 255
 "Filler7": "",
"Filler8": "",
"Filler9": "",
"Filler10": ""
}

Response (JSON Format)

{
"XSIPRegId": "451677",
"BSERemarks": "X-SIP HAS BEEN REGISTERED, REG NO IS : 451677",
"SuccessFlag": "0",
"IntRefNo": "1234567",
"Filler1": "",
"Filler2": "",
"Filler3": "",
"Filler4": "",
"Filler5": ""
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 256
 StAR MF ENHANCED XSIP CANCELLATION API STRUCTURE

API Structure Details

The Post URL for XSIP Cancellation

URL https://bsestarmfdemo.bseindia.com/StarMFAPI/api/XSIP/XSIPCancellation

Request Field Parameters: (Field Details)

Parameter Name Type Length Description Sample values Mandatory

Login ID Varchar 20 mandatory
MemberId varchar 20 BSE member code mandatory
Password varchar mandatory
Client Code varchar 10 mandatory
Registration number bigint mandatory
Internal reference number Varchar 20 non - mandatory

Response Field Parameters: (Field Details)

Parameter Name Type Length Description Sample values

XSIP REG_ID bigint
Bse remarks varchar 1000 Bse Response Return
remarks
Success flag varchar 1 Order success flag 0 - Success & 1 - failure
Internal reference number varchar 20

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 257
 StAR MF Enhanced XSIP Cancellation Structure API JSON Request & Response

XSIP Cancellation Structure

Request (JSON Format)

{
"LoginId" : "1234501",
"MemberCode" : "12345",
"Password" : "123456",
"ClientCode" : "client",
"RegnNo" : "451677",
"IntRefNo" : "1234"
}

Response (JSON Format)

{
"XSIPRegId": "451677",
"BSERemarks": "X-SIP OR I-SIP WITH REGN NO 451677 IS CANCELLED SUCCESSFULLY",
"SuccessFlag": "0",
"IntRefNo": "1234"
}

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 258
 Configuring Postman for Testing API

Create a New POST Request in Postman

Enter the URL in the Postman Request URL

https://bsestarmfdemo.bseindia.com/StarMFAPI/api/SIP/SIPRegistration

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 259
 Add the API Key for Authorization

This can be done in two ways in Postman, please select one

1) Adding key in Authorization Tab

Under Authorization Tab select Type as API KEY, KEY as APIKey, Value as
VmxST1UyRkhUbkpOVldNOQ== and select Add to Header

This will create a Autogenerated Key Value Pair under the Headers Tab

2)Adding the API Key manually in Headers

Under Headers Tab Enter KEY as APIKey, Value as VmxST1UyRkhUbkpOVldNOQ==

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 260
 Adding the JSON parameters in the Body
Under the Body Tab select raw and JSON

And then copy paste the json request parameters in the body.

And Click on send to send the request.

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 261
 REVISION HISTORY

Sr.No. Date Description

1 Nov 4 2015 Base Version
2 Apr 7 2016 Revision 1.0
3 July 29 2016 Revision 1.1
4 Oct 10 2016 Revision 1.2
5 Nov 19 2016 Revision 1.3
6 Jan 01 2017 Revision 1.4
7 Feb 10 2017 Revision 1.5
8 Aug 20 2017 Revision 1.6
9 Nov 11 2017 Revision 1.7
10 Jan 18,2018 Revision 1.8
11 Apr 23,2018 Revision 1.9
12 Jun 13,2018 Revision 2.0
13 Oct 8, 2018 Revision 2.1
14 Mar 15, 2022 Revision 3.0
15 May 31, 2022 Revision 3.1
16 Aug 01, 2023 Revision 3.5

Revision 3.5

1. Additional API Webservice Structures –

1) MUTUAL FUND REDEMPTION TWO FACTOR AUTHENTICATION API WEB SERVICE MESSAGE
STRUCTURE
2) MUTUAL FUND SUBSCRIPTION TWO FACTOR AUTHENTICATION API WEB SERVICE MESSAGE
STRUCTURE
3) MUTUAL FUND COMBINED UCC -NOMINATION API WEB SERVICE MESSAGE STRUCTURE
4) MUTUAL FUND COMBINED UCC -NOMINATION API WEB SERVICE MESSAGE STRUCTURE
5) MUTUAL FUND ENHANCED SIP & XSIP REGISTRATION API WEBSERVICE

2. Additional of –

1)Order Entry API Webservices Sample Format for –

SIP Registration, XSIP Registration, Spread Order Entry, Switch Order Entry
2)AOF Image Upload Webservice Sample Format
3)SCAN Mandate Image Upload Sample Format

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 262
 Revision 3.1

Format changed for -

1. LUMPSUM PURCHASE & REDEMPTION Order Entry Request

Additional Fields added for Request

1) Mobile No
2) Email ID
3) Mandate ID
4) Filler 1 to 6

2. SIP MESSAGE STRUCTURE

Additional Fields added for SIP Request

1) Filler 1 to 6
2) Internal Reference No / PG reference no. change to varchar (25)

Additional Fields added for SIP Response

1) First Order Today Order No.
2) Internal Reference No / PG reference no. change to varchar (25)

3. XSIP/ISIP REQUEST MESSAGE STRUCTURE

Additional Fields added for XSIP/ISIP Request

1) Param 3(END DATE)
2) Filler 1 to 6
3) Internal Reference No / PG reference no. change to varchar (25)

Additional Fields added for XSIP/ISIP Response

1) First Order Today Order No.
2) Internal Reference No / PG reference no. change to varchar (25)

4. SPREAD ORDER REQUEST MESSAGE STRUCTURE

Additional Fields added for SPREAD Request

1) Mobile No
2) Email ID
3) Mandate ID
4) Filler 1 to 6

5.SWITCH ORDER REQUEST MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 263
 Additional Fields added for Switch Request
1) Param 2 (Mobile No)
2) Param3(Email ID)
3) Mandate ID
4) Filler 1 to 6

Additional Fields added for Switch Response

1) SI Order ID for ‘SWITCH IN’ Order No.

6. ADDITIONAL WEB SERVICES MESSAGE STRUCTURE – STP REGISTRATION

Additional Fields added for STP Request

1) Mobile No
2) Email ID

7. ADDITIONAL WEB SERVICES MESSAGE STRUCTURE – 2)SWP REGISTRATION

Additional Fields added for SWP Request

1) Mobile No
2) Email ID
3) Bank Account No.

8. ENHANCED STP REGISTRATION API STRUCTURE

Additional Fields added for Enhanced STP Request

1) Filler1(Mobile No)
2) Filler2( Email ID)

Revision 3.0

Fields added for Normal and Spread Orders

1. PG reference No
2. Bank Account No

Formats Changed for

SCAN MANDATE Image Upload
1. Scan Mandate image Name changed to mandateid
2. Utility Code Changed
3. Agency Code Changed
4. Sponsor Code Changed

Additional Formats introduced for

1. ENACH AUTHENTICATION API

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 264
 2. AXIS BANK CHEQUE COLLECTION
3. SIP TO XSIP
4. XSIP MANDATE SHIFT
5. AXIS BANK CHEQUE API
6. NRI CHILD CHEQUE UPLOAD
7. SINGLE PAYMENT API
8. ENHANCED STP including AMC STP

Removed APIs for

1. UCC
2. Provisional Order API
3. SMS/ SIP Authentication API
4. Order Rejection

Revision 2.1

Formats Changed for

SCAN MANDATE Image Upload

5. Scan Mandate image Name changed to mandateid
6. Utility Code Added
7. Sponsor Code added

Revision 2.0

Additional Formats introduced for

9. PROVISIONAL ORDER REPORT

10. ORDER STATUS REPORT
11. ALLOTMENT STATEMENT REPORT
12. REDEMPTION STATEMENT REPORT
13. e- Mandate Authentication URL Generation
14. ORDER REJECTION

Revision 1.9

Additional Formats introduced for

15. STP CANCELLATION

16. SWP CANCELLATION
17. SCAN MANDATE IMAGE UPLOAD

Formats Changed for

1. MANDATE STATUS

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 265
 Revision 1.8

Formats Changed for

1. MANDATE REGISTRATION (Option for e-mandate, Mandate Type “E”)

Revision 1.7

Formats Changed for

2. SIP Message Structure Request (END DATE Added )

Additional Formats introduced for

1. Mandate Status API added

2. Systematic Plan Authentication (Registration/ Cancellation) API added

Revision 1.6

Formats Changed for

3. Mandate (Single Mandate Registration Upload for MFI & MFD and XSIP/ISIP)

Additional Formats introduced for

1. Direct Payment Gateway Web Service

2. Child Order Web Service
3. Image Upload Web Service

Revision 1.5

Additional Formats introduced for

4. CKYC UPLOAD

Revision 1.4

Additional Formats introduced for

5. CLIENT REDEMPTION SMS AUTHENTICATION

Revision 1.3

Additional Formats introduced for

1. CLIENT ORDER PAYMENT STATUS

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 266
 Revision 1.2

Additional Formats introduced for

18. MANDATE ID CREATION

19. STP REGISTRATION
20. SWP REGISTRATION
21. UCC – MFI
22. ISIP

Formats Changed for

1. Web Service Order Entry Request

Sub Broker ARN Added in Filler 1, Field Size changed from 10 to 20
Method Name remains as Param1. This is non- Mandatory

2. Web Service SIP Entry Request

Sub Broker ARN Added in Filler 1, Field Size changed from 10 to 20
Method Name remains as Param1. This is non- Mandatory

3. Web Service XSIP/ISP Entry Request

MANDATE ID changed to XSIP Mandate ID, Either XSIP mandate ID or ISIP Mandate ID is required
Method Name remains as XsipRegID. This is Mandatory only if ISIP Mandate is not Provided.

Sub Broker ARN Added in Filler 1, Field Size changed from 10 to 20

Method Name remains as Param1. This is non- Mandatory

ISIP MANDATE ID Added in Filler 2, Field Size changed from 10 to 15, Either XSIP mandate ID or
ISIP Mandate ID is required
Method Name remains as Param2. This is Mandatory only if XSIP Mandate ID is not Provided.

4. Web Service SPREAD Entry Request

Sub Broker ARN Added in Filler 1, Field Size changed from 10 to 20
Method Name remains as Param1. This is non- Mandatory

5. Web Service SWITCH Entry Request

Sub Broker ARN Added in Filler 1, Field Size changed from 10 to 20
Method Name remains as Param1. This is non- Mandatory

Revision 1.1

Additional Formats introduced for

1. MUTUAL FUND ADDITIONAL SERVICES

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 267
 PAGE – INTENTIONALLY LEFT BLANK

MF – WEB SERVICES STRUCTURE VERSION 3.5 – AUG 2023 PAGE NO. 268