smallcase Subscriptions via Gateway

User can subscribe to fee-based smallcases via smallcase Gateway. The dedicated subscription widget will help user in subscribing to the smallcase, natively inside your app / website.

Users can subscribe to smallcase by following these steps:

1. enter personal details
2. complete risk profiling (optional; not for all smallcases)
3. select subscription plan of their choice
4. confirm agreement (optional; not for all smallcases)
5. pay subscription fees

Eligibility for triggering the subscription flow:

1. smallcase is fee-based (i.e. it has AuM / flat fee plan)
2. user does not have an active subscription in the smallcase (data available in subscriptions details API)
   • user never subscribed to a smallcase (status ≠ SUBSCRIBED)
   • user's subscription is in grace period (status=SUBSCRIBED AND cancellation.value=true)
   • user's subscription has ended (status=UNSUBSCRIBED)

Transactional intents that can trigger subscription flow:

1. intent: TRANSACTION

One of the use-case for this intent is to transact in smallcase (eg - BUY a smallcase).

When a transaction is triggered for a fee-based smallcase, Gateway will internally check for user's subscription status in the smallcase. And if the user is not subscribed, the subscription widget will be automatically shown to the user.

And once user subscribes to the smallcase, they will then continue placing their original order (eg - buying smallcase).

And for subsequent time, if user is already subscribed, normal transaction flow will continue as-is.

📘

For backward compatibility, there is no change in API request and client-side response.

Only on successful order placement, the success response would be shared. Otherwise, the error response will be shared.

2. intent: SUBSCRIPTION

For transactions created with intent: SUBSCRIPTION (exact payload for create transaction API is shared below), a dedicated subscription widget flow will open up.

And on a successful subscription, the transaction will get completed, and the program control will be handed back to the partner.

👉 create transaction API

The API is same as the existing create transaction API. Only request payload is different -

{
    intent: "SUBSCRIPTION",
    config: {
        // either scid or iscid is required
        scid: "GATEMO_0001",
        // If iscid is passed, use connected users auth token in req. header
        iscid: "5f58be2e0ae6715aef0d1518"
    }
}

🚧

The API returns "Invalid Order" for:

1. free smallcase's scid (since they cannot be subscribed)
2. connected user is already subscribed to the smallcase

Note: If transaction is created with guest auth token, and if user's subscription status comes up as subscribed post-broker login, gateway SDK will return already_subscribed error.

👉 SDK Response

For SUBSCRIPTION intent, following order response is shared in case of successful subscription

{
    "smallcaseAuthToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFsbGNhc2VBdXRoSWQiOiI2MTU0MmMwMmVhOWFiMGYyNDc3YzY2NTAiLCJpYXQiOjE2MzI5MDYzNDMsImV4cCI6MTYzMjkwOTk0M30.-C415ww3GKIiPu3xAKA4F3zyq1CRDomIns5wa7_uLi4",
    "broker": "kite",
    "transactionId": "TRX_224c856f81094911931a516e24500022"
}

• smallcaseAuthId of the user can be retrieved by verifying & decoding smallcaseAuthToken.
• the same can then be used to track user's subscription as mentioned below.

Tracking user subscriptions

Gateway's user subscription API can be used to track for subscription status. The API will return subscription status against smallcases they have interacted with subscription flow for.

User can be any of these four subscription states -

1. In middle of subscription process - user has not yet completed smallcase subscription process
2. Active subscription
3. In grace period (subscription about to end)
4. Subscription ended

Sample response for each state can be found in same api reference.

FAQs