BSE StAR-MF

Message 11th Nov

Interface 2017
Structures
 Table of Contents

LOGON REQUEST........................................................................................................................................... 4
LOGON RESPONSE......................................................................................................................................... 5
LOGOFF REQUEST ......................................................................................................................................... 6
LOGOFF RESPONSE........................................................................................................................................ 6
ADD / MODIFY / CANCEL ORDER................................................................................................................... 7
ADD / MODIFY / CANCEL RESPONSE ........................................................................................................... 11
DELTA DOWNLOAD REQUEST ..................................................................................................................... 16
DELTA DOWNLOAD RESPONSE ................................................................................................................... 17
SWITCH MESSAGE STRUCTURE ................................................................................................................... 20
SWITCH RETURN MESSAGE STRUCTURE .................................................................................................... 22
SPREAD/OVERNIGHT ORDER STRUCTURE .................................................................................................. 24
SPREAD RESPONSE STRUCTURE.................................................................................................................. 27
SIP REGISTRATION MESSAGE STRUCTURE .................................................................................................. 29
SIP REGISTRATION RETURN MESSAGE:....................................................................................................... 32
XSIP REGISTRATION MESSAGE: ................................................................................................................... 34
XSIP RETURN MESSAGE STRUCTURE: ......................................................................................................... 36
SWP REGISTRATION MESSAGE ................................................................................................................... 38
SWP REGISTRATION RETURN MESSAGE ..................................................................................................... 39
STP REGISTRATION MESSAGE ..................................................................................................................... 41
STP REGISTRATION RETURN MESSAGE ....................................................................................................... 42
HEARTBEAT MESSAGES ............................................................................................................................... 44
HEARTBEAT REQUEST ............................................................................................................................. 44
HEARTBEAT RESPONSE ........................................................................................................................... 44
GENERAL ..................................................................................................................................................... 44

BSE StAR-MF IML API Structures (Rev 1.6) 2

REVISION HISTORY ...................................................................................................................................... 45
Revision 1.7 ................................................................................................................................................. 45
Changes in Order Entry Logic .................................................................................................................. 45
SIP ORDER Structure Change .............................................................................................................. 45
Revision 1.6 ................................................................................................................................................. 45
Additional Formats added for ................................................................................................................. 45
Changes in Order Entry Logic .................................................................................................................. 45
ADD / MODIFY / CANCEL ORDER Structure Change ........................................................................... 46
SIP ORDER Structure Change .............................................................................................................. 46
XSIP / ISIP ORDER Structure Change ................................................................................................... 46
SPREAD ORDER Structure Change ...................................................................................................... 47
SWITCH ORDER Structure Change ...................................................................................................... 47

BSE StAR-MF IML API Structures (Rev 1.6) 3

LOGON REQUEST

VALUES / MEANINGS /
FIELD DESCRIPTION TYPE DESCRIPTION
VALIDATIONS

TRANSACTION CODE CHAR(4) TYPE OF MESSAGE 1130 – LOGON REQUEST

LOGINID CHAR(25) THIS FIELD SHOULD CONTAIN
LOGIN ID OF USER / BROKER
MEMBERID CHAR(10) THIS FIELD SHOULD CONTAIN
THE MEMBER ID.
PASSWORD CHAR(8) THIS FIELD SHOULD CONTAIN
THE PASSWORD ENTERED BY
THE USER.

THE PASSWORD SHOULD BE A

MINIMUM OF SIX CHARACTERS
AND MAXIMUM OF EIGHT
CHARACTERS IN LENGTH. A
COMBINATION OF ALPHABET
AND NUMBERS ARE ALLOWED IN
THE PASSWORD.
NEW PASSWORD CHAR(8) THIS FIELD SHOULD CONTAIN
THE PASSWORD ENTERED BY
THE USER.

THE PASSWORD SHOULD BE A

MINIMUM OF SIX CHARACTERS
AND MAXIMUM OF EIGHT
CHARACTERS IN LENGTH. A
COMBINATION OF ALPHABET
AND NUMBERS ARE ALLOWED IN
THE PASSWORD.

SHOULD NOT BE SAME AS

PASSWORD
STARMFID CHAR(30) UNIQUE ID PROVIDED BY THE
EXCHANGE FOR ACCESSING THE
SYSTEM

BSE StAR-MF IML API Structures (Rev 1.6) 4

LOGON RESPONSE

VALUES / MEANINGS /
FIELD DESCRIPTION TYPE DESCRIPTION
VALIDATIONS

TRANSACTION CODE CHAR(4) TYPE OF MESSAGE 1131 – LOGON

RESPONSE/1132-LOGON
REJECTION
LOGINID CHAR(25) THIS FIELD CONTAINS LOGIN ID
OF USER / BROKER
MEMBERID CHAR(10) THIS FIELD CONTAINS THE
MEMBER ID.
DEALERID CHAR(12) DEALER ID.

SHOULD CONTAIN ONLY

NUMBERS
BRANCHCODE CHAR(10) BRANCH CODE OF THE DEALER
ID
REPLYCODE CHAR(3) CODE INDICATING SUCCESS /
FAILURE OF LOGON
0 – LOGIN SUCCESSFUL
OTHERS – FAILURE

SESSION CHAR(50) LOGIN SESSION

SETT NO CHAR(7) APPLICABLE SETTLEMENT NO.
TRADE DATE CHAR(11) APPLICABLE TRADING DATE DD MMM YYYY FORMAT
CURRENT TIME CHAR(8) CURRENT TIME HH24:MI:SS FORMAT
MESSAGE CHAR(250) IF REPLY CODE IS ZERO THEN
MESSAGE WILL BE BLANK
OTHERWISE IT CONTAIN ERROR
MESSAGE

BSE StAR-MF IML API Structures (Rev 1.6) 5

LOGOFF REQUEST

VALUES / MEANINGS /
FIELD DESCRIPTION TYPE DESCRIPTION
VALIDATIONS

TRANSACTION CODE CHAR(4) TYPE OF MESSAGE 2130 – LOGOFF

REQUEST
LOGINID CHAR(25) THIS FIELD CONTAINS LOGIN ID
OF USER / BROKER
MEMBERID CHAR(10) THIS FIELD CONTAINS THE
MEMBER ID.
DEALERID CHAR(12) DEALER ID.

SHOULD CONTAIN ONLY

NUMBERS
BRANCHCODE CHAR(10) BRANCH CODE OF THE DEALER
ID
SESSION CHAR(50) LOGIN SESSION

LOGOFF RESPONSE

VALUES / MEANINGS /
FIELD DESCRIPTION TYPE DESCRIPTION
VALIDATIONS

2131 – LOGOFF
TRANSACTION CODE CHAR(4) TYPE OF MESSAGE RESPONSE/2132
LOGOFF REJECTION
0 – SUCCESS
REPLYCODE CHAR(3)
OTHERS – FAILURE
TRADEDATE CHAR(11) DATE DD MMM YYYY FORMAT
CURRENTTIME CHAR(8) CURRENT TIME HH24:MI:SS FORMAT
MESSAGE CHAR(100) SUCCESS / ERROR MESSAGE

BSE StAR-MF IML API Structures (Rev 1.6) 6

ADD / MODIFY / CANCEL ORDER

VALUES /
FIELD DESCRIPTION TYPE DESCRIPTION MEANINGS /
VALIDATIONS

