v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Account Endpoints

account/balances

This endpoint returns details on your current account balances and available funds for all currencies associated with your account. Unlike /account/balance which returns a single currency, this endpoint returns an array of balances for each currency your account has records for.

get/account/balances

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

AsOfDatestring date

A date in ISO 8601 format (yyyy-mm-dd) representing the date for which you want to retrieve the balances. If not provided, the current balances will be returned.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "AccountBalances": {
    "0": {
      "AccountBalance": "20000.00",
      "PendingFunds": "5540.24",
      "SecurityDeposit": "50000.00",
      "Reserve": "50000.00",
      "AvailableImmediately": "0.00",
      "AvailableFunds": "18000.00",
      "OffbookBalance": "0.00",
      "Currency": "CAD",
      "AsOfDate": "2026-02-11",
      "VirtualAccountNumber": "12345678-01234-001",
      "RollingReserveNSF": "10000.00",
      "RollingReserveReturns": "1000.00",
      "RollupAvailableBalance": "1280000.00",
      "RollupAccountBalance": "18000.00"
    }
  }
}