BSE StAR MF – WEBSERVICE STRUCTURE

Version 3.1
May 2022

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 0

 Table of Contents

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

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 1

 LUMPSUM PURCHASE & REDEMPTION Order Entry Web Service Request ................................................20
WSDL Definition for Request ...................................................................................................................23
Web Service Order Entry Request Response ...............................................................................................24
WSDL Definition for Response .................................................................................................................24
Sample SOAP Request for Purchase ........................................................................................................25
Sample SOAP Response for Purchase ......................................................................................................26
Sample SOAP Request for Redemption ...................................................................................................27
Sample SOAP Response for Redemption .................................................................................................28
SIP MESSAGE STRUCTURE ................................................................................................................................29
Web Service SIP Request .............................................................................................................................29
Web Service SIP Request Response .............................................................................................................31
XSIP/ISIP REQUEST MESSAGE STRUCTURE ......................................................................................................32
Web Service XSIP/ISIP Request ....................................................................................................................32
Web Service XSIP/ISIP Request Response ...................................................................................................34
SPREAD ORDER REQUEST MESSAGE STRUCTURE (Overnight) ........................................................................35
Web Service SPREAD Order Request (Overnight) ........................................................................................35
Web Service SPREAD Order Request Response (Overnight) .......................................................................38
SWITCH ORDER REQUEST MESSAGE STRUCTURE ...........................................................................................39
Web Service SWITCH Order Request ...........................................................................................................39
Web Service SWITCH Order Request Response...........................................................................................41
MUTUAL FUND ADDITIONAL SERVICES AUTHENTICATION MESSAGE STRUCTURE ........................................43
MUTUAL FUND Additional Services Login Request .....................................................................................44
MUTUAL FUND Additional Services Login Request Response .....................................................................44
Notes ........................................................................................................................................................44
MUTUAL FUND ADDITIONAL SERVICES MESSAGE STRUCTURE.......................................................................45
MUTUAL FUND Additional Services Request ...............................................................................................45
Notes ........................................................................................................................................................45
Values for Param in MUTUAL FUND Additional Services Request...........................................................46
FATCA UPLOAD STRUCTURE ....................................................................................................................47
Country Nationality ..................................................................................................................................53
Source of Wealth .....................................................................................................................................60
Tax Status .................................................................................................................................................60

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 2

 Occupation ...............................................................................................................................................62
Applicant Income .....................................................................................................................................62
UBO Code .................................................................................................................................................62
Identification Type ...................................................................................................................................63
State Code ................................................................................................................................................63
Exemption Code .......................................................................................................................................64
GIIN Exempt .............................................................................................................................................65
Active NFE Sub Category ..........................................................................................................................66
Mandatory Fields for Individual:-.............................................................................................................68
Mandatory Fields for Non-Individuals:- ...................................................................................................68
****************------------------- END OF FATCA STRUCTURE------------------***************** ......69
Payment Gateway Values ........................................................................................................................70
CHANGE PASSWORD ................................................................................................................................70
UCC/CLIENT CREATION– MFI ...................................................................................................................70
MANDATE REGISTRATION........................................................................................................................70
STP REGISTRATION (Depreciated – Legacy Use only use the Enhanced STP API) ...................................71
SWP REGISTRATION .................................................................................................................................71
STP CANCELLATION ( Depreciated Legacy use Only) ...............................................................................72
SWP CANCELLATION ................................................................................................................................72
CLIENT ORDER PAYMENT STATUS............................................................................................................72
CKYC UPLOAD...........................................................................................................................................73
SYSTEMATIC PLAN AUTHENTICATION (Registration/ Cancellation) (Depreciated) ................................73
ORDER REJECTION (Depreciated) ............................................................................................................73
MUTUAL FUND Additional Services Request Response ..............................................................................74
MANDATE REGISTRATION RESPONSE ......................................................................................................74
CLIENT ORDER PAYMENT RESPONSE STATUS ..........................................................................................74
StAR MF Enhanced UCC Registration Structure API for MFI & MFD Members ...............................................77
StAR MF Enhanced UCC Registration Structure API for MFI & MFD Members ...............................................77
API Structure Details ....................................................................................................................................77
Request Parameter : (JSON Format) .......................................................................................................77
Response Parameter : (JSON Format) .....................................................................................................77
MUTUAL FUND NEW ENHANCED UCC REGISTRATION WEBSERIVCE STRUCTURE ..........................................78

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 3

 https://bsestarmfdemo.bseindia.com/StarMFCommonAPI/ClientMaster/Registration ................................78
New Client Registration ...............................................................................................................................78
Request Parameter (JSON Format) ..........................................................................................................78
Response Parameter (JSON Format)........................................................................................................78
New Client Modification/ Old Client UCC Upgrade .....................................................................................79
Request Parameter (JSON Format) ..........................................................................................................79
Response Parameter (JSON Format)........................................................................................................79
MFI & MFD New Common Client Registration Parameter Structure ..............................................................80
NEW CLIENT Parameter Validations ................................................................................................................94
ACCOUNT TYPE ............................................................................................................................................94
CLIENT HOLDING ..........................................................................................................................................94
DIVIDEND PAYMODE....................................................................................................................................94
COMMUNICATION MODE ............................................................................................................................94
TAX STATUS WITH ACCOUNT TYPE ..............................................................................................................95
TAX STATUS ..................................................................................................................................................97
OCCUPATION CODE .....................................................................................................................................99
PAN EXEMPT CATEGORY ..............................................................................................................................99
COUNTRY CODE .........................................................................................................................................100
STATES........................................................................................................................................................107
MUTUAL FUND StAR MF ENHANCED STP REGISTRATION API MESSAGE STRUCTURE ..................................110
Introduction ...............................................................................................................................................110
StAR MF Enhanced STP Registration API Structure ..................................................................................111
Request Field Parameters: (Field Details) ..............................................................................................111
Response Field Parameters : (Field Details) ...........................................................................................112
StAR MF EXCHANGE & STP Registration and Cancellation API JSON Request & Response ......................113
NEW EXCHANGE STP REGISTRATION .........................................................................................................113
Request (JSON Format) ..........................................................................................................................113
Response (JSON Format) ........................................................................................................................114
NEW EXCHANGE STP CANCELLATION ........................................................................................................115
Request (JSON Format) ..........................................................................................................................115
Response (JSON Format) ........................................................................................................................116
NEW AMC STP REGISTRATION ...................................................................................................................117

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 4

 Request (JSON Format) ..........................................................................................................................117
Response (JSON Format) ........................................................................................................................118
NEW AMC STP CANCELLATION ..................................................................................................................119
Request (JSON Format) ..........................................................................................................................119
Response (JSON Format) ........................................................................................................................120
MUTUAL FUND AOF IMAGE UPLOAD WEB SERVICES MESSAGE STRUCTURE ...............................................122
MUTUAL FUND AOF Image Upload Services Login Request ......................................................................122
MUTUAL FUND AOF Image Upload Login Request Response ...................................................................123
Notes ......................................................................................................................................................123
MUTUAL FUND Image Upload Notice/ Naming Convention .....................................................................125
Notice Details .........................................................................................................................................125
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD WEB SERVICES MESSAGE STRUCTURE ...........................127
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request ...............................................127
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request Response ..............................127
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request/Response Sample .................128
Request Parameter: (JSON Format) ......................................................................................................128
Response (JSON Format) ........................................................................................................................128
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD SERVICES WEB SERVICES MESSAGE STRUCTURE ...........129
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request ........................................................129
Values for Utility Code & Sponsor Bank Code .......................................................................................129
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request Response ........................................129
MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Service Request/Response Sample ..............130
Request Parameter: (JSON Format) ......................................................................................................130
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 ...........................................................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 Response Response ..................................135

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 5

 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
MUTUAL FUND Child Order Login Request Response ...............................................................................140
Notes ......................................................................................................................................................140
MUTUAL FUND MANDATE STATUS WEB SERVICES AUTHENTICATION MESSAGE STRUCTURE ....................143
MUTUAL FUND Mandate Status Services Login Request ..........................................................................143
MUTUAL FUND Mandate Status Login Request Response ........................................................................143
MUTUAL FUND Mandate Status Login Request/Response Sample ..........................................................144
Request Parameter: (JSON Format) ......................................................................................................144
Response (JSON Format) ........................................................................................................................144
MUTUAL FUND MANDATE STATUS WEB SERVICES MESSAGE STRUCTURE ..................................................145
MUTUAL FUND Mandate Status Services Request ....................................................................................145
MUTUAL FUND Mandate Status Services Request Response ...................................................................145
Status Table............................................................................................................................................146
MUTUAL FUND Mandate Status Service Request/Response Sample........................................................147
Request Parameter: (JSON Format) ......................................................................................................147
Response (JSON Format) ........................................................................................................................147
MUTUAL FUND Mandate Status Service Request/Response Error Codes.................................................148
- MUTUAL FUND PROVISIONAL ORDER MESSAGE STRUCTURE ....................................................................150
This API has been DEPRECIATED and is no longer Available -..................................................................150
MUTUAL FUND ORDER STATUS REPORT MESSAGE STRUCTURE ..................................................................150
MUTUAL FUND Order Status Services Request .........................................................................................150
Request parameters...............................................................................................................................150
MUTUAL FUND Order Status Request Response .......................................................................................151
Parameters .............................................................................................................................................151
ERROR CODES.........................................................................................................................................153
MUTUAL FUND ALLOTMENT STATEMENT MESSAGE STRUCTURE ................................................................154

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 6

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 7

 Member Cheque Collection Deposit Challan Creation Entry – API (PDF File Download) ..........................172