1000 – NEW
ORDER
2000 – MODIFY
TRANSACTION CODE CHAR(4) TYPE OF MESSAGE
ORDER
3000 – CANCEL
ORDER
UNIQUE NO OF SCHEME MASTER (SCHEME
SCRIPID CHAR(5) TOKEN)
SHOULD CONTAIN ONLY NUMBERS
SCRIPCODE CHAR(20) SCRIP CODE AS GIVEN BY THE EXCHANGE
THIS SHOULD CONTAIN PURCHASE OR
REDEMPTION FLAG
BUYSELL CHAR(1)
P – PURCHASE
R – REDEMPTION
THIS SHOULD CONTAIN TYPE OF BUY
FRESH – FOR FRESH PURCHASE
ADDITIONAL - FOR ADDITIONAL PURCHASE
BUYSELLTYPE CHAR(10)
FOR REDEMPTION, IT SHOULD ALWAYS BE
FRESH
THIS SHOULD CONTAIN THE CLIENT CODE
CLIENTCODE CHAR(10)
FOR WHOM THE TRANSACTION IS ENTERED
THIS FIELD SHOULD CONTAIN THE
MEMBERID CHAR(10)
MEMBER CODE.
THIS SHOULD CONTAIN THE SOURCE FOR
REDEMPTION/ DESTINATION FOR PURCHASE
DPTXNTYPE CHAR(1)
P – PHYSICAL
N – NSDL
C – CDSL
MANDATORY IN CASE OF PURCHASE. IN CASE
OF REDEMPTION EITHER AMOUNT OR UNITS
AMOUNT CHAR(17)
HAVE TO BE SPECIFIED OR ALL UNITS FLAG
HAS TO BE "Y".

BSE StAR-MF IML API Structures (Rev 1.6) 7

 THE FIELD SHOULD CONTAIN ONLY NUMBERS
MULTIPLIED BY 10000.FOR. E.G., IF THE
PURCHASE AMT IS 10001.25 THE FIELD
SHOULD CONTAIN THE VALUE 100012500

ORIGPURCHASEAMT CHAR(17) THIS SHOULD CONTAIN THE LAST MODIFIED

PURCHASE AMONT (IN CASE OF
MODIFICATION)

IN CASE OF FRESH ORDER THIS VALUE

SHOULD BE 0

IN CASE OF REDEMPTION TRANSACTION

THIS VALUE SHOULD BE 0

THE FIELD SHOULD CONTAIN ONLY

NUMBERS MULTIPLIED BY 10000.

FOR. E.G., IF THE ORIGINAL PURCHASE AMT IS

10001.25 THE FIELD SHOULD CONTAIN THE
VALUE 100012500
REDEEMQTY CHAR(17) THIS SHOULD CONTAIN THE REDEMPTION
QUANTITY. IN CASE OF PURCHASE
TRANSACTION THIS VALUE SHOULD BE 0

THE FIELD SHOULD CONTAIN ONLY

NUMBERS MULTIPLIED BY 10000.

FOR. E.G., IF THE REDEEM QTY IS 101.023

THE FIELD SHOULD CONTAIN THE VALUE
1010230
ORIGREDEEMQTY CHAR(17) THIS SHOULD CONTAIN LAST MODIFIED
REDEMPTION QUANTITY. (IN CASE OF
MODIFICATION / CANCELLATION)

IN CASE OF FRESH ORDER THIS VALUE

SHOULD BE 0

IN CASE OF PURCHASE TRANSACTION THIS

VALUE SHOULD BE 0

THE FIELD SHOULD CONTAIN ONLY

NUMBERS MULTIPLIED BY 10000.

BSE StAR-MF IML API Structures (Rev 1.6) 8

 FOR. E.G., IF THE ORIGINAL REDEEM QTY IS
101.023 THE FIELD SHOULD CONTAIN THE
VALUE 1010230
THIS FIELD IS MANDATORY IN CASE OF
ADDITIONAL PURCHASES AND IN CASE OF
REDEMPTIONS. IN CASE OF FRESH
FOLIONO CHAR(16) PURCHASES, THIS FIELD HAS TO BE LEFT
BLANK.
THIS CAN CONTAIN ALPHANUMERIC
CHARACTERS ONLY.
VALID VALUES ARE
KYCSTATUS CHAR(1)
Y – YES N – NO
THIS FIELD MAY CONTAIN REMARKS THAT
REMARKS CHAR(200)
THE USER CAN ENTER AGAINST THE ORDER
THIS FIELD SHOULD CONTAIN LOGIN ID OF
LOGINID CHAR(25)
USER / BROKER
THIS FIELD SHOULD CONTAIN THE
BRANCHCODE CHAR(10)
BRANCH CODE.
DEALER ID.
DEALERID CHAR(12)
SHOULD CONTAIN ONLY NUMBERS
REFERENCENO CHAR(30) REF NO FROM IML
SESSION CHAR(50) LOGIN SESSION
SHOULD CONTAIN 0 FOR FRESH ORDER.

ORDERNO CHAR(16) IN CASE OF MODIFICATION /

CANCELLATION, THIS FIELD SHOULD
CONTAIN THE ORDER NO.
IN CASE OF ORDER ENTRY, THIS FIELD
SHOULD CONTAIN THE CURRENT DATE
DD MMM YYYY
LASTMODIFIEDDATE CHAR(11)
IN CASE OF ORDER MODIFICATION / FORMAT
CANCELLATION, THIS FIELD SHOULD
CONTAIN, LAST MODIFIED DATE
IN CASE OF ORDER ENTRY, THIS FIELD
SHOULD CONTAIN THE CURRENT TIME
HH24:MI:SS
LASTMODIFIEDTIME CHAR(8)
IN CASE OF ORDER MODIFICATION / FORMAT
CANCELLATION, THIS FIELD SHOULD
CONTAIN, LAST MODIFIED TIME

BSE StAR-MF IML API Structures (Rev 1.6) 9

 THIS FIELD SHOULD
SUBBROKERCODE CHAR(20)
CONTAIN SUBBROKERCODE

EUIN CHAR(20) THIS FIELD SHOULD CONTAIN EUIN

EUINDECLARATION CHAR(1) THIS FIELD SHOULD CONTAIN EUIN FLAG ‘Y’ OR ’N’

THIS FIELD SHOULD CONTAIN MINIMUM

MINREDEMPTIONFLAG CHAR(25) ‘Y’ OR ’N’
REDEMPTION FLAG

DPC FLAG(FILLER2) CHAR(25) DPC flag. Mandatory in case of purchase ‘Y’ OR ’N’

All units flag. Mandatory in case of

redemption transaction. If the units or
ALL UNITS FLAG
CHAR(25) amount is specified then this flag has be "N" ‘Y’ OR ’N’
(FILLER3)
and if this flag is "Y" then the amount and
units has to be 0

Sub broker Arn code CHAR(20) sub broker ARN code

FILLER 4 CHAR(20)

FILLER 5 CHAR(20)

FILLER 6 CHAR(20)

BSE StAR-MF IML API Structures (Rev 1.6) 10

ADD / MODIFY / CANCEL RESPONSE

