Get Cash Account

GET 
/cash-account

This is used to request information to manage the customers cash account.

Request

Query Parameters

cashAccountNumber stringrequired

Cash account number of the cash account which wants to get the details.

Example: C000131463

Responses

200

OK

*/*

Schema

Schema

status stringrequired
reason string
rejectCode integer

Find error codes here)

cashAccount object
cashAccountNumber string
accountType integer
Possible values: [0, 1, 2]
0 (Current) | 1 (Savings) | 2 (Investment)
currency string
balance integer
blockedAmount integer
odLimit string
Cash account trading limit
margin string
createdDate string
status string
Possible values: [2, 5]
2 (APPROVED) | 5 (DELETE)
pendingSettle integer
pendingWithdraw string
pendingDeposit string
profileId string
institutionCode string
unsettledTransfers number
pendingCharge number
manualBlock number
cashAccountId string
modifiedDate string
settlementType integer
Possible values: [0, 1, 2]
0 (DVP (default for MFS)) | 1 (Prefunded (default for DBFS)) | 2 (Non Settle)
marginDue integer
dayMarginDue integer
marginBlock integer
dayMarginBlock integer
mrgDayTrdEnabled integer
Possible values: [0, 1]
0 (false) | 1 (true)
secondaryTradingLimit integer
dailyOdLimit integer
primaryTradingLimitExpiry string
Cash account trading limit expiry date
secondaryTradingLimitExpiry string
dailyOdLimitEnabled integer
Possible values: [1, 0]
1 (true) | 0 (false)
cashAvailableForWithdraw integer
buyingPower integer
ibanNumber string
securityAccounts object[]
Array [
type string
secApprovalStatus integer
accountNumber string
securityAccountType integer
status string
statusId string
accountName string
currency string
exchangeAccounts object[]
Array [
exchange string
exchangeAccountNumber integer
exchangeAccountId integer
exchangeAccountType string
status string
tradingEnabled integer
custodian string
feedLevel integer
]
]

Example (from schema)

{
  "status": "string",
  "reason": "string",
  "rejectCode": 0,
  "cashAccount": {
    "cashAccountNumber": "string",
    "accountType": 0,
    "currency": "string",
    "balance": 0,
    "blockedAmount": 0,
    "odLimit": "string",
    "margin": "string",
    "createdDate": "string",
    "status": "2",
    "pendingSettle": 0,
    "pendingWithdraw": "string",
    "pendingDeposit": "string",
    "profileId": "string",
    "institutionCode": "string",
    "unsettledTransfers": 0,
    "pendingCharge": 0,
    "manualBlock": 0,
    "cashAccountId": "string",
    "modifiedDate": "string",
    "settlementType": 0,
    "marginDue": 0,
    "dayMarginDue": 0,
    "marginBlock": 0,
    "dayMarginBlock": 0,
    "mrgDayTrdEnabled": 0,
    "secondaryTradingLimit": 0,
    "dailyOdLimit": 0,
    "primaryTradingLimitExpiry": "string",
    "secondaryTradingLimitExpiry": "string",
    "dailyOdLimitEnabled": 1,
    "cashAvailableForWithdraw": 0,
    "buyingPower": 0,
    "ibanNumber": "string",
    "securityAccounts": [
      {
        "type": "string",
        "secApprovalStatus": 0,
        "accountNumber": "string",
        "securityAccountType": 0,
        "status": "string",
        "statusId": "string",
        "accountName": "string",
        "currency": "string",
        "exchangeAccounts": [
          {
            "exchange": "string",
            "exchangeAccountNumber": 0,
            "exchangeAccountId": 0,
            "exchangeAccountType": "string",
            "status": "string",
            "tradingEnabled": 0,
            "custodian": "string",
            "feedLevel": 0
          }
        ]
      }
    ]
  }
}

example

{
  "status": "SUCCESS",
  "reason": "Successfully retrieved cash account details",
  "cashAccount": {
    "cashAccountNumber": "C000301695",
    "accountType": 2,
    "currency": "USD",
    "balance": 100000000,
    "blockedAmount": -549045,
    "odLimit": "0.0",
    "margin": "0.0",
    "createdDate": "2023/08/03",
    "status": "2",
    "pendingSettle": 0,
    "pendingWithdraw": "-549045.0",
    "pendingDeposit": "0.0",
    "unsettledTransfers": 0,
    "marginDue": 0,
    "dayMarginDue": 0,
    "marginBlock": 0,
    "dayMarginBlock": 0,
    "secondaryTradingLimit": 0,
    "dailyOdLimit": 0,
    "dailyOdLimitEnabled": 0,
    "cashAvailableForWithdraw": 99450955,
    "buyingPower": 99450955,
    "securityAccounts": [
      {
        "type": "1",
        "accountNumber": "P000295555",
        "securityAccountType": 1,
        "status": "2",
        "statusId": "2",
        "accountName": "P000295555-USD",
        "secApprovalStatus": 0,
        "currency": "USD",
        "exchangeAccounts": [
          {
            "exchange": "MFSFUNDS",
            "exchangeAccountNumber": "1",
            "exchangeAccountId": 699844,
            "exchangeAccountType": "1",
            "status": "2",
            "tradingEnabled": 1,
            "custodian": "0",
            "feedLevel": 0
          }
        ]
      },
      {
        "type": "1",
        "accountNumber": "P000282896",
        "securityAccountType": 1,
        "status": "2",
        "statusId": "2",
        "accountName": "P000282896-USD",
        "secApprovalStatus": 0,
        "currency": "USD",
        "exchangeAccounts": [
          {
            "exchange": "MFSFUNDS",
            "exchangeAccountNumber": 123456,
            "exchangeAccountId": 699524,
            "exchangeAccountType": "1",
            "status": "2",
            "tradingEnabled": 1,
            "custodian": "0",
            "feedLevel": 0
          },
          {
            "exchange": "AMEX",
            "exchangeAccountNumber": 123456,
            "exchangeAccountId": 678849,
            "exchangeAccountType": "1",
            "status": "2",
            "tradingEnabled": 1,
            "custodian": "0",
            "feedLevel": 0
          },
          {
            "exchange": "BOND",
            "exchangeAccountNumber": 123456,
            "exchangeAccountId": 678845,
            "exchangeAccountType": "1",
            "status": "2",
            "tradingEnabled": 1,
            "custodian": "0",
            "feedLevel": 0
          },
          {
            "exchange": "OPRA",
            "exchangeAccountNumber": 123456,
            "exchangeAccountId": 678846,
            "exchangeAccountType": "1",
            "status": "2",
            "tradingEnabled": 1,
            "custodian": "0",
            "feedLevel": 0
          },
          {
            "exchange": "NSDQ",
            "exchangeAccountNumber": 123456,
            "exchangeAccountId": 678847,
            "exchangeAccountType": "1",
            "status": "2",
            "tradingEnabled": 1,
            "custodian": "0",
            "feedLevel": 0
          },
          {
            "exchange": "NYSE",
            "exchangeAccountNumber": 123456,
            "exchangeAccountId": 678848,
            "exchangeAccountType": "1",
            "status": "2",
            "tradingEnabled": 1,
            "custodian": "0",
            "feedLevel": 0
          }
        ]
      }
    ]
  }
}

Loading...