Update Cash Account

PATCH 
/cash-account

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

This is used to update already created cash accounts.

Request

application/json

Body

required

cashAccountNumber stringrequired

Cash Account Number

currency string

Currency

Responses

200

OK

*/*

Schema

Schema

status stringrequired

Possible values: [SUCCESS, FAILED]

rejectCode number

Find error codes here)

reason stringnullable
cashAccountNumber stringrequired
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
margin string
createdDate string
status string
pendingSettle integer
pendingWithdraw string
pendingDeposit string
profileId stringnullable
institutionCode stringnullable
unsettledTransfers numbernullable
pendingCharge numbernullable
manualBlock numbernullable
cashAccountId stringnullable
modifiedDate stringnullable
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 stringnullable
secondaryTradingLimitExpiry stringnullable
dailyOdLimitEnabled integer
Possible values: [0, 1]
0 (false) | 1 (true)
cashAvailableForWithdraw integer
buyingPower integer
ibanNumber stringnullable
securityAccounts object[]

Example (from schema)

{
  "status": "SUCCESS",
  "rejectCode": 0,
  "reason": "string",
  "cashAccountNumber": "string",
  "cashAccount": {
    "cashAccountNumber": "string",
    "accountType": 0,
    "currency": "string",
    "balance": 0,
    "blockedAmount": 0,
    "odLimit": "string",
    "margin": "string",
    "createdDate": "string",
    "status": "string",
    "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": 0,
    "cashAvailableForWithdraw": 0,
    "buyingPower": 0,
    "ibanNumber": "string",
    "securityAccounts": [
      {}
    ]
  }
}

example

{
  "status": "SUCCESS",
  "reason": null,
  "rejectCode": 0,
  "cashAccountNumber": "C00000000",
  "cashAccount": {
    "cashAccountNumber": "C00000000",
    "accountType": 1,
    "currency": "USD",
    "balance": 0,
    "blockedAmount": 0,
    "odLimit": "0.0",
    "margin": "0.0",
    "createdDate": "2022/12/14",
    "status": "2",
    "pendingSettle": 0,
    "pendingWithdraw": "0.0",
    "pendingDeposit": "0.0",
    "profileId": null,
    "institutionCode": null,
    "unsettledTransfers": null,
    "pendingCharge": null,
    "manualBlock": null,
    "cashAccountId": null,
    "modifiedDate": null,
    "settlementType": 0,
    "marginDue": 0,
    "dayMarginDue": 0,
    "marginBlock": 0,
    "dayMarginBlock": 0,
    "mrgDayTrdEnabled": 0,
    "secondaryTradingLimit": 0,
    "dailyOdLimit": 0,
    "primaryTradingLimitExpiry": null,
    "secondaryTradingLimitExpiry": null,
    "dailyOdLimitEnabled": 0,
    "cashAvailableForWithdraw": 0,
    "buyingPower": 0,
    "ibanNumber": null,
    "securityAccounts": []
  }
}

Update Request with Invalid Currency

{
  "status": "FAILED",
  "reason": "Invalid Currency",
  "rejectCode": 1001
}

Loading...