VALUES /
FIELD DESCRIPTION TYPE DESCRIPTION MEANINGS /
VALIDATIONS
1001 – NEW
ORDER RESPONSE
2001 – MODIFY
ORDER RESPONSE
3001 – CANCEL
ORDER RESPONSE
TRANSACTION CODE CHAR(4) TYPE OF MESSAGE
1002-NEW ORDER
REJECTION
2002-MODIFY
ORDER REJECTION
3002-CANCEL
ORDER REJECTION
UNIQUE NO OF SCHEME MASTER (SCHEME
SCRIPID CHAR(5) TOKEN)
SHOULD CONTAIN ONLY NUMBERS
SCRIPCODE CHAR(20) SCRIP CODE AS GIVEN BY THE EXCHANGE
THIS SHOULD CONTAIN PURCHASE OR
BUYSELL CHAR(1) REDEMPTION FLAG P – PURCHASE
R – REDEMPTION
THIS SHOULD CONTAIN TYPE OF BUY
FRESH – FOR FRESH PURCHASE
ADDITIONAL - FOR ADDITIONAL PURCHASE
BUYSELLTYPE CHAR(10)
FOR REDEMPTION, IT SHOULD ALWAYS BE
FRESH
THIS SHOULD CONTAIN THE CLIENT CODE
CLIENTCODE CHAR(10)
FOR WHOM THE TRANSACTION IS ENTERED
THIS FIELD SHOULD CONTAIN THE
MEMBERID CHAR(10)
MEMBER ID.
THIS SHOULD CONTAIN THE SOURCE FOR
DPTXNTYPE CHAR(1) REDEMPTION / DESTINATION FOR
PURCHASE

BSE StAR-MF IML API Structures (Rev 1.6) 11

 P – PHYSICAL
N – NSDL C – CDSL
MANDATORY IN CASE OF PURCHASE. IN
CASE OF REDEMPTION EITHER AMOUNT OR
UNITS HAVE TO BE SPECIFIED OR ALL UNITS
FLAG HAS TO BE "Y".
THE FIELD WOULD CONTAIN ONLY
AMOUNT CHAR(17)
NUMBERS MULTIPLIED BY 10000.

FOR. E.G., IF THE PURCHASE AMT IS

10001.25 THE FIELD SHOULD CONTAIN THE
VALUE 100012500
THIS SHOULD CONTAIN THE LAST
MODIFIED PURCHASE AMONT (IN CASE OF
MODIFICATION)

IN CASE OF FRESH ORDER THIS VALUE

SHOULD BE 0

IN CASE OF REDEMPTION TRANSACTION

ORIGPURCHASEAMT CHAR(17)
THIS VALUE SHOULD BE 0

THE FIELD WOULD CONTAIN ONLY

NUMBERS MULTIPLIED BY 10000.

FOR. E.G., IF THE ORIGINAL PURCHASE AMT

IS 10001.25 THE FIELD SHOULD CONTAIN
THE VALUE 100012500
THIS SHOULD CONTAIN THE REDEMPTION
QUANTITY. IN CASE OF PURCHASE
TRANSACTION THIS VALUE SHOULD BE 0

THE FIELD WOULD CONTAIN ONLY

REDEEMQTY CHAR(17)
NUMBERS MULTIPLIED BY 10000.

FOR. E.G., IF THE REDEEM QTY IS 101.023

THE FIELD SHOULD CONTAIN THE VALUE
1010230
THIS SHOULD CONTAIN LAST MODIFIED
REDEMPTION QUANTITY. (IN CASE OF
ORIGREDEEMQTY CHAR(17) MODIFICATION / CANCELLATION)

IN CASE OF FRESH ORDER THIS VALUE

BSE StAR-MF IML API Structures (Rev 1.6) 12

 SHOULD BE 0

IN CASE OF PURCHASE TRANSACTION THIS

VALUE SHOULD BE 0

THE FIELD WOULD CONTAIN ONLY

NUMBERS MULTIPLIED BY 10000.

FOR. E.G., IF THE ORIGINAL REDEEM QTY IS

101.023 THE FIELD SHOULD CONTAIN THE
VALUE 1010230
THIS FIELD IS MANDATORY IN CASE OF
ADDITIONAL PURCHASES AND IN CASE OF
REDEMPTIONS. IN CASE OF FRESH
FOLIONO CHAR(16) PURCHASES, THIS FIELD HAS TO BE LEFT
BLANK

WOULD CONTAIN ONLY NUMERIC VALUES

VALID VALUES ARE
KYCSTATUS CHAR(1) Y – YES
N – NO
THIS FIELD MAY CONTAIN REMARKS THAT
REMARKS CHAR(200)
THE USER CAN ENTER AGAINST THE ORDER
THIS FIELD SHOULD CONTAIN LOGIN ID OF
LOGINID CHAR(25)
USER / BROKER
REFERENCENO CHAR(30) REF NO FROM IML
DEALER ID.
DEALERID CHAR(12)
SHOULD CONTAIN ONLY NUMBERS
BRANCHCODE CHAR(10) BRANCH CODE OF THE DEALER ID
SESSION CHAR(50) LOGIN SESSION
IN CASE OF ORDER ENTRY, THE SYSTEM
WILL RETURN THE ORDER NO. ASSIGNED
TO THE ORDER
ORDERNO CHAR(16)
IN CASE OF MODIFICATION /
CANCELLATION, THE SYSTEM WILL RETURN
THE VALUE PROVIDED AT THE TIME OF
REQUEST
CHAR(11) THE SYSTEM WILL RETURN THE
DD MMM YYYY
LASTMODIFIEDDATE PROCESSING DATE OF THE ORDER ENTERED
FORMAT
/ MODIFIED / CANCELLED
LASTMODIFIEDTIME CHAR(8) THE SYSTEM WILL RETURN THE HH24:MI:SS

BSE StAR-MF IML API Structures (Rev 1.6) 13

 PROCESSING TIME OF THE ORDER ENTERED /
FORMAT
MODIFIED / CANCELLED

SUBBROKERCODE
CHAR(20) THIS FIELD CONTAIN SUBBROKERCODE

EUIN CHAR(20) THIS FIELD CONTAIN EUIN

EUINDECLARATION CHAR(1) THIS FIELD CONTAIN EUIN FLAG ‘Y’ OR ’N’

THIS FIELD CONTAIN PROVIDED MINIMUM

CHAR(25)
MINREDEMPTIONFLAG REDEMPTION FLAG ‘Y’ OR ‘N’
DPC FLAG(FILLER2) CHAR(25) DPC flag. Mandatory in case of purchase ‘Y’ OR ’N’
All units flag. Mandatory in case of
redemption transaction. If the units or
ALL UNITS FLAG
CHAR(25) amount is specified then this flag has be "N" ‘Y’ OR ’N’
(FILLER3)
and if this flag is "Y" then the amount and
units has to be 0
0 – SUCCESS
REPLYCODE CHAR(3)
OTHERS – FAILURE
SYSTEM WOULD RETURN ‘SUCCESS’ IN
CASE OF THE REQUEST GETTING
COMPLETED SUCCESSFULLY
MESSAGE CHAR(1000)
IN CASE OF ERROR, THE SYSTEM WOULD
RETURN THE ERROR MESSAGE

NEW – NEW ORDER

ACTION CHAR(3) MOD – ORDER MODIFIED
CXL – ORDER CANCELLED

Sub broker Arn code CHAR(20) sub broker ARN code

BSE StAR-MF IML API Structures (Rev 1.6) 14

FILLER 4 CHAR(20)

FILLER 5 CHAR(20)

FILLER 6 CHAR(20)

