Skip to main content
GET
Sub account information

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

custodyCode
string
required

Custody account number, e.g. 105C334455.

Query Parameters

fields
string
required

List of information to get, e.g. basicInfo,bankSubAccounts.

Response

200 - application/json

Successful response

basicInfo
object

Basic account information.

bankSubAccounts
object[]

List of sub-accounts.

bankSubAccounts[].accountNo
string

Sub-account number.

bankSubAccounts[].accountName
string

Account holder name.

bankSubAccounts[].bankCode
string

Bank code (may be null).

bankSubAccounts[].accountType
string

Sub-account type: NORMAL, MARGIN, DERIVATIVE.

bankSubAccounts[].accountTypeName
string

Sub-account type name.

bankSubAccounts[].status
string

Sub-account status.

bankSubAccounts[].isDefault
string

Whether this is the default sub-account (Y/N).