Integration Docs

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

Get Started

Transaction Errors

A transaction is initialised when a transactionId is passed to the triggerTransaction method on the client side SDK.
Transaction is complete when the user logs in with the broker account & confirms the intent
However if intent is not completed, SDK shares error message & code to identify the cause of failure

Here is a list of error messages that you can handle on your application and show relevant communication to the users -

Initialization Errors

Following errors appear while the client side SDK is being initialized on your application

Error message

Error code

Description

invalid_transactionId

n/a

transactionId passed to the sdk is incorrect

transaction_in_process

n/a

another transaction is in process, must wait for it to complete

invalid_gateway

n/a

gateway_name passed in the sdk initialization is invalid or not registered

invalid_jwt

n/a

JWT parameter for SDK initialization is invalid. Make sure the payload is as suggested & JWT is signed with valid shared secret

Once the SDK is setup, next step is to initiate a transaction using triggerTransaction method provided by the sdk. Below is a list of errors that you can expect as the failure response from triggerTransaction method -

Generic errors

Following errors are applicable to all intents of a transaction

Error message

Error code

Description

transaction_expired

3001

TransactionId passed in the triggerTransaction method is used or expired

transaction_expired

1005

Transaction session expired.
TransactionId is a short lived token & for one time use only. Either the user could not place the order within the session duration of 5min, or he tried refreshing the order window

User has restart the transaction again from partner platform

user_cancelled

1010

user has closed the broker chooser popup

user_cancelled

1011

user has closed the order journey after selecting the broker, but before successful login

api_error

2000

Something went wrong with our APIs/SDK. We do take note of these errors cautiously and look in to them on priority

user_mismatch

1001

For a connected user's session on Gateway, user is expected to login with the mapped broker account only.
If the user would login with another broker account, this error is returned

no_broker

1007

User could not find his broker in the available list & opted to signup for a new broking account

Order errors

These errors are applicable only when a user is placing orders (both SST & SMT) with the broker i.e. intent : TRANSACTION

Error message

Error code

Description

market_closed

4004

broker is not accepting orders

user_cancelled

1012

When the user completes broker login to view the order popup and abandons the order journey, this error is returned

insufficient_holdings

1004

When user wants to sell a stock he does not own, order can not be placed and user can only abandon the transaction journey

Holdings import error

While importing broker holdings via Gateway, a user consent is required before sharing the holdings data with the partner. In case user denies to give consent, consent_denied error is thrown

Error message

Error code

Description

consent_denied

1003

user denies consent for holdings import. This step comes once in user lifetime for all broker

If you find any case missing here or if you want to report any bug, drop us an email on [email protected]

Updated 2 months ago


Transaction Errors


Suggested Edits are limited on API Reference Pages

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