Integration Docs

Comprehensive guide and documentation to help you start working with smallcase Gateway

Get Started

Order journey

Below is a high-level representation of the orderflow

users confirms order -> a transaction is created & transactionId passed to client side sdk -> user prompt to select broker -> login with trading account -> review stock orders -> funds & holdings check -> stock orders sent to broker -> broker returns executed order

Create transaction

Every time your user clicks the Invest button, use the Gateway API to create an transactionId from your server
A transactionId can be created for following intents -

  • TRANSACTION
    stock/ETF & smallcase order
  • HOLDINGS_IMPORT
    Fetch user's stock portfolio

Check Create Transaction API

Trigger transaction flow

A triggerTransaction method is available on all client sdks
It accepts two parameters -

  • transactionId - Eg: TRX_652377470a134a80ac6c56d19ef3416c
  • brokers - array of supported brokers, user 'aliceblue', 'axis', 'edel', 'fivepaisa', 'hdfc', 'iifl', 'kite', 'trustline'

Transaction response

A transaction can be completed after orders are sent to broker. If can be placed, executed or cancelled by the broker, we share order response on webhook provided by you and as response to triggerTransaction method
Check Transaction Response

Alternatively, if the transaction fails (Eg: user abandons, session expiry etc), error data is shared
Check Transaction Errors

Updated 2 months ago

Order journey


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.