Request Parameter ................................................................................................................................172
Response Parameter ..............................................................................................................................173
Sample Code ..............................................................................................................................................173
Member Cheque Collection Deposit Challan Generation Entry – Website ...............................................174
Member Cheque Collection Deposit Challan Generation Entry – API .......................................................174
Request Parameter ................................................................................................................................174
Response Parameter ..............................................................................................................................174
Sample Code ..............................................................................................................................................175
SINGLE INTEGRATED PAYMENT WEBSERVICE MESSAGE STRUCTURE THROUGH API FOR ALL PAYMENT
METHODS .......................................................................................................................................................177
Structure for Single Payment API Interface ...............................................................................................177
Request Parameter ................................................................................................................................177
Response ................................................................................................................................................178
Sample Code ..............................................................................................................................................179
Request : ................................................................................................................................................179
Response : ..............................................................................................................................................179
NET BANKING BANK CODES ...........................................................................................................................180
UPI BANK CODES ............................................................................................................................................183
MUTUAL FUND CHEQUE IMAGE UPLOAD API WEB SERVICE MESSAGE STRUCTURE FOR NRI MINOR .........187
Method 1 : ImageUploadBase64 ...............................................................................................................187
Request Parameter : (JSON Format) .....................................................................................................187
Response Parameter : (JSON Format) ...................................................................................................187
Method 2 : ImageUploadByte ....................................................................................................................188
Request Parameter : (JSON Format) .....................................................................................................188
Response Parameter : (JSON Format) ...................................................................................................188
API Methods Name : ..............................................................................................................................189
Request Parameter : (JSON Format) .....................................................................................................189
Response (JSON Format)........................................................................................................................189
Request Parameter : (JSON Format) .....................................................................................................190
Response Parameter : (JSON Format) ....................................................................................................190
MUTUAL FUND SIP XSIP PAUSE API WEB SERVICE MESSAGE STRUCTURE....................................................192

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 8

 Request Parameter : (JSON Format) .....................................................................................................192
Response Parameter : (JSON Format) ...................................................................................................192
Pause SIP/ XSIP API JSON Request & Response Example ..........................................................................193
Request (JSON Format) ..........................................................................................................................193
MUTUAL FUND SIP TO XSIP SHIFT API WEB SERVICE MESSAGE STRUCTURE ................................................195
REQUEST STRUCTURE ....................................................................................................................................195
RESPONSE STRUCTURE ..................................................................................................................................195
SAMPLE CODE ............................................................................................................................................196
Request Details : (JSON) .........................................................................................................................196
Additional Resources .....................................................................................................................................197
STANDARD ERROR CODES..............................................................................................................................198
GET PASSWORD .........................................................................................................................................198
MFAPI .........................................................................................................................................................199
REVISION HISTORY .........................................................................................................................................200
Revision 3.1 ................................................................................................................................................200
Format changed for ...............................................................................................................................200
Revision 3.0 ................................................................................................................................................202
Revision 2.1 ................................................................................................................................................202
Revision 2.0 ................................................................................................................................................203
Revision 1.9 ................................................................................................................................................203
Revision 1.8 ................................................................................................................................................203
Revision 1.7 ................................................................................................................................................203
Revision 1.6 ................................................................................................................................................204
Revision 1.5 ................................................................................................................................................204
Revision 1.4 ................................................................................................................................................204
Revision 1.3 ................................................................................................................................................204
Revision 1.2 ................................................................................................................................................204
Revision 1.1 ................................................................................................................................................205

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 9

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 10
 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.1 – MAY 2022 PAGE NO. 11

 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.1 – MAY 2022 PAGE NO. 12

 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 an 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.1 – MAY 2022 PAGE NO. 13

 MUTUAL FUND ORDER ENTRY REQUEST
AND RESPONSE SERVICES MESSAGE
STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 14

 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.1 – MAY 2022 PAGE NO. 15

 MF 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.1 – MAY 2022 PAGE NO. 16

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

Parameter
Type Length Description Sample Values Mandatory
Name
User ID Varchar 5 Login ID for Web Service 0123 Mandatory
Password Varchar 20 Password for the Login ID mf@abc Mandatory
Random Alphanumeric
Pass Key Varchar 10 value entered by member abcdef1234 Mandatory
used for 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>

Web Service Authentication Request Response

The Method used for order Entry is getPasswordResponse

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 17

 Response Type Length description/values sample values
100-Success
Response Code Varchar 3 Request Response / 101 Invalid
Encrypted Encrypted
Password Varchar 250 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/yLAS7KmiHyExtsKKq3DuHTWuyGGYnAOwLKjOzy0P4s38PSL8nA==</getPasswordRes
ult>
</getPasswordResponse>
</s:Body>
</s:Envelope>

Response Code |Encrypted Password (Session ID)

100|UWQ/yLAS7KmiHyExtsKKq3DuHTWuyGGYnAOwLKjOzy0P4s38PSL8nA==

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 18

 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.1 – MAY 2022 PAGE NO. 19

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 20

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 21

 IPAdd varchar 20
Password varchar 250 Encrypted password Mandatory
Pass Key varchar 10 Mandatory
Param1 (Sub varchar 20 Filler 1 Will Be Used As Non-
Broker ARN) Sub Broker ARN Code Mandatory
Param2 (PG varchar 25 Non-
Purchase Only, Used for
Reference Mandatory
Funds Mapping
No)
varchar 20 Redemption Only, to Mandatory
Param3
choose the account in For
(Bank
which the Funds are Redemption
Account No)
redeemed to.
varchar 10 10 Digit Indian Mobile No Non-
Mobile No
used for verification Mandatory
varchar 50 Email ID of the Client Non-
Email ID
used for verification Mandatory
varchar 10 Only for Purchase, for Non-
Mandate ID
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.1 – MAY 2022 PAGE NO. 22

 WSDL Definition for Request

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 23

 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.1 – MAY 2022 PAGE NO. 24

 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>2022021810234000002</bses:TransNo>
<bses:OrderId/>
<bses:UserID>{{loginid}}</bses:UserID>
<bses:MemberId>{{membercode}}</bses:MemberId>
<bses:ClientCode>{{clientcode}}</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>{{encrypted password}}</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>

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 25

 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|2022021810234000003|7531973|loginid|membercode|clientcode|ORD CONF:
Your Request for FRESH PURCHASE 500.000 in SCHEME: 02-DP THRO : PHYSICAL is confirmed for CLIENT :
clientname (Code: clientcode) 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.1 – MAY 2022 PAGE NO. 26

 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>{{loginid}}</bses:UserID>
<bses:MemberId>{{membercode}}</bses:MemberId>
<bses:ClientCode>{{clientcode}}</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>500</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>{{encrypted password}}</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>

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 27

 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|2022052610996000004|7532017| loginid | membercode|ucc01|ORD CONF:
Your Request for FRESH REDEMPTION 100.000 UNITS in SCHEME: 02-DP THRO : PHYSICAL is confirmed for
CLIENT : clientname (Code: clientcode) 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.1 – MAY 2022 PAGE NO. 28

 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.1 – MAY 2022 PAGE NO. 29

 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 varchar 10
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.1 – MAY 2022 PAGE NO. 30

 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.1 – MAY 2022 PAGE NO. 31

 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.1 – MAY 2022 PAGE NO. 32

 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
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.1 – MAY 2022 PAGE NO. 33

 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.
IPAdd varchar 20
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.1 – MAY 2022 PAGE NO. 34

 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
Cancellation of Spread
Transaction code Varchar 3 Order NEW mandatory

Unique reference
number from the
member. Number can
be incremental for
each order(000001,
000002,….). The
Unique 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
number has to be
Orderid Bigint 8 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
Purchase amount Money 14 Purchase amount

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 35

 Redemption
amount Money 14 Redemption amount
All units flag, If this
Flag is"Y" then units
and amount column
All units flag Varchar 1 should 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 decleration 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 Reference No Purchase Only, Used non-

