getCustodyBalances

POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getCustodyBalances

This method is used to get the Cash, Securities, and Total account values of a custody account.

Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	TransactAPI Client ID
developerAPIKey	yes	string	TransactAPI Developer Key
accountId	yes	string	Account ID that is generated by the API once an account is created (createAccount)

Sample Request

cURL

curl -k -X POST https://tapi-sandboxdash.norcapsecurities.com/getCustodyBalances
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d accountId=accountId

Response Parameters

Parameter	Type	Description
statusCode	string	API Status Code
statusDesc	string	API Status Description
custodyBalances	object	Custody account balances and intents

custodyBalances	Type	Description
accountID	string	Account the request is being made against
fundMoveIntents	number	The total amount of intended deposits (fund movements into the account), in decimal dollars. Deposits that have been registered with the payment processor but have not been submitted to the bank for processing.
disbursementIntents	number	The total amount of intended withdrawals (disbursements from the account), in decimal dollars. Withdrawals that have been registered with the payment processor but have not been processed nor initiated.
cashAvailableBalance	number	The available cash balance of all settled transactions in the account, in decimal dollars.
cashTotalBalance	number	The total cash balance in the account, including any pending transactions, in decimal dollars.
securitiesPosition	number	The total value of securities held in the account, in decimal dollars.

Sample Response

JSON

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "custodyBalances": [
    {
      "accountId": "A50648187",
      "fundMoveIntents": 200000000,
      "disbursementIntents": 1000,
      "cashAvailableBalance": 261266.75,
      "cashTotalBalance": 262290.2,
      "securitiesPosition": 16810
    }
  ]
}