Investment

Select the following:
Home

>

API Products

>

Hong Kong - Investment API Documentation

Investment

Summary

This API is used to request the list of questions to be displayed for risk profile and the financial information. If the customer has already updated his/her risk profile, this API will return the customer's response and risk rating.

Want to try this API out on our Playground?

Go play now
Endpoints on this page
get /v1/investments/products/brokerage/{accountId}/equity/orders Retrieve Brokerage Orders
delete /v1/investments/products/brokerage/{accountId}/equity/orders Delete Brokerage Order
get /v1/investments/products/brokerage/{accountId}/equity/orders/{orderReferenceNumber}/modifications Retrieve Brokerage Order Modification History
get /v1/investments/products/brokerage/equity/cashAccounts Retrieve Brokerage and Settlement Accounts
put /v1/investments/products/brokerage/equity/orders Confirm Brokerage Order Modification
post /v1/investments/products/brokerage/equity/orders Confirm Brokerage Order
put /v1/investments/products/brokerage/{accountId}/equity/orders/preprocess Modify Brokerage Order
post /v1/investments/products/brokerage/{accountId}/equity/orders/preprocess Preprocess Brokerage Order
get /v1/investments/products/brokerage/equity/holdings/miniDetails Brokerage Holdings Inquiry
post /v1/investments/mutualFunds/accounts This API is used to open an MF account. This API also checks the mutualfundOpening eligibility.
get /v1/investments/mutualFunds/eligibility/accounts This API is used to check Mutual Fund Account Opening Eligibility for the relationship. If eligible, this API will return the savings or checking or call deposits accounts for the relationship number.
get /v1/investments/mutualFunds/relationshipsAndAccounts This API is used to inquire the list of relationships of a customer along with the MutualFund Account,if any.
get /v1/investments/products/mutualFunds/{accountId}/cashaccounts To get the list of settlement sccounts for Mutual Fund Account of a Customer.
get /v1/investments/mutualFunds/pricingDetails This API is used to inquire the pricing details of the MutualFund.
get /v1/investments/mutualFunds/details This API is to Retrieves the details of the MF based on a MF fundCode or ISIN Number
post /v1/investments/mutualFunds/productSearch This API retrieves the MF Fund List
get /v1/investments/mutualFunds/{accountId}/settlementAccounts This API is used to inquire the list of settlement accounts for Mutual Fund.
post /v1/investments/mutualFunds/orders/confirmation This API is used to do the pre-process mutual fund order (One-time buy and Regular Subscriptions Plan)
post /v1/investments/mutualFunds/orders/preprocess This API is used to place mutual fund order.
get /v1/investments/mutualFunds/orders/eligibility This API is used to inquire the eligibility of a customer to place order for mutual fund product.
get /v1/markets/customers/fx/rates/{baseCurrencyCode} To get FX Rates against the base currency
get /v1/investments/products/brokerage/cashaccounts This API provides the list of settlement accounts for Equities
put /v1/customerWorkbench/wealthDashboard/favouriteStatus This API is used to update the favourite status of content in InvestCloud Partner.
get /v1/customerWorkbench/wealthDashboard/financialReadinessLevel This API is used to retrieve the customer’s financial readiness level and related information from InvestCloud.
post /v1/consumerInvestments/fxOrderWatch/buySell/preprocess This method will perform the transaction. It will give summary of transaction as output
post /v1/consumerInvestments/fxOrderWatch/buySell This method will perform the transaction. It will give summary of transaction as output
post /v1/consumerInvestments/fxOrders/buySell/preprocess This method will perform the transaction. It will give summary of transaction as output
post /v1/consumerInvestments/fxOrders/buySell This method will perform the transaction. It will give summary of transaction as output
put /v1/consumerInvestments/fxOrderWatch/delete This method will cancel a future Order Details.
post /v1/informationProviderOperation/fxRates This API is used to get fxrates from URS for the requested ccypair and variance % values.
post /v1/investments/mutualFunds/portfolio/orders/preprocess This API is used to place mutual fund order for portfolio (onetime buy and RSP).
post /v1/investments/mutualFunds/portfolio/orders/confirmation This API is used to do the pre-process mutual fund order (Onetime buy and Regular Subscriptions Plan)

Retrieve Brokerage Orders

get /v1/investments/products/brokerage/{accountId}/equity/orders
Description

This API returns the list of all the brokerage orders placed by a customer.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Path Parameters
accountId
string required
Account identifier in encrypted format.Typically, this is not displayed to the customer.
Query Parameters
stockMarket
string Optional
Name of the stock market.This is a reference data field. Please use /v1/apac/utilities/referenceData/{stockMarket} resource to get valid values of this field with descriptions. You can use stockMarket as referenceCode parameter to retrieve the values.
orderReferenceNumber
string Optional
Unique number to identify a stock order.
securitiesBrokerageOrderStatus
string Optional
Indicates the current status of the order. This is a reference data field. Please use /v1/apac/utilities/referenceData/{securitiesBrokerageOrderStatus} resource to get possible values of This field with descriptions. You can use the field name as the referenceCode parameter to retrieve the values.
orderFromDate
string Optional
Order start date in YYYY-MM-DD format value conforming to ISO 8601
{
    "format": "date"
}
orderToDate
string Optional
Order end date in YYYY-MM-DD format value conforming to ISO 8601
{
    "format": "date"
}
stockCode
string Optional
Unique code assigned to a security for trading purposes.
securityBrokerageTradeType
string Optional
Indicates whether the transaction is a buy or sell.This is a reference data field. Please use /utilities/referenceData/{securityBrokerageTradeType} resource to get valid values of this field with descriptions.
nextStartIndex
string Optional
In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • stockOrderList
      • tradeOrder
        • properties : Array
  • nextStartIndex
    • The next start index that indicates the next set of records to be fetched, if there are available. Typically, this value should be populated if the first response has the value of nextStartIndex
    • type : string
