Get Account Summary

GET 
/v1.1/customer/account/cash/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

round to 5 decimal points.

blockedAmount number

round to 5 decimal points.

odLimit number

round to 5 decimal points.

buyingPower number

round to 5 decimal points.

cashForWithdrawal number

round to 5 decimal points.

lastUpdatedDate string
unsettledSales number

round to 5 decimal points.

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
}

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.1/customer/account/cash/summary",
  "rejectCode": "1008"
}

Expired Token

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

Loading...