BSE StAR-MF IML API Structures (Rev 1.6) 15

DELTA DOWNLOAD REQUEST

FIELD DESCRIPTION TYPE DESCRIPTION VALUES /

MEANINGS /
VALIDATIONS
4130– TXN CODE
TRANSACTION CODE CHAR(4) TYPE OF MESSAGE
REQUEST
THIS FIELD SHOULD CONTAIN LOGIN ID OF
LOGINID CHAR(25)
USER / BROKER
MEMBERID CHAR(10) THIS FIELD SHOULD CONTAIN THE MEMBER ID.
DEALER ID.
DEALERID CHAR(12)
SHOULD CONTAIN ONLY NUMBERS
BRANCHCODE CHAR(10) BRANCH CODE OF THE DEALER ID
SESSION CHAR(50) LOGIN SESSION
THE LAST DATE FROM WHICH THE DATA IS DD MMM YYYY
LASTDATE CHAR(11)
REQUIRED TO BE FETCHED FORMAT
THE LAST TIME FROM WHICH THE DATA IS HH24:MI:SS
LASTTIME CHAR(8)
REQUIRED TO BE FETHCED FORMAT
SUBBROKERCODE THIS FIELD SHOULD CONTAIN
CHAR(20)
SUBBROKERCODE
EUIN CHAR(20) THIS FIELD SHOULD CONTAIN EUIN
THIS FIELD SHOULD CONTAIN EUIN FLAG
EUINDECLARATION CHAR(1) ‘Y’ OR ’N’

FILLER1 CHAR(25) FOR FUTURE PURPOSE

FILLER2 CHAR(25) FOR FUTURE PURPOSE

FILLER3 CHAR(25) FOR FUTURE PURPOSE

BSE StAR-MF IML API Structures (Rev 1.6) 16

DELTA DOWNLOAD RESPONSE

VALUES /
FIELD DESCRIPTION TYPE DESCRIPTION MEANINGS /
VALIDATIONS
4131 – DELTA
DOWNLOAD
TRANSACTION CODE CHAR(4) TYPE OF MESSAGE
RESPONSE
4132 -REJECTION
UNIQUE NO OF SCHEME MASTER (SCHEME
SCRIPID CHAR(5) TOKEN)
SHOULD CONTAIN ONLY NUMBERS
SCRIPCODE CHAR(20) SCRIP CODE AS GIVEN BY THE EXCHANGE
THIS CONTAINS PURCHASE
OR
BUYSELL CHAR(1) REDEMPTION FLAG
P – PURCHASE
R – REDEMPTION
THIS CONTAINS TYPE OF BUY
FRESH – FOR FRESH PURCHASE
ADDITIONAL - FOR ADDITIONAL PURCHASE
BUYSELLTYPE CHAR(10)
FOR REDEMPTION, IT WILL ALWAYS BE
FRESH
THIS CONTAINS THE CLIENT CODE FOR
CLIENTCODE CHAR(10)
WHOM THE TRANSACTION IS ENTERED
MEMBERID CHAR(10) THIS FIELD CONTAINS THE MEMBER ID.
THIS CONTAINS THE SOURCE FOR
REDEMPTION / DESTINATION FOR
PURCHASE
DPTXNTYPE CHAR(1)
P – PHYSICAL
N – NSDL
C – CDSL
THIS CONTAINS THE PURCHASE AMONT. IN
CASE OF REDEMPTION TRANSACTION THIS
VALUE WOULD BE 0
PURCHASEAMT CHAR(17)
THE VALUE WILL BE MULTIPLIED WITH
10000

BSE StAR-MF IML API Structures (Rev 1.6) 17

 FOR. E.G., IF THE PURCHASE AMT IS
10001.25 THE FIELD SHOULD CONTAIN THE
VALUE 100012500
THIS CONTAINS THE REDEMPTION
QUANTITY. IN CASE OF PURCHASE
TRANSACTION THIS VALUE WOULD BE 0

THE VALUE WILL BE MULTIPLIED WITH

REDEEMQTY CHAR(17)
10000

FOR. E.G., IF THE REDEEM QTY IS 101.023

THE FIELD SHOULD CONTAIN THE VALUE
1010230
THIS FIELD IS MANDATORY IN CASE OF
ADDITIONAL PURCHASES AND IN CASE OF
REDEMPTIONS. IN CASE OF FRESH
FOLIONO CHAR(16) PURCHASES, THIS FIELD WOULD BE LEFT
BLANK

WOULD CONTAIN ONLY NUMERIC VALUES

VALID VALUES ARE
KYCSTATUS CHAR(1) Y – YES
N – NO
THIS FIELD MAY CONTAIN REMARKS THAT
REMARKS CHAR(200)
THE USER CAN ENTER AGAINST THE ORDER
THIS FIELD SHOULD CONTAIN LOGIN ID OF
LOGINID CHAR(25)
USER / BROKER
THIS FIELD SHOULD CONTAIN THE MEMBER
MEMBERID CHAR(10)
ID.
DEALER ID.
DEALERID CHAR(12)
SHOULD CONTAIN ONLY NUMBERS
BRANCHCODE CHAR(10) BRANCH CODE OF THE DEALER ID
SESSION CHAR(50) LOGIN SESSION
THE SYSTEM WILL RETURN THE ORDER NO.
ORDERNO CHAR(16)
ASSIGNED TO THE ORDER
THE SYSTEM WILL RETURN
THE DD MMM YYYY
LASTMODIFIEDDATE CHAR(11)
PROCESSING DATE OF THE ORDER ENTERED FORMAT
/ MODIFIED / CANCELLED
THE SYSTEM WILL RETURN
THE HH24:MI:SS
LASTMODIFIEDTIME CHAR(8)
PROCESSING TIME OF THE ORDER ENTERED FORMAT
/ MODIFIED / CANCELLED

BSE StAR-MF IML API Structures (Rev 1.6) 18

 SUBBROKERCODE
CHAR(20) THIS FIELD CONTAIN SUBBROKERCODE

EUIN CHAR(20) THIS FIELD CONTAIN EUIN

EUINDECLARATION CHAR(1) THIS FIELD CONTAIN EUIN FLAG ‘Y’ OR ’N’

THIS FIELD CONTAIN PROVIDED MINIMUM

CHAR(25)
MINREDEMPTIONFLAG REDEMPTION FLAG ‘Y’ OR ‘N’

FILLER2 CHAR(25) FOR FUTURE PURPOSE

FILLER3 CHAR(25) FOR FUTURE PURPOSE

NEW – NEW ORDER

ACTION CHAR(3) MOD – ORDER MODIFIED
CXL – ORDER CANCELLED
REFERENCENO CHAR(30) REF NO FROM IML

0 – SUCCESS
REPLYCODE CHAR(3)
OTHERS – FAILURE
SYSTEM WOULD RETURN ‘SUCCESS’ IN
CASE OF THE REQUEST GETTING
COMPLETED SUCCESSFULLY
ERRORMESSAGE CHAR(1000)
IN CASE OF ERROR, THE SYSTEM WOULD
RETURN THE ERROR MESSAGE

BSE StAR-MF IML API Structures (Rev 1.6) 19

 SWITCH MESSAGE STRUCTURE