Example Response for get /v1/investments/products/brokerage/{accountId}/equity/orders
204

No content
This operation returns no content.
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidMarketMarket passed in Request is invalid
errorinvalidOrderStatusOrder status passed in Request is invalid
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
422

TypeCodeDetails
errorbusinessValidationsFailedBusiness validations failed
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
500

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Delete Brokerage Order

delete /v1/investments/products/brokerage/{accountId}/equity/orders
Description

This API deletes an existing brokerage order.Post successful order deletion, an acknowledgement is sent to the customer.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Content-Type
string required
application/json
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Path Parameters
accountId
string required
Stock account identifier in encrypted format.Typically, this is not displayed to the customer.
Query Parameters
orderReferenceNumber
string required
Unique reference number created by the partner on successful order creation
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
This operation returns no content.
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
422

errorbusinessValidationsFailedBusiness validations failed
errorsettlementAccountSuspendedSettlement account is suspended
errorinvalidGoodTillDateThe selected order expiry date is out of our acceptable date range
errortradeOrderFailedTrade order failed
errorinvalidTradingSessionTrading session is invalid
errorinvalidStockCodeStock code is invalid
errorinvalidOrderTypeOrder type is invalid
errorinsufficientFundInsufficient fund
errorinsufficientStockHoldingsInsufficient Stock holdings to sell
errorusStockMarketSuspendedUS stock market suspended.Place Normal Order
errorinvalidOrderQuantityOrder quantity is invalid
errorriskProfileExpiredRisk profile has expired
errortransactionAmountBelowLimitTransaction amount below minimum amount
errorwashTradeOrderPotential wash trade order has been restricted
errorjointRelationshipConsentRequiredConsent is required to purchase using joint relationship account
errorchinaCustomerConsentRequiredChina Customer consent is in progress or not available and the order can not be processed till that is completed
errormarginCallIssuedOrder not precessed as the margin call was issued
erroraggregateQuotaExceededDaily aggregate quota has been exceeded or dropped to 0
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
500

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for delete /v1/investments/products/brokerage/{accountId}/equity/orders
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Retrieve Brokerage Order Modification History

get /v1/investments/products/brokerage/{accountId}/equity/orders/{orderReferenceNumber}/modifications
Description

This API returns the details of all the order modifications for a particular brokerage order placed by the customer.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Path Parameters
accountId
string required
Stock account identifier in encrypted format.Typically, this is not displayed to the customer.
orderReferenceNumber
string required
Unique reference number created by the partner on successful order creation.
Query Parameters
nextStartIndex
string Optional
The next start index that indicates the next set of records to be fetched, if there are available. Typically, this value should be populated if the first response has the value of nextStartIndex.It is not applicable for the first iteration.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • securityBrokerageEquityOrderModifications
      • stockCode
        • type : string
        • Unique code associated with security.
      • securityCurrencyCode
        • security currency code in ISO 4217 Format.
        • type : string
      • orderModificationTimeStamp
        • Order modification time stamp in ISO8601 format YYYY-MM-DD'T'HH:mm:ssZ
        • type : string
        • format : dateTime
      • originalPriceAmount
        • It is the original price amount of the order.
        • type : number
        • format : double
      • revisedPriceAmount
        • It is the revised price amount of the order.
        • type : number
        • format : double
      • originalUnitCount
        • It is the original number of units placed by customer.
        • type : number
        • format : integer
      • revisedUnitCount
        • It is the revised number of units placed by customer.
        • type : number
        • format : integer
      • orderModificationStatus
        • 'It is the status of the SB order modification. This is a reference data field. Please use /v1/utilities/referenceData/{orderModificationStatus} resource to get valid value of this field with description.
        • type : string
  • nextStartIndex
    • type : string
    • The next start index that indicates the next set of records to be fetched, if there are available. Typically, this value should be populated if the first response has the value of nextStartIndex.
Example Response for get /v1/investments/products/brokerage/{accountId}/equity/orders/{orderReferenceNumber}/modifications
204

No content
This operation returns no content.
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders/{orderReferenceNumber}/modifications
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders/{orderReferenceNumber}/modifications
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders/{orderReferenceNumber}/modifications
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
422

TypeCodeDetails
errorbusinessValidationsFailedBusiness validations failed
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders/{orderReferenceNumber}/modifications
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
500

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/investments/products/brokerage/{accountId}/equity/orders/{orderReferenceNumber}/modifications
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Retrieve Brokerage and Settlement Accounts

get /v1/investments/products/brokerage/equity/cashAccounts
Description

This API returns the list of all brokerage accounts and the corresponding settlement accounts held by the customer for each stock market

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Query Parameters
nextStartIndex
string Optional
The next start index that indicates the next set of records to be fetched, if there are available. Typically, this value should be populated if the first response has the value of nextStartIndex.
stockMarket
string Optional
Name of the stock market.This a reference data field. Please use /utilities/referenceData/{stockMarket} resource to get valid values of this field with descriptions.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

TypeCodeDetails
successsuccessfulSuccess
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : error, warn, invalid, fatal
    • type : string
  • code
    • Error code which qualifies the error
    • type : string