v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Account Endpoints

account/balance

This endpoint returns details on your current account balance and available funds.

get/account/balance

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Currencystring

3 character currency code for the currency to fetch transactions for. If this is not specified it will be defaulted to the account's local currency (generally CAD).

AsOfDatestring date

A date in ISO 8601 format (yyyy-mm-dd) representing the date for which you want to retrieve the balance. If not provided, the current balance 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

AccountBalancenumber required

Indicates the total current account balance, including pending funds.

PendingFundsnumber required

Indicates the portion of the account balance which is pending due to in-progress transactions.

Reservenumber required

Indicates the portion of the account balance which is being held as a reserve against negative balances.

RollingReserveNSFnumber

Indicates the portion of the account balance which is being held as a reserve against NSF transactions.

RollingReserveReturnsnumber

Indicates the portion of the account balance which is being held as a reserve against returned transactions.

AvailableImmediatelynumber required

Indicate the portion of the account balance that is available immediately

AvailableFundsnumber required

Indicates the portion of the account balance which is currently available for use. This is calculated by taking the AccountBalance and subtracting the PendingFunds, Reserve, RollingReserveNSF and RollingReserveReturns amounts.

Currencystring required

3 character currency code for the balance being returned.

AsOfDatestring date required

The date for which the balance is being returned.

RollupAvailableBalancestring

Represents the aggregated total available balance of all sub-accounts under this account. This is only returned if the account has sub-accounts enabled.

RollupAccountBalancestring

Represents the aggregated total account balance of all sub-accounts under this account. This is only returned if the account has sub-accounts enabled

Example response

{
  "Success": true,
  "Currency": "CAD",
  "AsOfDate": "2020-01-01",
  "RollupAvailableBalance": "1280000.00",
  "RollupAccountBalance": "18000.00"
}