Introduced New APIs
Sharia Compliance API
This endpoint gives the Shariah compliant symbols for the given exchange.
Changes to existing APIs
path changes
Endpoints paths have been changed as followings,
API | Version 1.0 | Version 1.1 | Change |
---|---|---|---|
Get Token | auth/authentication/serverAuthToken | auth/token | Moved basic authentication to header. Previously it was supported even in body. Removed following deprecated fields - Removed accessTokenExpiresIn and refreshTokenExpiresIn from response. |
Token Refresh | auth/authentication/refreshSeverAuthToken | auth/token/refresh | Changed it to POST. Removed following deprecated fields. Removed accessTokenExpiresIn and refreshTokenExpiresIn from response. |
Get Customer Token | auth/customer/token | auth/token/refresh | Removed following deprecated fields. Removed accessTokenExpiresIn and refreshTokenExpiresIn from response. |
Customer Token Refresh | auth/authentication/refreshCustomerAuthToken | auth/customer/token/refresh | Changed it to POST. Removed following deprecated fields - same response. Removed accessTokenExpiresIn and refreshTokenExpiresIn from response. |
Validate Username | bo/customer/validateUserName | bo/customer/username/validate | no change other than path. |
Register Customer | bo/register-customer | bo/customer/register | no change other than path. |
Get Registration Status | bo/registration-status | bo/v1.1/customer/registration/status | no change other than path. |
Get Registration Requests | bo/registration-requests | bo/v1.1/customer/register /requests | no change other than path. |
Get Customer Details | bo/customer-account | bo/v1.1/customer/account | get customer details - in response externalRefNo > referenceNumber |
Create Customer | bo/customer-account | bo/v1.1/customer/account | no change other than path. |
Update Customer | bo/customer-account | bo/v1.1/customer/account | no change other than path. |
Place Order | fo/order/create | fo/v1.1/order/create | order path has been changed. This will return only orderReferenceId, status & reason. using get order details API, you can fetch orderId. expiryDate was added to the request as optional to be set for Tif Type 6 GTD Orders. |
Amend Order | fo/order/amend | fo/v1.1/order/create | order path has been changed. This will return only orderReferenceId, status & reason. using get order details API, you can fetch orderId.orderValue is added to request. |
Cancel Order | fo/order/cancel | fo/v1.1/order/create | order path has been changed. This will return only orderReferenceId, status & reason. using get order details API, you can fetch orderId. |
Get Commision & Vat | fo/commission & fo/vat | fo/v1.1/order/commission-vat | both commision and vat has been merged to one API. remove orderCategory & institutionCode as input and added securityType which use enums - CS, OPT, BND. Response gives both commission & vat. |
Get Order Details | fo/order/details | fo/v1.1/order | order path has been changed. orderRefereceId added to request. originalOrderReferenceId removed from response and added currency, settleCurrency, lastUpdatedDate, tif, price, expiryDate, accruedInterest to response. |
Order Search | fo/order/search | fo/v1.1/orders/search | changed it to GET.- pageNo and pageWidth not reuired as before. page no default 1, page width default and max = 100. clientOrderId removed from request. clientOrderId, orderReferenceId, originalClientOrderId, originalOrderReferenceId, orderNumber, cumulativeVatAmount, cumulativeStampDutyAmount are removed from response. |
Get Open Orders | fo/order/open-orders | fo/v1.1/orders/open | order path has been changed. clientOrderId is removed from request. clientOrderId, originalOrderReferenceId are removed from response. |
Get Customer Account List | bo/customer-account-list | bo/v1.1/customer/accounts | page no default - 1, pagewidth default and max - 100. |
Get Cash Account | bo/cash-account | bo/v1.1/customer/account/cash | no change other than path. |
Create Cash Account | bo/cash-account | bo/v1.1/customer/account/cash | no change other than path. |
Delete Cash Account | bo/cash-account | bo/v1.1/customer/account/cash | no change other than path. |
Update Cash Account | bo/cash-account | bo/v1.1/customer/account/cash | no change other than path. |
Get Security Account | bo/security-account | bo/v1.1/customer/account/security | no change other than path. |
Create Security Account | bo/security-account | bo/v1.1/customer/account/security | no change other than path |
Delete Security Account | bo/security-account | bo/v1.1/customer/account/security | no change other than path |
Update Security Account | bo/security-account | bo/security-account | bo/v1.1/customer/account/security |
Get Exchange Account | bo/exchange-account | bo/v1.1/customer/account/exchange | no change other than path. |
Create Exchange Account | bo/exchange-account | bo/v1.1/customer/account/exchange | no change other than path. |
Delete Exchange Account | bo/exchange-account | bo/v1.1/customer/account/exchange | no change other than path. |
Update Exchange Account | bo/exchange-account | bo/v1.1/customer/account/exchange | no change other than path. |
Enable Trading | bo/trading-enable | bo/v1.1/customer/account/exchange/trading-enable | no change other than path. |
Get Customer Bank Acc | bo/customer-bank-account | bo/v1.1/customer/account/bank | no change other than path. |
Create Customer Bank Acc | bo/customer-bank-account | bo/v1.1/customer/account/bank | no change other than path. |
Create Customer Bank Acc | bo/customer-bank-account | bo/v1.1/customer/account/bank | no change other than path. |
Update Customer Bank Acc | bo/customer-bank-account | bo/v1.1/customer/account/bank | no change other than path. |
Get Customer Bank Accounts | bo/customer-bank-account-list | bo/v1.1/customer/account/banks/account/banks/ | no change other than path. |
Get Feed Level Details | bo/feed-level | bo/v1.1/customer/account/exchange/feed-level | no change other than path. |
Feed Level Upgrade & Downgrade | bo/feed-level-change | bo/v1.1/customer/account/exchange/feed-level/change | no change other than path. |
Deposit | bo/deposit-request | bo/v1.1/finance/deposit | no change other than path. |
Withdraw | bo/withdraw-request | bo/v1.1/finance/withdraw | no change other than path. |
Deposit Withdraw Status | bo/deposit-withdraw-status | bo/v1.1/finance/deposit-withdraw/status | no change other than path. |
Get Account Summary | bo/cash-statement | fo/v1.1/customer/account/cash/summary | no change other than path. |
Get Positions | bo/deposit-withdraw-status | fo/v1.1/customer/account/security/summary | no change other than path. |
Get Cash Statement | bo/deposit-withdraw-status | bo/v1.1/statement/cash | no change other than path. |
Get Holding Statement | bo/holding-statement | bo/v1.1/statement/positions | no change other than path. |
Stock Transactions | bo/stock-trans-details | bo/v1.1/statement/positions | no change other than path. |
Cash | bo/ca/cash | bo/v1.1/statement/ca/cash | no change other than path. |
Positions | bo/ca/positions | bo/v1.1/statement/ca/positions | no change other than path. |
Get Institution Currency Rates | bo/currency-rates | bo/v1.1/master-data/currency-rates | no change other than path. |
Get Country List | bo/country-list | bo/v1.1/master-data/countries | no change other than path. |
Get Institutional Bank Accounts | bo/institution-bank-accounts | bo/v1.1/master-data/institution/bank-accounts | no change other than path. |
Get Support Trading Sessions | bo/support-trading-sessions | bo/v1.1/master-data/exchange/trading-sessions | no change other than path. |
Get Exchange TIF Types | bo/tif-types | bo/v1.1/master-data/exchange/tif-types | no change other than path. |
Get Exchange Order Types | bo/order-types | bo/v1.1/master-data/exchange/order-types | no change other than path. |
Get Exchange List | bo/exchange-list | bo/v1.1/master-data/institution/exchanges | no change other than path. |
Get Bank Branch Details | bo/bank-branch-list | bo/v1.1/master-data/bank/branches | no change other than path. |
Get Shariah Compliant Symbols | N/A | bo/v1.1/master-data/symbols/sharia | Introduction of New API to obtain Sharia complian symbols for a given institute. |