(Param 2) Varchar 25 for Funds Mapping mandatory
Redemption Only, to
choose the account in
Bank Account No which the Funds are
(Param3) Varchar 20 redeemed to. Mandatory

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 36

 10 Digit Indian Mobile
Non-
Mobile No varchar 10 No used for
mandatory
verification
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.1 – MAY 2022 PAGE NO. 37

 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
Success flag Varchar 1 remarks
Order
BSE remarks Varchar 1000 success flag

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 38

 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.1 – MAY 2022 PAGE NO. 39

 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.1 – MAY 2022 PAGE NO. 40

 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
given in the
Transaction code varchar 3 request NEW/CXL

Unique reference
Unique reference number as given
number varchar 19 in the request YYYYMMDD<usercode>000001
In this exchange
will send the
unique order
number assigned
to the transaction
(SO). And in case SO – SWITCH OUT Order No.
of modification or
cancellation BSE
unique order
number has to be
Order ID bigint 8 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
In this exchange
will send the
unique order
SI Order ID bigint 8 SI – SWITCH IN Order No.
number assigned
to the transaction
(SI).

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 41

 MUTUAL FUND ADDITIONAL SERVICES
MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 42

 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 (depreciated) /SWP Registration via Webservices
7.) Client Payment Status via Webservices
8.) CKYC via Webservices
9.) Mandate Status via Webservices
10.) Client SMS Authentication via Webservices Depreciated
11.) 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.1 – MAY 2022 PAGE NO. 43

 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.1 – MAY 2022 PAGE NO. 44

 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.1 – MAY 2022 PAGE NO. 45

 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 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.1 – MAY 2022 PAGE NO. 46

 FATCA UPLOAD STRUCTURE

M/O
FIELD
SR NO Field Type M- Mandatory Description
DESCRIPTION
O- Optional
M PAN of the Reporting
Person - Investor / Guardian
1 PAN_RP Varchar(10) - Mandatory
M [If PAN PAN Exempt KYC Ref No. of
column in Null] the Investor/Guardian -
Mandatory if PAN is not
provided
2 PEKRN Varchar(10)
M Name of the Investor /
3 INV_NAME Varchar(70) Guardian - Mandatory
M [if PAN is not Date of Birth
4 DOB Date provided]
M [if PAN is not
5 FR_NAME Varchar(70) provided]
M [if PAN is not
6 SP_NAME Varchar(70) provided]
M Tax Status of the investor -
Refer Tax Status Master
7 TAX_STATUS Varchar(3)
M This is to indicated data
sources whether it is
obtained Electronically or
through physical request;
Values - 'E' / 'P'
8 DATA_SRC Varchar(3)
M 1 - Residential or Business;
2 - Residential; 3 - Business;
4 - Registered Office; 5 -
Unspecified

9 ADDR_TYPE Varchar(1)
M Applicable to
Individuals/Non Individuals
10 PO_BIR_INC Varchar(60)
M Refer Country/Nationality
master enclosed and
provide values accordingly

11 CO_BIR_INC Varchar(50)

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 47

 M Refer Country/Nationality
master enclosed and
provide values accordingly

12 TAX_RES1 Varchar(50)
M Tax Payer Identification
Number / other Equivalent
13 TPIN1 Varchar(20) Number
M Type of Identification
document to be provided -
Refer Identification Type
master
14 ID1_TYPE Varchar(1)
M Refer Country/Nationality
master enclosed and
provide values accordingly

15 TAX_RES2 Varchar(50)
M Tax Payer Identification
Number / other Equivalent
16 TPIN2 Varchar(20) Number
M Type of Identification
document to be provided -
Refer Identification Type
master
17 ID2_TYPE Varchar(1)
M Refer Country/Nationality
master enclosed and
provide values accordingly

18 TAX_RES3 Varchar(50)
M Tax Payer Identification
Number / other Equivalent
19 TPIN3 Varchar(20) Number
M Type of Identification
document to be provided -
Refer Identification Type
master
20 ID3_TYPE Varchar(1)
M Refer Country/Nationality
master enclosed and
provide values accordingly

21 TAX_RES4 Varchar(50)
M Tax Payer Identification
Number / other Equivalent
22 TPIN4 Varchar(20) Number

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 48

 M Type of Identification
document to be provided -
Refer Identification Type
master
23 ID4_TYPE Varchar(1)
M Refer Source of wealth
Sheet for values to be
24 SRCE_WEALT Varchar(3) populated
M for Non- 01 - Foreign Exchange /
Individuals Money Changer Services
02 - Gaming / Gambling /
Lottery Services [e.g.
casinos, betting syndicates]
03 - Money laundering /
Pawning
04 – to be blank if the same
is not applicable

25 CORP_SERVS Varchar(2)
M App_Income_code as
indicated in the app_income
master to be provided
26 INC_SLAB Varchar(5)
M for Non- Provide the net worth of the
Individuals investor only if the same is
Numeric Corporate Category [INR. In
27 NET_WORTH (19,2) Lacs]
M for Non- Provide the net worth of the
28 NW_DATE Date Individuals investor
M for Values to be 'Y' if the
Individuals investor is politically
exposed person; 'N' if the
investor is not; 'R' if the
investor is a relative of the
politically exposed person
29 PEP_FLAG Varchar(2)
M Values to be provided as per
the Occupation Master
30 OCC_CODE Varchar(2) enclosed
M S - Service; B - Business, O
- Others; X - Not
31 OCC_TYPE Varchar(1) Categorized
M for Non- Provide the values as
Individuals specified under 'Exemption
32 EXEMP_CODE Varchar(2) Code' sheet
M for Non- Values - FFI, DRNFE, NA
33 FFI_DRNFE Varchar(20) Individuals
M for Non- Applicable to FFI, DRNFE,
34 GIIN_NO Varchar(19) Individuals NA

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 49

 O Name of the Sponsoring
Entity if GIIN_NO of
Sponsoring Entity is given
35 SPR_ENTITY Varchar(60)
O Value to be provided: AF -
Applied for; NR - Not
required to apply for; NO -
Not obtained - Non-
participating FI
36 GIIN_NA Varchar(3)
O Refer GIIN_EXEMPT sheet
and applicable codes to be
37 GIIN_EXEMC Varchar(2) populated
O L - Listed entity; RL -
Related to listed entity; A-
Active NFFE, P - Passive
NFFE, NA - Not Applicable -
for Non NFFE
38 NFFE_CATG Varchar(3)
O Refer sheet
'ACTIVE_NFE_SUB_CATG'
and populate suitable values
39 ACT_NFE_SC Varchar(3)
M if Applicable for Active NFE &
NFFE_CATG Passive NFE
40 NATURE_BUS Varchar(30) is 'A' or 'P'
O Name of the Listed
Company where Entity is its
associate / related company
41 REL_LISTED Varchar(70)
M B - BSE, N - NSE, O - Others
42 EXCH_NAME Varchar(2)
M Values should be 'Y' / 'N'.
Default - 'Y' for Entities for
other than Listed Company /
Group / Associate Company
of the Listed Company /
Company controlled by
Listed Company

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

