Get Account Summary

GET 
/account-summary

This is used to get an overview of the customer account, including both cash and holdings.

Request

Query Parameters

accountNumber stringrequired

Security account number

Example: P000128310

Responses

200

OK

application/json

Schema

Schema

status stringrequired

Possible values: [SUCCESS, FAILED]

reason string
rejectCode integer

Find error codes here)

accountNumber string

The security account number

currency string
balance number
blockedAmount number
odLimit number
buyingPower number
cashForWithdrawal number
lastUpdatedDate string
unsettledSales number
unrealizedGains number

Example (from schema)

{
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0,
  "accountNumber": "string",
  "currency": "string",
  "balance": 0,
  "blockedAmount": 0,
  "odLimit": 0,
  "buyingPower": 0,
  "cashForWithdrawal": 0,
  "lastUpdatedDate": "string",
  "unsettledSales": 0,
  "unrealizedGains": 0
}

example

{
  "status": "SUCCESS",
  "rejectCode": 0,
  "accountNumber": "P000128212",
  "currency": "AED",
  "balance": 200000,
  "blockedAmount": 0,
  "odLimit": 0,
  "buyingPower": 200000,
  "cashForWithdrawal": 200000,
  "lastUpdatedDate": "2022/12/12",
  "unsettledSales": 0,
  "unrealizedGains": 0
}

Loading...