Mandatory
FIELD VALUES THAT
SWITCH DESCRIPTION or non-
TYPE CAN COME
mandatory
Switch Order
mandatory
Request: 6001
Transaction Code char(4) Type of message Switch ORDER
CACELLATION
Request:6007
From AMC Code char(50) From AMC mandatory
To AMC Code char(50) To AMC mandatory
From Scheme Code char(20) From BSE Scheme Code mandatory
To Scheme Code char(20) To BSE Scheme Code mandatory
Client id char(10) BSE client Code mandatory
Txn type char(10) Fresh or additional fresh or additional mandatory
Demat/physical char(1) CDSL or NSDL or physical C/N/P mandatory
Folio number will be mandatory in non-
Folio number char(10)
case of physical transactions mandatory
Here the member has to enter the
quantity in units. (This field should
Units char(17) mandatory
be 0 if the member has entered
amount or selected all units flag)
This should contain last modified
redemption quantity. (In case
Original units char(17) of modification / cancellation and mandatory
incase of fresh entry member
should enter 0)
Here the member has to enter the
purchase amount or redemption
Amount char(17) amount. (This field should have 0 if mandatory
the member has entered quantity
or selected all units flag)
This should contain the last
modified purchase amount or
redemption (in case of
Original amount char(17) modification) mandatory

In case of fresh order this value

should be 0
Sub broker Code char(10) Sub- broker Code
EUIN char(10) EUIN number mandatory

BSE StAR-MF IML API Structures (Rev 1.6) 20

EUIN decl char(1) EUIN deceleration Y/N mandatory
KYC flag char(1) KYC status of client Y/N mandatory
Here member can enter the non-
Remarks char(100)
remarks for his reference mandatory
All units flag. If all units flag is Y
All units flag char(1) then the amount and units column Y/N mandatory
should be 0
Member ID char(10) Member Code mandatory
Login ID char(25) Login ID of the member/user mandatory
Login session (this will
automatically be captured through
Session char(50) mandatory
IML exe which is installed on client
side)
In case of fresh order this field
should contain 0. And in case of
Order no char(20) modification or cancellation BSE mandatory
unique order number has to be
given in this field
Branch Code char(10) Branch Code of Dealer ID mandatory
Dealer ID (should contain only
Dealer ID char(12) mandatory
numeric value)

The system will return the

processing date of the order
Last modified date char(10) DD/MM/YYYY mandatory
entered
/ modified / cancelled

The system will return the

processing time of the order
Last modified time char(8) HH:MM:SS mandatory
entered
/ modified / cancelled
In this the member can enter his Non-
Reference no char(30)
reference number mandatory
Filler 1(Sub Broker
char(20)
ARN)
Filler 2 char(20)
Filler3 char(20)
Filler 4 char(20)

Total Message Length Should be 621 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 21

SWITCH RETURN MESSAGE STRUCTURE

FIELD
SWITCH DESCRIPTION
TYPE
Switch Order Response:6002
Transaction Code char(4) Switch ORDER CACELLATION
Response:6008
From AMC Code char(50) From AMC
To AMC Code char(50) To AMC
From Scheme Code char(20) From Scheme Code
To Scheme Code char(20) To Scheme Code
Client id char(10) BSE client Code
Txn type char(10) Fresh or additional
Demat/physical char(1) CDSL or NSDL or physical
Folio number will be mandatory in case of
Folio number char(10)
physical transactions
Units char(17) Units
Original units char(17) Original units in case of modification
Amount char(17) Amount
Original amount char(17) Original amount in case of modification
Sub- broker Code char(10)
EUIN char(10) EUIN number
EUIN decl char(1) EUIN declaration
KYC flag char(1) KYC flag
Here the remarks which member has
Remarks char(100)
entered will be viewed
All units flag char(1)
Member ID char(10) Member Code
Login ID char(25) Login ID of the member/user
Login session(this will automatically be
Session char(50) captured through IML exe which is installed
on client side)
In this exchange will send the unique order
number assigned to the transaction.. And
Order no char(20) in case of modification or cancellation BSE
unique order number has to be given in
this field
Branch Code char(10) Branch Code of Dealer ID
Dealer ID (should contain only numeric
Dealer ID char(12)
value)

BSE StAR-MF IML API Structures (Rev 1.6) 22

 The system will return the
Last modified date char(10) processing date of the order entered
/ modified / cancelled

The system will return the

Last modified time char(8) processing time of the order entered
/ modified / cancelled
Iml reference number (this will
Reference no char(30) automatically be captured through IML exe
which is installed on client side)
Reply Code char(3) 0 – SUCCESS ; 1 – FAILURE
System would send "success" in case of
transaction is successfully accepted on BSE
Message char(1000) StAR MF.
In case of error, the system would return
the error message

Filler 1(Sub Broker

char(20)
ARN)

Filler 2 char(20)

Filler 3 char(20)

Filler 4 char(20)

Total Message Length Should be 1624 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 23

 SPREAD/OVERNIGHT ORDER STRUCTURE

SPREAD Mandatory
FIELD VALUES THAT CAN
ORDER DESCRIPTION or non-
TYPE COME
MESSAGE mandatory
Spread Order
Request:5001
Transaction Code char(4) Type of message Spread ORDER
CACELLATION
Request:5007
AMC Code char(50) AMC Code mandatory
Scheme Code char(20) Scheme Code mandatory
Client Code char(10) BSE client Code mandatory
Txn type char(10) Additional or Fresh additional or fresh mandatory
Demat/physical char(1) CDSL or NSDL or physical N/C/P mandatory
non-
Folio number char(10) Folio number
mandatory
Purchase amount char(17) Purchase amount mandatory

This should contain the last

modified purchase amount
Original purchase (in case of modification)
char(17) mandatory
amount
In case of fresh order this
value should be 0

non-
Sub broker Code char(10)
mandatory
EUIN char(10) EUIN number mandatory
EUIN decl char(1) EUIN declaration Y/N mandatory
KYC flag char(1) KYC flag Y/N mandatory
DPC char(1) DPC flag Y/N mandatory
If all units flag is Y then the
All units flag char(1) Y/N mandatory
redemption amount will be 0
Date on which member
Redemption date char(10) DD/MM/YYYY mandatory
wants redeem the units
In case of fresh order this
Original field will be 0 and in case of
char(10) DD/MM/YYYY mandatory
redemption date modification of date original
date will be entered here

BSE StAR-MF IML API Structures (Rev 1.6) 24

 Redemption amount. if all
Redemption
char(17) units flag is Y then the mandatory
amount
amount will be 0
This should contain the last
modified redemption
Original amount (in case of
redemption char(17) modification) mandatory
amount
In case of fresh order this
value should be 0
Here the member can enter
Remarks char(100) mandatory
his remarks
Member ID char(20) Member Code mandatory
Login ID char(25) Login ID of the member/user mandatory
Login session(this will
automatically be captured
Session char(50) mandatory
through IML exe which is
installed on client side)
In case of fresh order this
field should contain 0. And in
case of modification or
Order no char(20) mandatory
cancellation BSE unique
order number has to be
given in this field
Branch Code char(10) Branch Code of Dealer ID mandatory
Dealer ID (should contain
Dealer ID char(12) mandatory
only numeric value)

The system will return the

processing date of the order
Last modified date char(10) DD/MM/YYYY mandatory
entered
/ modified / cancelled

The system will return the

processing date of the order
Last modified time char(8) Hh:MM:ss mandatory
entered
/ modified / cancelled