44 UBO_COUNT Varchar(3)

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 50

 M [if Name of the UBO
UBO_APPL is
45 UBO_NAME Varchar(70) 'Y'
M / O [if PAN of UBO to be provided
UBO_TIN is
not provided,
this field is
mandatory
46 UBO_PAN Varchar(10)
M [if Refer Country/Nationality
UBO_APPL is master enclosed and
'Y' provide values accordingly

47 UBO_NATION Varchar(3)
M [if
UBO_APPL is
48 UBO_ADD1 Varchar(50) 'Y'
M [if
UBO_APPL is
49 UBO_ADD2 Varchar(50) 'Y'
M [if
UBO_APPL is
50 UBO_ADD3 Varchar(50) 'Y'
M [if
UBO_APPL is
51 UBO_CITY Varchar(50) 'Y'
M [if
UBO_APPL is
52 UBO_PIN Varchar(6) 'Y'
M [if State Code to be provided
UBO_APPL is as per the existing practice
53 UBO_STATE Varchar(3) 'Y'
M [if Refer Country/Nationality
UBO_APPL is master enclosed and
'Y' provide values accordingly

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

55 UBO_ADD_TY Varchar(2)
M [if UBO's Country of Tax
UBO_APPL is Residency - Refer
'Y' Country/Nationality master
enclosed and provide values
accordingly
56 UBO_CTR Varchar(4)

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 51

 M / O [if UBO's Tax Payer
UBO_PAN is Identification Number or any
not provided, other relevant reference
this field is number
mandatory]
57 UBO_TIN Varchar(20)
M / O [if Refer Identification type
UBO_APPL is master given
58 UBO_ID_TY Varchar(2) 'Y'
M [if UBO Country of Birth
UBO_APPL is
59 UBO_COB Varchar(30) 'Y'
60 UBO_DOB Date O UBO Date of Birth
O Value to be provided as 'M'
61 UBO_GENDER Varchar(1) or 'F' or 'O'
O UBO Father's name to be
62 UBO_FR_NAM Varchar(50) provided
63 UBO_OCC Varchar(2) O As per Occupation List
O S - Service; B - Business, O
- Others; X - Not
Categorized - Refer
Applicable Occupation Type
for the relevant Occupation
Codes under 'Occupation'
sheet

64 UBO_OCC_TY Varchar(2)
65 UBO_TEL Varchar(12) O UBO Telephone Number
66 UBO_MOBILE Varchar(12) O UBO Mobile Number
M Code as per master given in
UBO_CODE sheet
67 UBO_CODE Varchar(3)
O Should not be greater than
100 and less than 0
68 UBO_HOL_PC Varchar(3)
M/O This flag is to indicate
whether Values - 'Y', 'N' -
Default 'Y' for Entities;
69 SDF_FLAG Varchar(2) Optional for Individuals,
M Values - 'Y', 'N' - Default 'Y'
for Entities and 'N' for
70 UBO_DF Varchar(2) Individuals
O Aadhaar of the Reporting
Person shall be provided
71 AADHAAR_RP Varchar(30)

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 52

 M/O 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 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

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

Country Nationality

S
Country Code Country
No
1 AD Andorra
2 AE United Arab Emirates
3 AF Afghanistan
4 AG Antigua And Barbuda
5 AI Anguilla
6 AL Albania
7 AM Armenia

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 53

 8 AN Netherlands Antilles
9 AO Angola
10 AQ Antarctica
11 AR Argentina
12 AS American Samoa
13 AT Austria
14 AU Australia
15 AW Aruba
16 AX Aland Islands
17 AZ Azerbaijan
18 BA Bosnia And Herzegovina
19 BB Barbados
20 BD Bangladesh
21 BE Belgium
22 BF Burkina Faso
23 BG Bulgaria
24 BH Bahrain
25 BI Burundi
26 BJ Benin
27 BL Saint Barthelemy
28 BM Bermuda
29 BN Brunei Darussalam
30 BO Bolivia
31 BQ Bonaire, Sint Eustatius And Saba
32 BR Brazil
33 BS Bahamas
34 BT Bhutan
35 BV Bouvet Island
36 BW Botswana
37 BY Belarus
38 BZ Belize
39 CA Canada
40 CC Cocos (Keeling) Islands
Congo, The Democratic Republic Of
41 CD
The
42 CF Central African Republic
43 CG Congo
44 CH Switzerland
45 CI Côte D'ivoire
46 CK Cook Islands
47 CL Chile
48 CM Cameroon

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 54

 49 CN China
50 CO Colombia
51 CR Costa Rica
52 CU Cuba
53 CV Cape Verde
54 CW Curacao
55 CX Christmas Island
56 CY Cyprus
57 CZ Czech Republic
58 DE Germany
59 DJ Djibouti
60 DK Denmark
61 DM Dominica
62 DO Dominican Republic
63 DZ Algeria
64 EC Ecuador
65 EE Estonia
66 EG Egypt
67 EH Western Sahara
68 ER Eritrea
69 ES Spain
70 ET Ethiopia
71 FI Finland
72 FJ Fiji
73 FK Falkland Islands (Malvinas)
74 FM Micronesia, Federated States Of
75 FO Faroe Islands
76 FR France
77 GA Gabon
78 GB United Kingdom
79 GD Grenada
80 GE Georgia
81 GF French Guiana
82 GG Guernsey
83 GH Ghana
84 GI Gibraltar
85 GL Greenland
86 GM Gambia
87 GN Guinea
88 GP Guadeloupe
89 GQ Equatorial Guinea

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 55

 90 GR Greece
South Georgia And The South
91 GS
Sandwich Islands
92 GT Guatemala
93 GU Guam
94 GW Guinea-Bissau
95 GY Guyana
96 HK Hong Kong
97 HM Heard Island And McDonald Islands
98 HN Honduras
99 HR Croatia
100 HT Haiti
101 HU Hungary
102 ID Indonesia
103 IE Ireland
104 IL Israel
105 IM Isle Of Man
106 IN India
107 IO British Indian Ocean Territory
108 IQ Iraq
109 IR Iran, Islamic Republic Of
110 IS Iceland
111 IT Italy
112 JE Jersey
113 JM Jamaica
114 JO Jordan
115 JP Japan
116 KE Kenya
117 KG Kyrgyzstan
118 KH Cambodia
119 KI Kiribati
120 KM Comoros
121 KN Saint Kitts And Nevis
Korea, Democratic People's Republic
122 KP
Of
123 KR Korea, Republic Of
124 KW Kuwait
125 KY Cayman Islands
126 KZ Kazakhstan
127 LA Lao People's Democratic Republic
128 LB Lebanon
129 LC Saint Lucia

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 56

 130 LI Liechtenstein
131 LK Sri Lanka
132 LR Liberia
133 LS Lesotho
134 LT Lithuania
135 LU Luxembourg
136 LV Latvia
137 LY Libyan Arab Jamahiriya
138 MA Morocco
139 MC Monaco
140 MD Moldova, Republic Of
141 ME Montenegro
142 MF Saint Martin
143 MG Madagascar
144 MH Marshall Islands
Macedonia, The Former Yugoslav
145 MK
Republic Of
146 ML Mali
147 MM Myanmar
148 MN Mongolia
149 MO Macao
150 MP Northern Mariana Islands
151 MQ Martinique
152 MR Mauritania
153 MS Montserrat
154 MT Malta
155 MU Mauritius
156 MV Maldives
157 MW Malawi
158 MX Mexico
159 MY Malaysia
160 MZ Mozambique
161 NA Namibia
162 NC New Caledonia
163 NE Niger
164 NF Norfolk Island
165 NG Nigeria
166 NI Nicaragua
167 NL Netherlands
168 NO Norway
169 NP Nepal
170 NR Nauru

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 57

 171 NU Niue
172 NZ New Zealand
173 OM Oman
174 PA Panama
175 PE Peru
176 PF French Polynesia
177 PG Papua New Guinea
178 PH Philippines
179 PK Pakistan
180 PL Poland
181 PM Saint Pierre And Miquelon
182 PN Pitcairn
183 PR Puerto Rico
184 PS Palestinian Territory, Occupied
185 PT Portugal
186 PW Palau
187 PY Paraguay
188 QA Qatar
189 RE Reunion Island
190 RO Romania
191 RS Serbia
192 RU Russian Federation
193 RW Rwanda
194 SA Saudi Arabia
195 SB Solomon Islands
196 SC Seychelles
197 SD Sudan
198 SE Sweden
199 SG Singapore
Saint Helena, Ascension And Tristan
200 SH
da Cunha
201 SI Slovenia
202 SJ Svalbard And Jan Mayen Islands
203 SK Slovakia
204 SL Sierra Leone
205 SM San Marino
206 SN Senegal
207 SO Somalia
208 SR Suriname
209 SS South Sudan
210 ST Sao Tome And Principe
211 SV El Salvador

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 58

 212 SX Sint Maarten (Dutch Part)
213 SY Syrian Arab Republic
214 SZ Swaziland
215 TC Turks And Caicos Islands
216 TD Chad
217 TF French Southern Territories
218 TG Togo
219 TH Thailand
220 TJ Tajikistan
221 TK Tokelau
222 TL Timor-Leste
223 TM Turkmenistan
224 TN Tunisia
225 TO Tonga
226 TR Turkey
227 TT Trinidad And Tobago
228 TV Tuvalu
229 TW Taiwan, Province Of China
230 TZ Tanzania, United Republic Of
231 UA Ukraine
232 UG Uganda
233 UM United States Minor Outlying Islands
234 US United States
235 UY Uruguay
236 UZ Uzbekistan
237 VA Vatican City State
238 VC Saint Vincent And The Grenadines
239 VE Venezuela, Bolivarian Republic Of
240 VG Virgin Islands, British
241 VI Virgin Islands, U.S.
242 VN Viet Nam
243 VU Vanuatu
244 WF Wallis And Futuna
245 WS Samoa
246 XX Not categorised
247 YE Yemen
248 YT Mayotte
249 ZA South Africa
250 ZM Zambia
251 ZW Zimbabwe
252 ZZ Others

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 59

 Source of Wealth

S No Source Source Code

1 Salary 01
Business
2 Income 02
3 Gift 03
Ancestral
4 Property 04
5 Rental Income 05
6 Prize Money 06
7 Royalty 07
8 Others 08

Tax Status

Tax
S No Code Tax Status Category
1 01 Individual R - Retail
2 02 On Behalf Of Minor R - Retail
3 03 HUF R - Retail
4 04 Company C - Corporate
5 05 AOP/BOI C - Corporate
6 06 Partnership Firm C - Corporate
7 07 Body Corporate C - Corporate
8 08 Trust C - Corporate
9 09 Society C - Corporate
10 10 Others C - Corporate
11 11 NRI-Others R - Retail
12 12 Banks / Financial Institutions C - Corporate
13 13 Sole Proprietorship C - Corporate
14 14 Banks C - Corporate
15 15 Association of Persons C - Corporate
16 21 NRI - NRE (Repatriation) R - Retail
17 22 Overseas Corporate Body C - Corporate
18 23 Foreign Institutional Investor C - Corporate
19 24 NRI - NRO [Non Repatriation] R - Retail
20 25 Overseas Corporate Body-Others C - Corporate
21 26 NRI - Minor (NRE) R - Retail

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 60

 22 27 NRI-HUF(NRO) R - Retail
23 28 NRI - Minor (NRO) R - Retail
24 29 NRI-HUF(NRE) R - Retail
25 31 Providend Fund / EPF / PF Trust C - Corporate
26 32 Superannuation C - Corporate
27 33 Gratuity Fund C - Corporate
28 34 Pension and Retirement Fund C - Corporate
29 36 Mutual Funds FOF Schemes C - Corporate
30 37 NPS Trust C - Corporate
31 38 Global Development Network C - Corporate
32 39 FCRA C - Corporate
33 41 Qualified Foreign Investor-Individual R - Retail
34 42 Qualified Foreign Investor-Minors R - Retail
35 43 Qualified Foreign Investor-Corporate C - Corporate
Qualified Foreign Investor-Pension
36 44 Fund C - Corporate
Qualified Foreign Investor-Hedge
37 45 Funds C - Corporate
Qualified Foreign Investor-Mutual
38 46 Funds C - Corporate
39 47 Limited Liability Partnership C - Corporate
40 48 Non-Profit organization [NPO] C - Corporate
41 51 Public Limited Company C - Corporate
42 52 Private Limited Company C - Corporate
43 53 Unlisted Company C - Corporate
44 54 Mutual Funds C - Corporate
45 55 FPI - Category I C - Corporate
46 56 FPI - Category II C - Corporate
47 57 FPI - Category III C - Corporate
48 58 Financial Institutions C - Corporate
49 59 Body of Individuals C - Corporate
50 60 Insurance Company C - Corporate
51 61 OCI - Repatriation R - Retail
52 62 OCI - Non Repatriation R - Retail
53 70 Person of Indian Origin [PIO] R - Retail
54 72 Government Body C - Corporate
55 73 Defence Establishment C - Corporate
56 74 Non-Government Organisation [NGO] C - Corporate
57 75 Artificial Juridical Person C - Corporate
58 76 Trust - Liquidator C - Corporate

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 61

 Occupation

Occupation
S No Occupation Code Type
1 Business 01 Business
2 Service 02 Service
3 Professional 03 Service
4 Agriculturist 04 Service
5 Retired 05 Others
6 Housewife 06 Others
7 Student 07 Others
8 Others 08 Others
9 Doctor 09 Service
Private Sector
10 Service 41 Service
11 Public Sector Service 42 Service
12 Forex Dealer 43 Business
13 Government Service 44 Service
Unknown / Not
14 Applicable 99 Others

Applicant Income

S No Income Code Income

1 31 Below 1 Lakh
2 32 > 1 <=5 Lacs
3 33 >5 <=10 Lacs
4 34 >10 <= 25 Lacs
> 25 Lacs < = 1
5 35
Crore
6 36 Above 1 Crore

UBO Code

S No UBO Code UBO Detail

1 C01 CP of legal person-ownership
2 C02 CP of legal person-other means
3 C03 CP of legal person-senior managing official
4 C04 CP of legal arrangement-trust-settlor
5 C05 CP of legal arrangement-trust-trustee

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 62

 6 C06 CP of legal arrangement-trust-protector
7 C07 CP of legal arrangement-trust-beneficiary
8 C08 CP of legal arrangement-trust-other
9 C09 CP of legal arrangement-trust-other-settlor equivalent
10 C10 CP of legal arrangement-trust-other-trustee-equivalent
11 C11 CP of legal arrangement-trust-other-protector equivalent
12 C12 CP of legal arrangement-trust-other-beneficiary-equivalent
13 C13 CP of legal arrangement-trust-other-other-equivalent
14 C14 Unknown

Identification Type

S No Identification Code Identification Type

1 A Passport
2 B Election ID Card
3 C PAN Card
4 D ID Card
5 E Driving License
6 G UIDIA / Aadhar letter
7 H NREGA Job Card
8 O Others
9 X Not categorized
10 T TIN [Tax Payer Identification Number]
11 C1 Company Identification Number
12 G1 US GIIN
13 E1 Global Entity Identification Number

State Code

S
No State Code State Name
1 AN Andaman & Nicobar
2 AP Andhra Pradesh
3 AR Arunachal Pradesh
4 AS Assam
5 BR Bihar
6 CH Chandigarh
7 CG Chattisgarh
Dadra and Nagar
8 DN Haveli
9 DD Daman & Diu
10 DL Delhi
11 GA Goa

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 63

 12 GJ Gujarat
13 HR Haryana
14 HP Himachal Pradesh
15 JK Jammu & Kashmir
16 JH Jharkhand
17 KA Karnataka
18 KL Kerala
19 LD Lakshadweep
20 MP Madhya Pradesh
21 MH Maharashtra
22 MN Manipur
23 ML Meghalaya
24 MZ Mizoram
25 NL Nagaland
26 OR Orissa
27 PY Pondicherry
28 PB Punjab
29 RJ Rajasthan
30 SK Sikkim
31 TN Tamil Nadu
32 TR Tripura
33 UP Uttar Pradesh
34 UA Uttarakhand
35 WB West Bengal
36 XX Others

Exemption Code

Exemption
S No Code Exemption Reason
An organization exempt from tax under section 501(a) or any individual retirement
A
1 plan as defined in section 7701(a)(37)
2 B The United States or any of its agencies or instrumentalities
A state, the District of Columbia, a possession of the United States, or any of their
C
3 political subdivisions or instrumentalities
A corporation the stock of which is regularly traded on one or more established
D
4 securities markets, as described in Reg. section 1.1472-1(c)(1)(i)
A corporation that is a member of the same expanded affiliated group as a
E
5 corporation described in Reg. section 1.1472-1(c)(1)(i)
A dealer in securities, commodities, or derivative financial instruments (including
F notional principal contracts, futures, forwards, and options) that is registered as
6 such under the laws of the United States or any state
7 G A real estate investment trust
A regulated investment company as defined in section 851 or an entity registered
H
8 at all times during the tax year under the Investment Company Act of 1940
9 I A common trust fund as defined in section 584(a)
10 J A bank as defined in section 581

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 64

 11 K A broker
12 L A trust exempt from tax under section 664 or described in section 4947(a)(1)
13 M A tax exempt trust under a section 403(b) plan or section 457(g) plan
14 N Not Applicable

GIIN Exempt

S GIIN Exempt
No Code GIIN Exempt Detail
1 1 Governmental Entity, International Organization or Central Bank
2 Treaty Qualified Retirement Fund; a Broad Participation Retirement Fund; a Narrow
Participation Retirement Fund; or a Pension Fund of a Governmental Entity, International
2 Organization or Central Bank
3 Non-public fund of the armed forces, an employees' state insurance fund, a gratuity fund
3 or a provident fund
4 4 Entity is an Indian FI solely because it is an investment entity
5 5 Qualified credit card issuer
6 6 Investment Advisors, Investment Managers& Executing Brokers
7 7 Exempt collective investment vehicle
8 8 Trustee of an Indian Trust
9 9 FI with a local client base
10 10 Non-registering local banks
11 11 FFI with only Low-Value Accounts
12 12 Sponsored investment entity and controlled foreign corporation
13 13 Sponsored, Closely Held Investment Vehicle
14 14 Owner Documented FFI

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 65

 Active NFE Sub Category

S No Active NFE Sub Category Code Active NFE Sub Category Detail
Less than 50 percent of the NFE's gross income for the
preceding financial yearis passive income and less than 50
1 01 percent of the assets held by theNFE during the preceding
financial year are assets that produce or are held for the
production of passive income;
The NFE is a Governmental Entity, an International
2 02 Organization, a Central Bank , or an entity wholly owned by one
or more of the foregoing;
Substantially all of the activities of the NFE consist of holding
(in whole or in part) the outstanding stock of, or providing
financing and services to, one or more subsidiaries that engage
in trades or businesses other than the business of a Financial
Institution, except that an entity shall not qualify for this status
if the entity functions as an investment fund, such as a private
3 03 equity fund, venture capital fund, leveraged buyout fund, or any
investment vehicle whose purpose is to acquire or fund
companies and then hold interests in those companies as
capital assets for investment purposes;

The NFE is not yet operating a business and has no prior

operating history, but is investing capital into assets with the
intent to operate a business other than that of a Financial
4 04 Institution, provided that the NFE shall not qualify for this
exception after the date that is 24 months after the date of the
initial organization of the NFE;
The NFE was not a Financial Institution in the past five years,
and is in the process of liquidating its assets or is reorganizing
5 05 with the intent to continue or recommence operations in a
business other than that of a Financial Institution;
The NFE primarily engages in financing and hedging
transactions with, or for, Related Entities that are not Financial
Institutions, and does not provide financing or hedging services
6 06 to any Entity that is not a Related Entity, provided that the group
of any such Related Entities is primarily engaged in a business
other than that of a Financial Institution;

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 66

 Any NFE that fulfills all of the following requirements:
* It is established and operated in India exclusively for religious,
charitable, scientific, artistic, cultural, athletic, or educational
purposes; or it is established and operated in India and it is a
professional organization, business league, chamber of
commerce, labor organization, agricultural or horticultural
organization, civic league or an organization operated
exclusively for the promotion of social welfare;
* It is exempt from income tax in India;
* It has no shareholders or members who have a proprietary or
beneficial interest in its income or assets;
The applicable laws of the NFE's country or territory of
residence or the NFE's formation documents do not permit any
income or assets of the NFE to be distributed to, or applied for
the benefit of, a private person or non-charitable Entity other
than pursuant to the conduct of the NFE's charitable activities,
or as payment of reasonable compensation for services
7 07 rendered, or as payment representing the fair market value of
property which the NFE has purchased; and
The applicable laws of the NFE's country or territory of
residence or the NFE's formation documents require that, upon
the NFE's liquidation or dissolution, all of its assets be
distributed to a governmental entity or other non-profit
organization, or escheat to the government of the NFE's
country or territory of residence or any political subdivision
thereof.
Explanation.- For the purpose of this sub-clause, the following
shall be treated as fulfilling the criteria provided in the said sub-
clause, namely:-
(I) an Investor Protection Fund referred to in clause (23EA);
(II) a Credit Guarantee Fund Trust for Small Industries referred
to in clause 23EB; and
(III) an Investor Protection Fund referred to in clause (23EC),
of section 10 of the Act;

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 67

 Mandatory Fields for Individual:-

When PAN is available :-

Sr. Nos. Name

1 PAN_RP
2 INV_NAME
3 TAX_STATUS
4 DATA_SRC
5 ADDR_TYPE
6 PO_BIR_INC
7 CO_BIR_INC
8 TAX_RES1
9 TPIN1
10 ID1_TYPE
11 SRCE_WEALT
12 INC_SLAB
13 PEP_FLAG
14 OCC_CODE
15 OCC_TYPE
16 EXCH_NAME
17 UBO_APPL
18 SDF_FLAG
19 UBO_DF
20 Log Name

When PAN is not available:-

21 DOB
22 FR_NAME
23 SP_NAME

Mandatory Fields for Non-Individuals:-

Sr. No. Name

1 PAN_RP
2 INV_NAME
3 TAX_STATUS
4 DATA_SRC
5 ADDR_TYPE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 68

 6 PO_BIR_INC
7 CO_BIR_INC
8 TAX_RES1
9 TPIN1
10 ID1_TYPE
11 SRCE_WEALT
12 CORP_SERVS
13 INC_SLAB
14 NET_WORTH
15 NW_DATE
16 PEP_FLAG
17 OCC_CODE
18 OCC_TYPE
19 EXEMP_CODE
20 FFI_DRNFE
21 NFFE_CATG
22 EXCH_NAME
23 UBO_APPL
24 SDF_FLAG
25 UBO_DF
26 NEW_CHANGE
27 LOG_NAME

****************------------------- END OF FATCA STRUCTURE------------------*****************

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 69

 Payment Gateway Values
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

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

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

Mandatory/ Non
Mandatory Fields
Parameters TYPE Length Sample
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 current
END DATE DATE Yes Yes
date + 100 yrs.

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 70

 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

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 71

 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
client code Varchar 10
remarks Varchar 100

SWP CANCELLATION

Parameters Type Length Sample

SWP registration no Varchar 8
client code Varchar 10
remarks Varchar 100

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 72

 CKYC UPLOAD

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.1 – MAY 2022 PAGE NO. 73

 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.1 – MAY 2022 PAGE NO. 74

 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 availabe
FAILED: ORDER NOT FOUND FOR ORDER ID- when the order that is passed is not availabe

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 75

 MUTUAL FUND ENHANCED UCC
REGISTRATION WEB SERVICE MESSAGE
STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 76

 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.1 – MAY 2022 PAGE NO. 77

 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|||||",
"Filler1" : "",
"Filler2" : ""
}

Response Parameter (JSON Format)

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 78

 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|||||",
"Filler1" : "",
"Filler2" : ""
}

Response Parameter (JSON Format)

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 79

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

MFI MFD

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

2 Primary Holder First When Upgrading

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

5 Tax Status Mandatory Refer Tax Status char 2 3 3 CLIENT TAX STATUS

Mandatory for Individual and

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

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

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 80

 8 Occupation Code 2 4 4 CLIENT OCCUPATION
Mandatory Refer Occupation Code char
CODE

9 Holding Nature Mandatory Refer Holding (SI/ JO/ AS) char 2 2 2 CLIENT HOLDING

Second Holder First Conditional Mandatory if Mode of Holding

10 char
Name Mandatory JO/AS

Second Holder
11 Optional 70 6 6
Middle Name

Second Holder Last

12 Optional
Name CLIENT

Third Holder First

13 Optional char
Name

14 Third Holder Middle

Optional 70 7 7
Name

15 Third Holder Last

Optional
Name CLIENT APP. NAME 3

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

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

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 81

 Conditional
18 Guardian First Name Mandatory for Minor Clients char
Mandatory

19 Guardian Middle 120 10 10 Guardian's Name

Optional char
Name

20 Guardian Last Name Optional char

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

22 Primary Holder PAN 1 NEW NEW NEW

Mandatory Y/N Varchar
Exempt

23 Second Holder PAN 1 NEW NEW NEW

Mandatory Y/N Varchar
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

Conditional Mandatory if Primary Holder

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

Mandatory if Second Holder

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

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 82

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

Conditional Mandatory if Guardian PAN CLIENT GUARDIAN

29 Guardian PAN char 10 14 14
Mandatory Exempt flag N. PAN

Mandatory if PRIMARY Holder

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

Mandatory if SECOND HOLDER

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

Mandatory if THIRD HOLDER

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

Mandatory if Guardian PAN

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

34 Client Type Mandatory P / D (P- Physical /D- Demat) Varchar 1 NEW 15 Client Type

Conditional Mandatory if client type D

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

Conditional Mandatory if client type D

36 Default DP char 4 15 16
Mandatory (CDSL/NSDL) CLIENT DEFAULT DP

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 83

 Conditional Mandatory if Default DP is
37 CDSL DPID char 8 16 17
Mandatory CDSL CLIENT CDSL DP ID

Conditional Mandatory if Default DP is CLIENT CDSL CLIENT

38 CDSLCLTID char 16 17 18
Mandatory CDSL ID

Conditional Mandatory if PMS Flag is ‘Y’

39 CMBP Id Number 16 NEW NEW
Mandatory and client Default DP is NSDL NEW

Conditional Mandatory if Default DP if

40 NSDLDPID char 8 18 19
Mandatory NSDL CLIENT NSDL DP ID

Conditional Mandatory if Default DP if CLIENT NSDL CLIENT

41 NSDLCLTID char
Mandatory NSDL 8 19 20 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 Mandatory varchar 11 26 24 CLIENT NEFT CODE

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

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

Conditional Mandatory if Client Acctype 2

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

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

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 84

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

Conditional Mandatory if Client Acctype 2

51 Default Bank Flag varchar
Mandatory is available (Y/N) 1 NA 30 Default bank flag

52 Account type 3 Optional Refer Account Type varchar 2 NA 31 CLIENT ACC TYPE 3

Conditional Mandatory if Client Acctype 3

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

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

Mandatory if Client Acctype 3 CLIENT

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

Conditional Mandatory if Client Acctype 3

56 Default Bank Flag varchar
Mandatory is available (Y/N) 1 NA 35 Default bank flag

57 Account type 4 Optional Refer Account Type varchar 2 NA 36 CLIENT ACC TYPE 4

Conditional Mandatory if Client Acctype 4

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

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

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 85

 Mandatory if Client Acctype 4 CLIENT
Conditional
60 IFSC Code 4 is available and MICR not varchar NEFT/IFSC CODE
Mandatory
available 11 NA 39 4

Conditional Mandatory if Client Acctype 4

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

62 Account type 5 Optional Refer Account Type varchar 2 NA 41 CLIENT ACC TYPE 5

Conditional Mandatory if Client Acctype 5

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

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

Mandatory if Client Acctype 5 CLIENT

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

Conditional Mandatory if Client Acctype 5

66 Default Bank Flag varchar
Mandatory is 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 Refer 2 41 60 CLIENT DIV PAY

Mandatory varchar
DIVPAYMODE MODE

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

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 86

 70 Address 2 Optional varchar 40 29 48 CLIENT ADD 2

71 Address 3 Optional varchar 40 30 49 CLIENT ADD 3

72 City Mandatory Not mandatory for NRI varchar 35 31 50 CLIENT CITY

73 State Mandatory Not mandatory for NRI varchar 2 32 51 CLIENT STATE

74 Pincode Mandatory Not mandatory for NRI varchar 6 33 52 CLIENT PIN CODE

75 Country Mandatory Not mandatory for NRI varchar 35 34 53 CLIENT COUNTRY

76 Resi. Phone Optional Not mandatory for NRI varchar 15 35 54 CLIENT RESI PHONE

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

78 Office Phone 15 37 56 CLIENT OFFICE

Optional Not mandatory for NRI varchar
PHONE

79 Office Fax Optional Not mandatory for NRI varchar 15 38 57 CLIENT OFFICE FAX

80 Email Mandatory varchar 50 39 58 CLIENT EMAIL

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

Conditional Mandatory for NRI, Except for

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

83 Foreign Address 2 Optional varchar 40 46 65 CM_ FOREIGN ADD 2

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 87

 84 Foreign Address 3 Optional varchar 40 47 66 CM_ FOREIGN ADD 3

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

Foreign Address Conditional CM_ FOREIGN PIN

86 Mandatory for NRI varchar
Pincode Mandatory 10 49 68 CODE

Foreign Address Conditional

87 Mandatory for NRI varchar
State Mandatory 35 50 69 CM_ FOREIGN STATE

Foreign Address Conditional CM_ FOREIGN

88 Mandatory for NRI varchar
Country Mandatory 3 51 70 COUNTRY

89 Foreign Address Resi 15 52 71 CM_ FOREIGN RESI

Optional varchar
Phone PHONE

90 Foreign Address Fax 15 53 72 CM_ FOREIGN RESI

Optional varchar
FAX

91 Foreign Address Off. 15 54 73 CM_ FOREIGN OFF

Optional varchar
Phone PHONE

92 Foreign Address Off. 15 55 74 CM_ FOREIGN OFF

Optional varchar
Fax FAX

93 Indian Mobile No. Mandatory varchar 10 75 CM_MOBILE

94 Nominee 1 Name Optional varchar 40 12 12 CLIENT NOMINEE

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 88

 Nominee 1 Conditional Mandatory if client nominee CLIENT NOMINEE
95 varchar
Relationship Mandatory available 40 13 13 RELATION

Nominee 1 Conditional Mandatory if client nominee

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

Nominee 1 Minor Conditional Mandatory if client nominee

97 Char
Flag Mandatory available 1 NEW NEW NEW

Conditional Mandatory only if Nominee

98 Nominee 1 DOB Date
Mandatory minor flag Y NEW NEW NEW

Conditional Mandatory if Nominee minor

99 Nominee 1 Guardian Char
Mandatory flag Y 35 NEW NEW NEW

100 Nominee 2 Name Optional Char 40 NEW NEW NEW

Nominee 2 Conditional Mandatory if Nominee 2

101 Char
Relationship Mandatory available 40 NEW NEW NEW

Nominee 2 Conditional Mandatory if Nominee 2

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

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

Nominee 2 Minor Conditional Mandatory if Nominee 2

104 Varchar
Flag Mandatory available 1 NEW NEW NEW

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 89

 Conditional Mandatory if Nominee 2
105 Nominee 2 Guardian Char
Mandatory available 35 NEW NEW NEW

106 Nominee 3 Name Optional Char 40 NEW NEW NEW

Nominee 3 Conditional Mandatory if Nominee 3

107 Char
Relationship Mandatory available 40 NEW NEW NEW

Nominee 3 Conditional Mandatory if Nominee 3

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

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

Conditional Mandatory if Nominee 3

110 Nominee3 Minor Flag Varchar
Mandatory available 1 NEW NEW NEW

Conditional Mandatory if Nominee 3

111 Nominee3 Guardian Char
Mandatory available 35 NEW NEW NEW

(K/C/B/E) (K - KRA Compliant CKYC CKYC

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

Primary Holder CKYC Conditional Mandatory if primary holder CKYC CKYC

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

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 90

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

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

(K/C/B/E) (K - KRA Compliant

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

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

(K/C/B/E) (K - KRA Compliant CKYC CKYC

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

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

Primary Holder KRA Conditional Mandatory if Primary Holder

120 Varchar
Exempt Ref. No. Mandatory Pan Exempt 10 NEW NEW NEW

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 91

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

Third Holder KRA Conditional Mandatory if Third Holder Pan

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

Guardian Exempt Conditional Mandatory if Guardian Pan

123 Varchar
Ref. No Mandatory 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 P- Paper/

126 Paperless_flag Mandatory Char 1
Z- paperless NEW NEW NEW

Mandatory for Non - Individual

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

Conditional
128 LEI Validity Mandatory if LEI No is given Date
Mandatory 10 NEW NEW NEW

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 92

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

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

131 Filler 3

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 93

 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.1 – MAY 2022 PAGE NO. 94

 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 1.0 – MAY 21 PAGE NO. 95

 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 1.0 – MAY 21 PAGE NO. 96

 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 1.0 – MAY 21 PAGE NO. 97

 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 1.0 – MAY 21 PAGE NO. 98

 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 1.0 – MAY 21 PAGE NO. 99

 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 1.0 – MAY 21 PAGE NO. 100

 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 1.0 – MAY 21 PAGE NO. 101

 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 1.0 – MAY 21 PAGE NO. 102

 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 1.0 – MAY 21 PAGE NO. 103

 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 1.0 – MAY 21 PAGE NO. 104

 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 1.0 – MAY 21 PAGE NO. 105

 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 1.0 – MAY 21 PAGE NO. 106

 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 1.0 – MAY 21 PAGE NO. 107

 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 1.0 – MAY 21 PAGE NO. 108

 MUTUAL FUND StAR MF ENHANCED
STP REGISTRATION API MESSAGE
STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 109

 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

API KEY VmxST1UyRkhUbkpOVldNOQ==

MF – WEB SERVICES STRUCTURE VERSION 1.0 – MAY 21 PAGE NO. 110

 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 1.0 – MAY 21 PAGE NO. 111

 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 1.0 – MAY 21 PAGE NO. 112

 StAR MF EXCHANGE & STP Registration and Cancellation API JSON Request &
Response

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

API KEY : 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" : "",
"Filler1" : "",
"Filler2" : "",

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 113
 "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.1 – MAY 2022 PAGE NO. 114
 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.1 – MAY 2022 PAGE NO. 115
 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.1 – MAY 2022 PAGE NO. 116
 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.1 – MAY 2022 PAGE NO. 117
 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.1 – MAY 2022 PAGE NO. 118
 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.1 – MAY 2022 PAGE NO. 119
 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.1 – MAY 2022 PAGE NO. 120
 MUTUAL FUND AOF IMAGE UPLOAD
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 121
 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

GetPassword

A. Rest
a. Request parameter In Rest
: {"UserId":"9999901","MemberId":"99999","Password":"@1234
5"}
b. Response :
: {"Filler":null,"ResponseString":"wDNn3SYDFo5xVDKIMeBhZxpiFr
n++A8JbTarS\/5e3ogmBX7vJPGDtA==","Status":"100"}

B. SOAP
a. Request Parameter In SOAP “ : PasswordRequest(dataContart)
b. Response : Response (dataContart)

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 122
 MUTUAL FUND AOF Image Upload Login Request Response
The Method used for MUTUAL FUND Image Upload 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. 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 Image Upload Services Request

The Method used for MUTUAL FUND Image Upload Request is UploadFile

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
Member Code Varchar 20 Member Code
Client Code Varchar 10 Client Code
File Name Varchar 20 Image Name
Document Type Varchar 3 Nrm/Ria
Filebytes Byte Array Image
Filler 1
Filler 2

UploadFile :

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 123
 A. Rest
a. Request parameter In Rest : {“Flag”:”UCC”, “UserId” : “123”,
“EncryptedPassword”= “sfgdfdfgsdfsd”, “MemberCode”= “123”,
“ClientCode”:”ABC”,”“FileName”:”abc.tiff”, “DocumentType”=””,
“pFileBytes”:””, “Filler1”:”Null”, “Filler2”:,”NULL”}
b. Response : : {"Filler":null,"ResponseString":"File Uploaded
Sucessfully","Status":"100"}

B. SOAP
a. Request Parameter In SOAP “ : FileData(dataContart)
b. Response : Response (dataContart)

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 124
 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.1 – MAY 2022 PAGE NO. 125
 MUTUAL FUND SCAN IMAGE UPLOAD
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 126
 MUTUAL FUND SCAN MANDATE IMAGE UPLOAD WEB SERVICES
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

User id Varchar 20
Memberid Varchar 20
Password Varchar 30

MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login Request

Response

Parameters Type Length Remarks

Filler Varchar 100
100- success
Status code Varchar 3
101- failure
Encrypted
Varchar 500
password/error reason

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 127
 MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Login
Request/Response Sample

Request Parameter: (JSON Format)

{
"UserId": "9999901",
"MemberId": "99999",
"Password": "@1234",
}

Response (JSON Format)

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 128
 MUTUAL FUND SCAN MANDATE IMAGE UPLOAD SERVICES WEB
SERVICES MESSAGE STRUCTURE

MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request

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

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

Values for Utility Code & Sponsor Bank Code

Utility Code Agency Code

YESB00709000028661 FINLOGIC

MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Request Response

Parameters Type Length Remarks

Response string Bank page in html format

100- success
Status code Varchar 3
101- failure
Filler 100

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 129
 MUTUAL FUND SCAN MANDATE IMAGE UPLOAD Services Service
Request/Response Sample

Request Parameter: (JSON Format)

{
"Flag":"SCAN_Mandate",
"MemberCode":"99999",
"ClientCode": "465",
"MandateId": "292340",
"ImageName": "292340.tiff" OR "292340.jpeg",
"MandateType": "XSP",
"ImageType": "image/tiff" OR "image/jpeg",
"EncryptedPassword":
"wDNn3SYDFo5xVDKIMeBhZ7k41WoKvnfmrhY77rWehD1SA8etG0rdxA==",
"pFileBytes": "",
"Filler1": " YESB00709000028661",
"Filler2": " FINLOGIC "
}

Response (JSON Format)

{
"ResponseString": "File Uploaded Successfully ",
"Status": "100" ( 100 : Success , 101 : Failure)
"FILLER":NULL
}

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 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 BSEStAR 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.1 – MAY 2022 PAGE NO. 131
 MUTUAL FUND DIRECT PAYMENT
GATEWAY REQUEST AND RESPONSE
SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 132
 MUTUAL FUND DIRECT PAYMENT GATEWAY MESSAGE STRUCTURE

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

❖ Mode of payment and bank ID is available as a bank mapping table.

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 133
 ❖ 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.1 – MAY 2022 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 Response

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.1 – MAY 2022 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.1 – MAY 2022 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.1 – MAY 2022 PAGE NO. 137
 MUTUAL FUND CHILD ORDER
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 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 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

GetPassword

A Request Parameter: (JSON Format)

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

B Response (JSON Format)

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 139
 MUTUAL FUND Child Order Login Request Response
The Method used for MUTUAL FUND Child Order Login Request Response is
GetPasswordForChildOrderResponse > Response

Parameters Type Length Remarks

Status 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 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 Services Request

The Method used for MUTUAL FUND Child Order Services Request is ChildOrderDetails >
ChildOrderRequest

A Request Parameter : (JSON Format)

{

"Date": "07 JUL 2017",

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 140
 MUTUAL FUND Child Order Services Response
The Method used for MUTUAL FUND Child Order Services Response is ChildOrderDetailsResponse
> ChildOrderResponse

B Respose (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",
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.1 – MAY 2022 PAGE NO. 141
 MUTUAL FUND MANDATE STATUS
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 142
 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 parameters

Parameters Type Length Remarks

Requesttype Varchar 20 Mandate
User id Varchar 20
Memberid Varchar 20
Password Varchar 30
Passkey Varchar 20

MUTUAL FUND Mandate Status Login Request Response

Parameters Type Length Remarks

100- success
Status code Varchar 3
101- failure
Encrypted password/error
Varchar 500
reason

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 143
 MUTUAL FUND Mandate Status Login Request/Response Sample

Request Parameter: (JSON Format)

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

Response (JSON Format)

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 144
 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

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

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.1 – MAY 2022 PAGE NO. 145
 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.1 – MAY 2022 PAGE NO. 146
 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 (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.1 – MAY 2022 PAGE NO. 147
 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.1 – MAY 2022 PAGE NO. 148
 MUTUAL FUND REPORTS
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 149
 - 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

Order No Varchar 20 non-mandatory are ignored.

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 150
 Filler 1 non-mandatory
Filler 2 non-mandatory
Filler 3 non-mandatory

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 151
 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
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

34 KYC Flag Char 1
purchases above Rs.50000/-

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 152
 Y or N. Mandatory field. In case of
purchases it should be a N. in case of
any redemption above 50 units it
35 MIN Redemption Flag Char 1
should be N, in case of units below
50 units it should be Y. Will be N in
case of Physical.
non - mandatory field, it should start
36 Sub- Broker ARN Varchar 20
with ARN

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.1 – MAY 2022 PAGE NO. 153
 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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 154
 Filler 2 non-mandatory
Filler 3 non-mandatory

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
MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 155
 13 Foliono Varchar 16
14 Rtaschemecode Varchar 10

15 Rtatransno Varchar 20

16 Clientcode Varchar 10
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.1 – MAY 2022 PAGE NO. 156
 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.1 – MAY 2022 PAGE NO. 157
 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.1 – MAY 2022 PAGE NO. 158
 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.1 – MAY 2022 PAGE NO. 159
 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.1 – MAY 2022 PAGE NO. 160
 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.1 – MAY 2022 PAGE NO. 161
 MUTUAL FUND e-NACH MANDATE
AUTHENTICATION URL
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 162
 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.1 – MAY 2022 PAGE NO. 163
 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.1 – MAY 2022 PAGE NO. 164
 MUTUAL FUND MANDATE SHIFT
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 165
 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.1 – MAY 2022 PAGE NO. 166
 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.1 – MAY 2022 PAGE NO. 167
 MUTUAL FUND CHEQUE COLLECTION
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 168
 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.1 – MAY 2022 PAGE NO. 169
 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.1 – MAY 2022 PAGE NO. 170
 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.1 – MAY 2022 PAGE NO. 171
 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.1 – MAY 2022 PAGE NO. 172
 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.1 – MAY 2022 PAGE NO. 173
 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.1 – MAY 2022 PAGE NO. 174
 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.1 – MAY 2022 PAGE NO. 175
 MUTUAL FUND SINGLE PAYMENT
GATEWAY API
WEB SERVICES MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 176
 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.1 – MAY 2022 PAGE NO. 177
 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.1 – MAY 2022 PAGE NO. 178
 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.1 – MAY 2022 PAGE NO. 179
 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.1 – MAY 2022 PAGE NO. 180
 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.1 – MAY 2022 PAGE NO. 181
 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.1 – MAY 2022 PAGE NO. 182
 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.1 – MAY 2022 PAGE NO. 183
 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.1 – MAY 2022 PAGE NO. 184
 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.1 – MAY 2022 PAGE NO. 185
 MUTUAL FUND CHEQUE IMAGE
UPLOAD API FOR NRI MINOR

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 186
 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.1 – MAY 2022 PAGE NO. 187
 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.1 – MAY 2022 PAGE NO. 188
 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.1 – MAY 2022 PAGE NO. 189
 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.1 – MAY 2022 PAGE NO. 190
 MUTUAL FUND SIP XSIP PAUSE API
WEB SERVICE MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 191
 MUTUAL FUND SIP XSIP PAUSE API WEB SERVICE MESSAGE STRUCTURE

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

API Key : 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.1 – MAY 2022 PAGE NO. 192
 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.1 – MAY 2022 PAGE NO. 193
 MUTUAL FUND SIP TO XSIP SHIFT API
WEB SERVICE MESSAGE STRUCTURE

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 194
 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

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

REMARKS VARCHAR 1000

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 195
 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.1 – MAY 2022 PAGE NO. 196
 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.1 – MAY 2022 PAGE NO. 197
 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.1 – MAY 2022 PAGE NO. 198
 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.1 – MAY 2022 PAGE NO. 199
 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

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)
MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 200
 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

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.

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 201
 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

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 202
 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

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 203
 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

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

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 204
 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.1 – MAY 2022 PAGE NO. 205
 PAGE – INTENTIONALLY LEFT BLANK

MF – WEB SERVICES STRUCTURE VERSION 3.1 – MAY 2022 PAGE NO. 206