Developers / Tools & Resources
Order
This module consists of APIs that offer functionalities for both asset management and brokerage. Click here to view all APIs in this module.
Brokerage(Securities)
This API sends an order via a suitable adapter to the exchange (e.g. NSE, NASD, USE, etc) configured with your business in Zanibal. The payload in the Submit trade order API is similar to that of the API used to update a trade order. The difference is that it uses the PUT http method.
#Sample cURL command
curl -X 'POST' \
'https://zas-dev.zanibal.com/api/v1/order/tradeorder/submit' \
-H 'accept: application/json; charset=UTF-8' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"name": "string",
"label": "string",
"instrumentType": "string",
"description": "string",
"orderBase": "string",
"fixMessage": "string",
"systemGenerated": true,
"exchange": "string",
"securityName": "string",
"securityLabel": "string",
"customerName": "string",
"customerLabel": "string",
"portfolioName": "string",
"portfolioLabel": "string",
"orderType": "string",
"priceType": "string",
"orderStartDate": "timestamp",
"orderEndDate": "timestamp",
"referenceOrderId": 0,
"settlementInstructions": "string",
"commissionGroupName": "string",
"orderDate": "timestamp",
"orderOrigin": "string",
"quantityRequested": "string",
"businessOffice": "string",
"instrument": "string",
"orderCurrency": "string",
"limitPrice": 0,
"stopPrice": 0,
"orderTermName": "string",
"custodianName": "string",
"agentName": "string",
"orderTermLabel": "string",
"quantityFilled": "string",
"quantityPending": "string",
"orderStatus": "string",
"fixOrderStatus": "string",
"statusDate": "timestamp",
"locked": "string",
"orderTotal": 0,
"orderValue": 0,
}'
This returns a list of contract notes for a specific date range and page size specified by you.
| Parameter | Data type | Description | Required |
|---|---|---|---|
| sd | Date | start date in yyyy-MM-dd format | Yes |
| ed | Date | end date in yyyy-MM-dd format | Yes |
| x | String | Exchange code i.e. NSE for Nigeria, NSE. for Kenya, SA_4AX for South Africa ... | Yes |
| t | String | Security type i.e BOND "BOND_NAT" or EQUITY (also asset class) | Yes |
| b | Long | Page number | Yes |
| c | Long | Page size | Yes |
| s | String | Order status. This can be any of REJECTED, BOOKED, CANCELLED, EXECUTING, EXECUTED or EXPIRED | Yes |
Asset Management
Submit Term Instrument Transaction
This API submits a term instrument(fixed deposit) transaction. It is similar to that of the API used to update and post a term instrument transaction. The difference is that it used the PUT and POST HTTP methods respectively. The same also goes for T-bill and Fund transactions.
#Sample cURL command
curl -X 'POST' \
'https://zas-dev.zanibal.com/api/v1/order/terminstrument/submit' \
-H 'accept: application/json; charset=UTF-8' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"name": "string",
"label": "string",
"instrumentTypeName": "string",
"instrumentTypeLabel": "string",
"initAccountId": 0,
"terminationAccountId": 0,
"customerId": 0,
"customerName": "string",
"customerLabel": "string",
"portfolioName": "string",
"portfolioLabel": "string",
"startDate": "timestamp",
"tenure": 0,
"expectedMaturity": "timestamp",
"terminationDate": "timestamp",
"currency": "string",
"faceValue": 0,
"expectedInterest": 0,
"expectedNetInterest": 0,
"accruedInterest": 0,
"accruedNetInterest": 0,
"currentRate": 0,
"rolloverAmount": 0,
"autoRollover": true,
"loanProduct": true,
"rolloverRule": "string",
"status": "string",
"rolledOver": true,
"parentId": 0,
}'
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.
| Parameter | Data Type | Description | Required |
|---|---|---|---|
| id | Long | Transaction ID | Yes |
| c | Long | customerId | Yes |
| b | Long | Page number | No |
| s | Long | Page size | No |
| u | String | Transaction status. This can either be PENDING, RUNNING or TERMINATED | No |
| sd | Date | Start date in yyyy-MM-dd format | No |
| ed | Date | End date in yyyy-MM-dd format. | No |
| t | Long | Term instrument transaction id | Yes |
| d | Date | Term instrument transaction date | Yes |
Submit Discounted Instrument Transaction
#Sample cURL command
curl -X 'POST' \
'https://zas-dev.zanibal.com/api/v1/order/terminstrument/submit' \
-H 'accept: application/json; charset=UTF-8' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"name": "string",
"label": "string",
"instrumentTypeName": "string",
"instrumentTypeLabel": "string",
"initAccountId": 0,
"terminationAccountId": 0,
"customerId": 0,
"customerName": "string",
"customerLabel": "string",
"portfolioName": "string",
"portfolioLabel": "string",
"startDate": "timestamp",
"tenure": 0,
"expectedMaturity": "timestamp",
"terminationDate": "timestamp",
"currency": "string",
"faceValue": 0,
"expectedInterest": 0,
"expectedNetInterest": 0,
"accruedInterest": 0,
"accruedNetInterest": 0,
"currentRate": 0,
"rolloverAmount": 0,
"autoRollover": true,
"loanProduct": true,
"rolloverRule": "string",
"status": "string",
"rolledOver": true,
"parentId": 0,
}'
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.
| Parameter | Data type | Description | Required |
|---|---|---|---|
| id | Long | Discounted instrument transaction id | Yes |
| dc | String | Notes/Description | No |
| fv | Double | Termination amount. If null/empty, system will default to the entire face value amount. Eg if you have a 200,000 running investment and you want to partially terminate only 100,000 you should pass in 100,000 as this parameter else system would terminate entire 200,000. | No |
| dr | Long | Discount rate. If not specified, the system will use the discount rate of the running investment. However if you want to use a different discount rate you will have to pass it in using this parameter. Eg. if you have a 15% bill and you want to sell it at a higher rate of say 17%, then you will have to pass in 17 as this value. | No |
| td | Date | Termination date. if not specified the system will use the current date. The date should be specified in the "yyyy-MM-dd” format. | No |
| c | Long | customerId | Yes |
| b | String | Page number | No |
| s | String | Page size | No |
| e | String | Transaction status. This can either be PENDING, RUNNING or TERMINATED | No |
| sd | Date | start date in yyyy-MM-dd format | No |
| ed | Date | end date in yyyy-MM-dd format | No |
#Sample cURL command
curl -X 'POST' \
'https://zas-dev.zanibal.com/api/v1/order/terminstrument/submit' \
-H 'accept: application/json; charset=UTF-8' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"name": "string",
"label": "string",
"instrumentTypeName": "string",
"instrumentTypeLabel": "string",
"initAccountId": 0,
"terminationAccountId": 0,
"customerId": 0,
"customerName": "string",
"customerLabel": "string",
"portfolioName": "string",
"portfolioLabel": "string",
"startDate": "timestamp",
"tenure": 0,
"expectedMaturity": "timestamp",
"terminationDate": "timestamp",
"currency": "string",
"faceValue": 0,
"expectedInterest": 0,
"expectedNetInterest": 0,
"accruedInterest": 0,
"accruedNetInterest": 0,
"currentRate": 0,
"rolloverAmount": 0,
"autoRollover": true,
"loanProduct": true,
"rolloverRule": "string",
"status": "string",
"rolledOver": true,
"parentId": 0,
}'
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.
You can Click edit/delete button to change this text. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.With thousands of Flash Components, Files and Templates, Star & Shield is the largest library of stock Flash online. Starting at just $2 and by a huge community.