Here member can enter his Non-

Reference no char(30)
reference number. mandatory
Filler 1(Sub Broker
char(20)
ARN)

BSE StAR-MF IML API Structures (Rev 1.6) 25

Filler 2 char(20) mandatory
Filler 3 char(20) mandatory
Filler 4 char(20) mandatory
Total Message Length Should be 582 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 26

SPREAD RESPONSE STRUCTURE

SPREAD ORDER
FIELD TYPE DESCRIPTION
MESSAGE
Transaction Spread Order Response:5002
char(4)
Code Spread ORDER CACELLATION Response:5008
AMC Code char(50) AMC Code
Scheme Code char(20) Scheme Code
Client Code char(10) BSE client Code
Txn type char(10) additional or fresh
Demat/physical char(1) CDSL or NSDL or physical
Folio number char(10) Folio number
Purchase amount char(17) Purchase amount

This should contain the last modified purchase

Original purchase amount (in case of modification)
char(17)
amount
In case of fresh order this value should be 0

Sub broker Code char(10)

EUIN char(10) EUIN number
EUIN decl char(1) EUIN declaration
KYC flag char(1) KYC flag
DPC char(1) DPC flag
if all units flag is Y then the redemption amount will
All units flag char(1)
be 0
Redemption date char(10) date on which member wants redeem the units
In case of fresh order this field will be 0 and in case
Original
char(10) of modification of date original date will be entered
redemption date
here
Redemption
char(17) If all units flag is Y then the amount will be 0
amount
Original
redemption char(17)
amount
Here the remarks which member has entered will
Remarks char(100)
be viewed
Member ID char(10) Member Code
Login ID char(25) Login ID of the member/user

BSE StAR-MF IML API Structures (Rev 1.6) 27

 Session char(50) Login session
In case of fresh order this field should contain 0.
Order no char(20) And in case of modification or cancellation BSE
unique order number has to be given in this field
Branch Code char(10) Branch Code of Dealer ID
Dealer ID char(12) Dealer ID (should contain only numeric value)

The system will return the

Last modified date char(10) processing date of the order entered
/ modified / cancelled

The system will return the

Last modified time char(8) processing date of the order entered
/ modified / cancelled

Reference no char(30) Member reference number

Reply Code char(3) 0 – SUCCESS ; 1 – FAILURE
System would send "success" in case of transaction
is successfully accepted on BSE StAR MF. And also
the success message for redemption order will be
Message char(1000) sent here
in case of error, the system would return the error
message
Filler 1(Sub Broker
char(20)
ARN)
Filler 2 char(20)
Filler 3 char(20)
Filler 4 char(20)

Total Message Length Should be 1575 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 28

 SIP REGISTRATION MESSAGE STRUCTURE

mandatory
SIP FIELD
DESCRIPTION VALUES THAT CAN COME or non-
registration TYPE
mandatory

SIP Order Request:7001

Transaction
char(4) Type of message
Code SIP ORDER CACELLATION
Request:7006

Client Code char(10) BSE StAR MF UCC mandatory

AMC char(50) AMC Code mandatory
Scheme Code char(20) BSE Scheme Code mandatory
Ref No. for member if non
Internal ref no char(10)
he wants to enter mandatory
In which mode the
Transaction
char(1) member wants to D/P mandatory
mode
register the SIP
If the member selects
trans mode as D then
here either member
can enter Codes for
DP transaction
char(1) CDSL(C) or NSDL(N) and C/N/P mandatory
mode
if the member selects
trans mode as Physical
(P), then the member
will enter (P)
This will be only valid
for physical SIP. if
member already has a
non
Folio number char (20) folio number for that
mandatory
particular AMC and he
wants to enter he enter
it here

Type of SIP the member

WEEKLY/MONTHLY/QUARTERLY/SEMI-
Frequency type char(20) wants to enter i.e. mandatory
ANNUALLY/ANNUALLY.
monthly, quarterly etc.

Here the frequency

Frequency
Int(1) Type will be rolling for 1 mandatory
allowed
which Code 1 is

BSE StAR-MF IML API Structures (Rev 1.6) 29

 assigned and member
has to enter that

Installment
Int(8) Installment amount mandatory
amount
If the member wants to
trigger the installment
Generate 1st
char(1) on the same day of Y/N mandatory
order today
registration then he has
to enter as Y else N
Start date char(10) Start date of the SIP DD/MM/YYYY mandatory
Number of
Int(8) Number of installments mandatory
installments
EUIN char(10) EUIN No mandatory
EUIN decl char(1) EUIN declaration Y/N mandatory
Here member can enter
Remarks char (100)
the remarks
DPC char(1) DPC flag Y/N mandatory
Member ID char(10) Member Code mandatory
Login ID of the
Login ID char(25) mandatory
member/user
Login session(this will
automatically be
Session char(50) captured through IML mandatory
exe which is installed
on client side)
SIP registration In case of fresh SIP this
char(10) mandatory
number field should contain 0.
Branch Code of Dealer
Branch Code char(10) mandatory
ID
Dealer ID (should
Dealer ID char(12) contain only numeric mandatory
value)
The system will return
Last modified the
date char(10) processing date of the DD/MM/YY mandatory
order entered
/ modified / cancelled
The system will return
the
Last modified
char(8) processing time of the HH:MM:SS mandatory
time
order entered
/ modified / cancelled

BSE StAR-MF IML API Structures (Rev 1.6) 30

Sub Broker Non-
char(20)
Code (Filler 1) mandatory
Filler 2(Sub Non-
char(20)
Broker ARN) mandatory
Mandatory in
Filler 3 (END case of daily
char(20) DD/MM/YY
DATE) SIP only for
MFI/RFI
Filler 4 char(20) Mandatory

Total Message Length Should be 491 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 31

SIP REGISTRATION RETURN MESSAGE:

SIP REGISTRATION
FIELD TYPE DESCRIPTION
RETURN MESSAGE
SIP Order Response:7002
Transaction Code char(4)
SIP ORDER CACELLATION Response:7007
Client Code char(10) Client Code
Scheme Code char(20) BSE Scheme Code
Internal ref No. char(10) Ref No. for member if he wants to enter

This will be only valid for physical SIP. if member

Folio number char (20) already has a folio number for that particular
AMC and he wants to enter he enter it here

Registration date DATE(10) The date on which SIP is registered(dd/mm/yyyy)

Start date DATE(10) Start date of the SIP (dd/mm/yyyy)
Installment
Int(8) Installment numbers
numbers
End date will be calculated on the basis of start
End date DATE(10)
date and No. of installments (dd/mm/yyyy)
Installment
Int(8) Installment amount
amount
1st order today
char(1) 1st order today flag
flag
Here the remarks which member has entered will
Remarks char (100)
be viewed
DPC flag char(1) DPC flag
Member ID char(10) Member Code
Login ID char(25) Login ID of the member/user
Login session(this will automatically be captured
Session char(50)
through IML exe which is installed on client side)
SIP registration Here the SIP registration will be given which has
char(7)
number been generated by system
Branch Code char(10) Branch Code of Dealer ID
Dealer ID char(12) Dealer ID (should contain only numeric value)

The system will return the

Last modified date char(10) processing date of the order entered
/ modified / cancelled

Last modified time char(8)

Reply Code char(3) 0 – SUCCESS ; 1 – FAILURE

BSE StAR-MF IML API Structures (Rev 1.6) 32

 System would send "success" in case of
