Securities Transactions

Enable smooth buy and sale of one (or more) stocks, ETFs, InvITs & REITs on your platform 📲🛒💨

Enable seamless investment experience in buying and selling of securities (stocks, ETFs, InvITs & REITs), natively in your apps and website.

Supports:

  • single stock order: place order for single security 1️⃣
  • basket order: place order for multiple security (can be a mix of buy and sell) in one go 🧺

Also known as: single stock order / basket order / SST

How it works


Good to know

To continue, we recommend reading following sections of the Getting Started guide:


Sequence diagram


Integration details

Step 1: Create a transaction on your server-side

When a user intends to transact, a transactionId has to be created for the SDK interaction.
Hit the create stocks order transaction API from your server to get a unique transactionId by specifying order config.

Step 2: Integrate Gateway SDK on client-side

2.1 Initialise gateway session

Use a relevant guest / connected auth token to initialise the gateway session.

Learn more about initialising the gateway session in respective SDK integration page.

2.2 Pass transactionId to trigger transaction method

Next, pass the stock order transactionId (generated in step 1) to SDK's trigger transaction method. Gateway SDK will now show relevant screens (broker chooser, broker login, order confirmation, status, etc) to the user.

Step 3: Handle response on client- or server- side

Once the trigger transaction method resolves successfully, you can use any of these approaches to fetch order details -

3.1 From SDK Response (client-side)

Trigger transaction will respond with

  1. connected user auth tokenconnected user auth token - `smallcaseAuthToken` (JWT) containing `smallcaseAuthId` of the broker account with which transaction is (or, should be) performed. If such JWT is used to initialise Gateway session, SDK restricts user to allow transaction from related broker account only. Read more - https://developers.gateway.smallcase.com/discuss/61ef6d38d2a7c4000f6346be
    You can decode the JWT and get smallcaseAuthIdsmallcaseAuthId - It is an unique identifier for broker account with which user has logged in. Learn more - https://developers.gateway.smallcase.com/discuss/61ef6d38d2a7c4000f6346be of the linked broker account (on your server).
  2. order details
    This object states the status of the order and execution details (order type, avg. buy/sell price, quantity filled, etc) for each security.

or

3.2 Using webhook/postback (server-side)

Optionally, you can register a stocks order webhook for your gateway.
Once done, every time a user places an order on the client-side and [if at all] there's an update on open order (AMO, limit order), smallcase Gateway will hit your registered webhook with the user's order details, transactionId, smallcaseAuthId. The data can then be saved against the relevant users in your systems on every webhook hit.

In webhook hits, how can we identify the user for every order update received?

If you save transactionId(s) against each user account, you can use transactionId passed in webhook to determine the related user.

Alternatively, the create transaction API supports the notes mechanism. You can pass your unique user identifier as notes while creating transactionId, and you will further receive the same in webhook response, SDK response and orders API.

or

3.3 Using Gateway API (server-side)

Use Stocks order details API to fetch details about the order. This API will respond with order details.

Use Fetch transaction details API to get details about the transaction (status, any error returned on SDK itself). This API should be used to fetch & link smallcaseAuthIdsmallcaseAuthId - It is an unique identifier for broker account with which user has logged in. Learn more - https://developers.gateway.smallcase.com/discuss/61ef6d38d2a7c4000f6346be against the user account in your database.


Try order placement

Try it live

Response structure

Order details for securities orders can be consumed in three ways

  1. SDK response
    • where: client-side
    • when: user closes the Gateway SDK flow
    • structure: described below
  2. Webhook hits
    • where: server-side (push mechanism)
    • when: every time any user places an order, and when there is any update for open order
    • structure: described below (the batch object, orderBatches[0], is shared)
    • remark: most pragmatic way to listen for order execution updates in real-time
  3. API response
    • where: server-side (pull mechanism)
    • when: on need basis
    • structure: described below (the batch object, orderBatches[0], is shared)
response structure, explained

transactionId: [string] transaction identifier created from your server and passed to SDK

smallcaseAuthToken: [string] connected user auth tokenconnected user auth token - `smallcaseAuthToken` (JWT) containing `smallcaseAuthId` of the broker account with which transaction is (or, should be) performed. If such JWT is used to initialise Gateway session, SDK restricts user to allow transaction from related broker account only. Read more - https://developers.gateway.smallcase.com/discuss/61ef6d38d2a7c4000f6346be (contains smallcaseAuthIdsmallcaseAuthId - It is an unique identifier for broker account with which user has logged in. Learn more - https://developers.gateway.smallcase.com/discuss/61ef6d38d2a7c4000f6346be in payload)

broker: [string] broker key representing broker with which user transacted (eg: groww)

notes: [string] you can pass up to 256 characters in create transaction API for order tagging

`orderBatches` array [array of single batch object] a batch represents one or more securities that the user confirmed to transact

batchId: [string] unique ID for this batch of orders

variety: [string] type of order: regular for normal order, and amo for aftermarket order

quantity: [integer] count of securities part of this batch

filled: [integer] count of securities which got successfully executed

buyAmount: [decimal] total amount invested using this batch order to buy securities

sellAmount: [decimal] total amount gained using this batch order to buy securities

completedDate: [string] UTC timestamp when this batch finished its lifecycle

status: [string] batch-level order status. It is recommended to use orders[].status & unplaced[].status instead of this

batch-level status (enums)

Note: for securities orders, we recommend using individual stock level status key (orders[].status & unplaced[].status) instead of this batch-level status.

