Get Cash Account

GET 
/v1.2/customer/account/cash

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

Header Parameters

Throttle-Key string

Responses

200

OK

*/*

Schema

Schema

status string
reason string
rejectCode integer

Find error codes here

cashAccount object
cashAccountNumber string
currency string
balance number
blockedAmount number
odLimit string
margin string
createdDate string
status string
pendingSettle integer
pendingWithdraw string
pendingDeposit string
unsettledTransfers integer
marginDue integer
dayMarginDue integer
marginBlock integer
dayMarginBlock integer
secondaryTradingLimit integer
dailyOdLimit integer
dailyOdLimitEnabled integer
cashAvailableForWithdraw number
buyingPower number
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",
    "currency": "string",
    "balance": 0,
    "blockedAmount": 0,
    "odLimit": "string",
    "margin": "string",
    "createdDate": "string",
    "status": "string",
    "pendingSettle": 0,
    "pendingWithdraw": "string",
    "pendingDeposit": "string",
    "unsettledTransfers": 0,
    "marginDue": 0,
    "dayMarginDue": 0,
    "marginBlock": 0,
    "dayMarginBlock": 0,
    "secondaryTradingLimit": 0,
    "dailyOdLimit": 0,
    "dailyOdLimitEnabled": 0,
    "cashAvailableForWithdraw": 0,
    "buyingPower": 0,
    "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
          }
        ]
      }
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.2/customer/account/cash",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.2/customer/account/cash",
  "rejectCode": "1007"
}

Loading...