transaction is successfully accepted on BSE StAR
Message char(1000) MF.
IN CASE OF ERROR, THE SYSTEM WOULD RETURN
THE ERROR MESSAGE
Sub Broker Code
char(20)
(Filler 1)
Filler 2(Sub Broker
char(20)
ARN)
Filler 3 (END DATE) char(20) DD/MM/YY
Filler 4 char(20)

Total Message Length Should be 1427 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 33

 XSIP REGISTRATION MESSAGE:

mandatory
FIELD
XSIP registration DESCRIPTION SAMPLE VALUE or non-
TYPE
mandatory

XSIP Order
Request:8001
Transaction Code char(4) Type of message XSIP ORDER mandatory
CACELLATION
Request:8007
Client Code char(10) BSE StARMF UCC 258258 mandatory
RelianceMutualFund_
AMC char(50) AMC Code mandatory
MF
Scheme Code char(20) BSE Scheme Code RMFAF-GR mandatory
ref No. for member if he wants to non
Internal ref No. char(10) 123456
enter mandatory
in which mode the member wants to
Transaction mode char(1) D mandatory
register the SIP
if the member selects trans mode as
D then here either member can
DP transaction enter Codes for CDSL(C) or NSDL(N)
char(1) N mandatory
mode and if the member selects trans
mode as Physical (P), then the
member will enter (P)
This will be only valid for physical
SIP. if member already has a folio non
Folio number char (20) 145236
number for that particular AMC and mandatory
he wants to enter he enter it here
Type of SIP the member wants to
Frequency type char(20) MONTHLY mandatory
enter i.e. monthly, quarterly etc.
Here the frequency type will be
Frequency allowed Int(1) rolling for which Code 1 is assigned 1 mandatory
and member has to enter that
Installment amount Int(8) Installment amount 1000 mandatory
Money(8 Brokerage amount. Here the value
Brokerage 10 mandatory
) can be zero
Either xsip
mandate id or
XSIP Mandate ID Int(8) BSE mandate ID 12345652 isip mandate
id is
mandatory

BSE StAR-MF IML API Structures (Rev 1.6) 34

 if the member wants to trigger the
Generate 1st order
char(1) installment on the same day of Y mandatory
today
registration then he has to enter as Y
Start date char(10) Start date of the SIP 12/5/2015 mandatory
Number of
Int(8) Number of installments 20 mandatory
installments
EUIN char(10) EUIN No. E123456 mandatory
EUIN decl char(1) EUIN declaration Y mandatory
Varchar non
Remarks Here member can enter his remarks
(100) mandatory
DPC char(1) DPC flag Y mandatory
Member ID char(10) Member Code mandatory
Login ID char(25) Login ID of the member/user mandatory
Login session(this will automatically
Session char(50) be captured through IML exe which mandatory
is installed on client side)
XSIP registration In case of fresh SIP this field should
char(10) mandatory
number contain 0.
Branch Code char(10) Branch Code of Dealer ID mandatory
Dealer ID (should contain only
Dealer ID char(12) mandatory
numeric value)

The system will return the

Last modified date char(10) processing date of the order entered DD/MM/YYYY mandatory
/ modified / cancelled

The system will return the

Last modified time char(8) processing time of the order entered HH:MM:SS mandatory
/ modified / cancelled
Sub Broker Code Non-
char(20)
(Filler 1) mandatory
Filler 2(Sub Broker filler 2 will be used as sub broker Non-
char(20)
ARN) ARN code mandatory
Either xsip
mandate id or
Filler 3(ISIP filler 3 will be user the ISIP mandate
char(20) isip mandate
Mandate) ID
id is
mandatory
Filler 4 char(20) mandatory

Total Message Length Should be 507 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 35

XSIP RETURN MESSAGE STRUCTURE:

XSIP REGISTRATION
FIELD TYPE DESCRIPTION
RETURN MESSAGE
XSIP Order Response:8002
Transaction Code char(4)
XSIP ORDER CACELLATION Response:8008
Client Code char(10) client Code
Scheme Code char(20) BSE Scheme Code
Internal ref no char(10) Ref No. for member if he wants to enter

SIP reg number char(10) System generated unique SIP registration number

Folio number char (20)

Registration date DATE(10) The date on which SIP is registered
Start date DATE(10) Start date of the SIP
Installment numbers Int(8) installment numbers
End date will be calculated on the basis of start
End date DATE(10)
date and No. of installments
Installment amount Int(8) Installment amount
1st order today flag char(1) 1st order today flag
Here the remarks which member has entered will
Remarks char (100)
be viewed
DPC flag char(1) DPC flag
Member ID char(10) Member Code
Login ID char(25) Login ID of the member/user
Login session(this will automatically be captured
Session char(50)
through IML exe which is installed on client side)
Here the SIP registration will be given which has
XSIP registration no char(10)
been generated by system
Branch Code char(10) Branch Code of Dealer ID
Dealer ID char(12) Dealer ID (should contain only numeric value)

The system will return the

Last modified date char(10) processing date of the order entered
/ modified / cancelled

The system will return the

Last modified time char(8) processing time of the order entered
/ modified / cancelled
Reply Code char(3) 0 – SUCCESS ; 1 – FAILURE
System would send "success" in case of
Message char(1000) transaction is successfully accepted on BSE StAR
MF.

BSE StAR-MF IML API Structures (Rev 1.6) 36

 In case of error, the system would return the error
message
Sub Broker Code (Filler 1) char(20)
Filler 2(sub broker arn) char(20)
Filler 3(isip mandate id) char(20)
Filler 4 char(20)

Total Message Length Should be 1440 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 37

SWP REGISTRATION MESSAGE

SWP REGISTRATION Field

MESSAGE Field Type Length Description
Swp registration request :9001
Transaction code Varchar 4 Swp request Modification Request:9003
Swp registration cancellatio :9005
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 Dd/mm/yyyy
Number of
withdrawls Int 8
Frequency type Varchar 20 Weekly / monthly / quarterly
Installment amount Numeric 25
Installment units Numeric 25
First order today Varchar 1 Y/N
Sub broker code Varchar 15
EUIN decleration Varchar 1 Y/N
EUIN number Varchar 7
Remarks Varchar 100
Sub broker - arn Varchar 20
Member ID Char 10
Login ID Char 25
Session Char 50
Swp registration In case of fresh swp this field should
Char
number 10 contain 0.
Branch code Char 10
Dealer ID Char 12
Last modified date Char 10 DD/MM/YYYY
Last modified time Char 8 HH:MM:SS
Filler 1 Char 20
Filler 2 Char 20
Filler 3 Char 20
Filler 4 Char 20
Total Message Length Should be 507 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 38

SWP REGISTRATION RETURN MESSAGE

SWP REGISTRATION Field

RETURN MESSAGE Field Type Length sample
swp registration response :9002
swp request Modification Response :9004
Transaction code VARCHAR 4
swp registration cancellatio response :9006

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 DD/MM/YYYY
Number of
withdrawls INT 8
Frequency type VARCHAR 20 Weekly / Monthly / Quarterly
Installment amount NUMERIC 25
Installment units NUMERIC 25
First order today VARCHAR 1 Y/N
End date VARCHAR 10 DD/MM/YYYY
Sub broker code VARCHAR 15
EUIN decleration VARCHAR 1 Y/N
EUIN number VARCHAR 7
Remarks VARCHAR 100
Sub broker - arn VARCHAR 20
Member ID CHAR 10
Login ID CHAR 25
Session CHAR 50
Swp registration Here the SwP registration will be given
CHAR
number 10 which has been generated by system
Branch code CHAR 10
Dealer ID CHAR 12
Last modified date CHAR 10 DD/MM/YYYY
Last modified time CHAR 8 HH:MM:SS
Reply code CHAR