Transitionary status: `PLACED` all the orders are placed with the broker `PARTIALLYPLACED` some of the orders are placed with a broker

Final status:
COMPLETED all orders are successfully executed on the exchange
PARTIALLYFILLED some orders are successfully executed on the exchange
UNFILLED none of the orders was successfully executed on the exchange
UNPLACED none of the orders was placed on the broker's system
CANCELLED the open order (AMO / Limit) was cancelled by the user before execution
MARKEDCOMPLETE only some (or none) of the orders were successfully executed on the exchange
ERROR order is in error state

`orders` array [array of order object(s)] each order represents a security that was placed with broker

tradingsymbol: [string] NSE ticker/symbol of the security

transactionType: [string] BUY or SELL

orderType: [string] MARKET or LIMIT

status: [string] defines current status of the stock order (aka stock level status)

stock-level status (enums)

Transitionary status:
PLACED the order placed with broker

Final status:
COMPLETE the order executed successfully on the exchange
REJECTED the order was placed but rejected by the broker/exchange. A possible reason could be insufficient funds
CANCELLED the order was placed but cancelled by the broker/exchange. A possible reason could be low liquidity
CANCELLED AMO the order was placed as an AMO but was cancelled by the user before execution
ERROR the order couldn't be placed on broker's system

quantity: [integer] number of shares to trade

filledQuantity: [integer] number of shares traded on the exchange

averagePrice: [decimal] average price at which the order was executed (only for COMPLETE orders)

product: [string] CNC

exchange: [string] NSE

exchangeOrderId: [string] exchange generated order ID. orders that don't reach the exchange will not have ID

errorCode: [string] Represents the reason for the failure of an order. Set of possible codes mentioned in Order errors: placement and execution guide

statusMessage: [string] Textual description of the order's status. While it is a human-readable explanation at times, it can be gibberish at other times. We recommend not showing it to the user, and rather having it on your backend for support functions.

`unplaced` array [array of unplaced order object] each order represents a security that couldn't be placed with the broker due to some error

The object structure remains same as the orders array above.

unplaced[].status = ERROR always.

broker: [string] broker key representing broker with which user transacted (eg: groww)

transactionId: [string] transaction identifier created from your server and passed to SDK

notes: [string] you can pass up to 256 characters in create transaction API for order tagging

/* below keys are shared in webhook requests */

checksum: [string] used for webhook authentication; more details in webhooks guide

timestamp: [string] UTC timestamp at which the checksum was generated

smallcaseAuthId: [string] smallcaseAuthIdsmallcaseAuthId - It is an unique identifier for broker account with which user has logged in. Learn more - https://developers.gateway.smallcase.com/discuss/61ef6d38d2a7c4000f6346be


Notes

  • broker support: all smallcase integrated brokers (keys: aliceblue, angelbroking, axis, edelweiss, fivepaisa, groww, hdfc, icici, iifl, kite, kotak, motilal, trustline & upstox)
  • For securities transaction, we strongly recommend using stock-level status (orders[].status and unplaced[].status) over batch-level status
  • limit orders: users (5Paisa & Zerodha) can now place limit orders (Limit, SL, SLM). More here
  • ticker support: Valid NSE ticker for securities listed on NSE

FAQs

1. What is guest user flow vs connected user flow?

Consider guest user flow as a first-time user experience (FTUX):
When a user interacts with smallcase Gateway for the first time, you will not know their broker details (recall: smallcaseAuthIdsmallcaseAuthId - It is an unique identifier for broker account with which user has logged in. Learn more - https://developers.gateway.smallcase.com/discuss/61ef6d38d2a7c4000f6346be).

Hence you will -

  1. initialise gateway session in SDK with guest user auth tokenguest user auth token - JWT created with payload `{ "guest": true }`, and signed with the shared secret.
  2. trigger transaction with transactionId created in step 1

Now, SDK will ask users to choose their broker account from the set of available brokers.

On successful transaction completion, SDK shares connected user auth tokenconnected user auth token - `smallcaseAuthToken` (JWT) containing `smallcaseAuthId` of the broker account with which transaction is (or, should be) performed. If such JWT is used to initialise Gateway session, SDK restricts user to allow transaction from related broker account only. Read more - https://developers.gateway.smallcase.com/discuss/61ef6d38d2a7c4000f6346be in response.
You can save the smallcaseAuthId from the JWT, and use it in returning the user journey.

Connected user flow is for returning user experience (RTUX):
When the same user wants to interact with the gateway again, you can now initialise the gateway session with a connected user JWT.

This time, SDK will simply continue with the linked broker account. The user must login with the linked broker account to continue the transaction. This ensures that the same account is used for transactions, and investments are made on top of previous ones; from the same broker account.

Can we use guest user flow for FTUX & RTUX?
Yes, that's possible. SDK does not restrict the usage of guest flow in returning user journeys.

2. What is implementation difference for single stock and basket order?
  • one / more securities has to be passed in order config while creating transaction (discussed below)

  • one / more securities will be available in the transaction response

3. Can we have any UI customization for basket order?

Yes, we have support to configure name and logo of the basket created at your end.

You can pass these details in the create transaction API. Learn here

Custom basket name ("Smart Basket") and logo (the food basket image)Custom basket name ("Smart Basket") and logo (the food basket image)

Custom basket name ("Smart Basket") and logo (the food basket image)


Next steps

Check out relevant APIs required to create transactionId, fetch order details, and fetch transaction details.

We also have webhook/postback support for getting real-time order notifications.

Did this page help you?