API details

This API supports transactionId created for both CONNECTED as well as GUEST users.

In the case of a connected user, the transaction details for the given transactionId would be provided if the transactionId belongs to the connected user.

Supported `transactionId`

All transactionId created with either of these intents are supported - CONNECT, TRANSACTION, SUBSCRIPTION and HOLDINGS_IMPORT

Transaction statuses

Possible values of transactionDetails.status:

Transaction Status	Description
`INITIALIZED`	• Txn is not triggered OR • If txn has not expired yet: user has still not completed broker login OR • User closed your app/browser tab before broker login
`USED`	• If txn has not expired yet: user is still completing post broker login Gateway flow OR • User closed your app/broker tab after broker login and before completing the txn
`PROCESSING`	• Txn is under process (eg: AMO, limit orders in open state).
`ACTION_REQUIRED`	• smallcase order txn requires user to take some other action (eg: REPAIR) before they can continue with the intended order type (eg: REBALANCE).
`ERRORED`	• Gateway flow has ended with an error thrown to SDK. Use `transactionDetails.error` object in same response for details.
`COMPLETED`	• Txn is complete (eg: order placement, holdings import, smallcase subscription, etc). Note: For order transactions, this status means that Gateway has a final update on the order. Order can have failed/succeed/partially succeed. Further details in - • Stocks order details • smallcase order details • Fetch transaction details • smallcase Subscriptions

Transaction status description for `MF_HOLDINGS_IMPORT` intent

Possible values of transactionDetails.status:

Transaction Status	Description
`INITIALIZED`	This is the default status of the transactionId, when a transactionId is created for an intent, and it stays `INITIALIZED` till • Txn is not triggered OR • If txn has not expired yet • User exited the flow on app/ browser before OTP was triggered
`USED`	For SDK based integration • Transaction is marked as `USED`, once it has been triggered with `triggerMfTransaction` method For API based integration • Transaction is marked as `USED`, when otp is generated by using `/getOtp` API
`PROCESSING`	Once the OTP verification is done, the transactionId status changes into `PROCESSING` status It denotes that holdings are being fetched currently
`ERRORED`	For SDK • status turns to `ERRORED` when Gateway flow has ended with an error thrown to SDK. Possible scenarios - user drops off before otp verification. • Use `transactionDetails.error` object in the same response for details on the error. For API based int. • If in case the transaction has turned into an error post OTP verification while sharing the webhooks, then it’ll be marked `ERRORED` • Use `transactionDetails.error` object in the same response for details on the error.
`COMPLETED`	Once a webhook has been shared successfully, then the transaction lifecycle is finished and that’s when transactionId is marked `COMPLETED`

Request parameters