BSE StAR-MF IML API Structures (Rev 1.6) 39

 System would send "success" in case of
transaction is successfully accepted on BSE
Message CHAR StAR MF.
IN CASE OF ERROR, THE SYSTEM WOULD
1000 RETURN THE ERROR MESSAGE
Filler 1 CHAR 20
Filler 2 CHAR 20
Filler 3 CHAR 20
Filler 4 CHAR 20

Total Message Length Should be 1517 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 40

STP REGISTRATION MESSAGE
STP Registration Field Field
Description
Request Type Length
stp registration request : 9010
transaction code varchar 4 stp request Modification Request:9013
stp registration cancellation: 9015
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 DD/MM/YYYY
frequency type varchar 20 Weekly / Monthly / Quarterly
no of transfers int 8
installment amount numeric 25
First order today varchar 1 Y/N
sub broker code varchar 15
EUIN decleration varchar 1 Y/N
EUIN number varchar 7
remarks varchar 100
SUB BROKER - ARN varchar 20
Member ID char 10
Login ID char 25
Session char 50
STP registration number char 10 In case of fresh SwP this field should contain 0.
Branch Code char 10
Dealer ID char 12
Last modified date char 10 DD/MM/YYYY
Last modified time char 8 HH:MM:SS
Filler 1 char 20
Filler 2 char 20
Filler 3 char 20
Filler 4 char 20

Total Message Length Should be 512 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 41

STP REGISTRATION RETURN MESSAGE

STP Registration
Response Message Field Type Field Length Description
transaction code varchar 4 stp registration request : 9011
stp request Modification Request:9014

STP registration cancellation: 9016

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 DD/MM/YYYY
start date date 10
frequency type varchar 20 Weekly / Monthly / Quarterly
no of transfers int 8
installment amount numeric 25
First order today varchar 1 Y/N
end date 10 DD/MM/YYYY
sub broker code varchar 15
EUIN decleration varchar 1 Y/N
EUIN number varchar 7
remarks varchar 100
SUB BROKER - ARN varchar 20
Member ID char 10
Login ID char 25
Session char 50
STP registration number char 10 In case of fresh SwP this field should
contain 0.
Branch Code char 10
Dealer ID char 12
Last modified date char 10 DD/MM/YYYY
Last modified time char 8 HH:MM:SS
Reply Code char

BSE StAR-MF IML API Structures (Rev 1.6) 42

 Message char 1000 System would send "success" in case of
transaction is successfully accepted on
BSE StAR MF.
IN CASE OF ERROR, THE SYSTEM
WOULD RETURN THE ERROR MESSAGE
Filler 1 char 20
Filler 2 char 20
Filler 3 char 20
Filler 4 char 20

Total Message Length Should be 1522 Characters

BSE StAR-MF IML API Structures (Rev 1.6) 43

HEARTBEAT MESSAGES

HEARTBEAT REQUEST

VALUES / MEANINGS /
FIELD DESCRIPTION TYPE DESCRIPTION
VALIDATIONS
TRANSACTION CODE CHAR(4) TYPE OF MESSAGE 1905
TAG CHAR(4) DEFAULT VALUE WILL BE HBRQ

HEARTBEAT RESPONSE

VALUES / MEANINGS /
FIELD DESCRIPTION TYPE DESCRIPTION
VALIDATIONS
TRANSACTION CODE CHAR(4) TYPE OF MESSAGE 1906
TAG CHAR(4) VALUE WILL BE HBRP

GENERAL

1. RECORD SEPARATOR WILL BE ~#~ FOR DELTA DOWNLOAD

2. ALL REQUESTS FOR IML SHOULD BE ENDED BY NEW LINE CHARACTER.

3. ALL RESPONSES FROM IML WOULD BE ENDED BY NEW LINE CHARACTER.

BSE StAR-MF IML API Structures (Rev 1.6) 44

REVISION HISTORY

SR. NO. DATE DESCRIPTION

1 DEC 29 2009 BASE VERSION
2 JAN 07 2010 REVISION 1
3 APR 15 2010 REVISION 1.1
4 JUL 06 2010 REVISION 1.2
5 MAR 29 2012 REVISION 1.3
6 AUG 20 2015 REVISION 1.4
7 JUL 29 2016 REVISION 1.5
8 Nov 19 2016 REVISION 1.6
9 Nov 11 2017 REVISION 1.7

Revision 1.7
Changes in Order Entry Logic

SIP ORDER Structure Change

SIP Order Entry Request

1.) END DATE Added in Filler 3

SIP Order Entry Response

1.) END DATE Added in Filler 3

Revision 1.6

Additional Formats added for

1.) STP REGISTRATION

2.) SWP REGISTRATION

Changes in Order Entry Logic

BSE StAR-MF IML API Structures (Rev 1.6) 45

ADD / MODIFY / CANCEL ORDER Structure Change

Normal Order Request

1.) Sub Broker ARN after Filler 3

a. Field Size of 20 Characters
2.) Filler 4 Added
a. Field Size of 20 Characters
3.) Filler 5 Added
a. Field Size of 20 Characters
4.) Filler 6 Added
a. Field Size of 20 Characters

Normal Order Response

1.) Sub Broker ARN after Filler 3

a. Field Size of 20 Characters
2.) Filler 4 Added
a. Field Size of 20 Characters
3.) Filler 5 Added
a. Field Size of 20 Characters
4.) Filler 6 Added
a. Field Size of 20 Characters

SIP ORDER Structure Change

SIP Order Entry Request

1.) Sub Broker ARN Added in Filler 2

SIP Order Entry Response

1.) Sub Broker ARN Added in Filler 2

XSIP / ISIP ORDER Structure Change

ISIP has been introduced as a part of the Existing XSIP Order Structure

XSIP/ISP Order Entry Request

1.) MANDATE ID changed to XSIP Mandate ID,

a. Validation : Either XSIP mandate ID or ISIP Mandate ID is required
2.) Sub Broker ARN Added in Filler 2,
3.) ISIP MANDATE ID Added in Filler 3,
a. Validation : Either XSIP mandate ID or ISIP Mandate ID is required

BSE StAR-MF IML API Structures (Rev 1.6) 46

XSIP/ISP Order Entry Request

1.) Sub Broker ARN Added in Filler 2,

2.) ISIP MANDATE ID Added in Filler 3,

SPREAD ORDER Structure Change

SPREAD Order Entry Request

1.) Sub Broker ARN Added in Filler 1

SPREAD Order Entry Response

1.) Sub Broker ARN Added in Filler 1

SWITCH ORDER Structure Change

SWITCH Order Entry Request

1.) Sub Broker ARN Added in Filler 1

SWITCH Order Entry Response

1.) Sub Broker ARN Added in Filler 1

BSE StAR-MF IML API Structures (Rev 1.6) 47

PAGE – INTENTIONALLY LEFT BLANK

BSE StAR-MF IML API Structures (Rev 1.6) 48