v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Client Account Management Endpoints

account/client-accounts/balance

This endpoint returns details on the current account balance and available funds for the given Client account.

get/account/client-accounts/balance

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring required

Client account ID of customer who's balance you want to retrieve

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).

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

AccountBalancenumber

Indicates the total current account balance, including pending funds.

PendingFundsnumber

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

Reservenumber

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

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.

AvailableFundsnumber

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

OffbookBalancenumber

Indicates the portion of the account balance which is being held in an off-book account.

Currencystring

3 character currency code for the balance being returned.

Example response

{
  "Currency": "CAD",
  "Wallets": {
    "0": {
      "WalletID": "wallet_123",
      "WalletName": "Wallet 123",
      "WalletBalance": "20000.00",
      "WalletPendingBalance": "0.00",
      "Reserve": "50000.00",
      "RollingReserveNSF": "10000.00",
      "RollingReserveReturns": "1000.00",
      "OffbookBalance": "1000.00"
    }
  }
}