RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Financial Account Balances Object

The Financial Account Balances object represents the balances for a Financial Account. This includes the account balance, available funds, pending withdrawals, and pending deposits. Balances are only returned for RocketKOR Financial Accounts.

Attributes

{currency}

object

Balances in a specific currency. The {currency} object name will be the currency code, such as USD or CAD.

accountBalance

string (number)

Balance of the Financial Account.

availableBalance

string (number)

Funds available for immediate use. This is the account balance (accountBalance) minus any pending withdrawals (pendingWithdrawalBalance). pendingDeposits are not included in availableBalance.

pendingWithdrawals

string (number)

Balance of pending withdrawals.

pendingDeposits

string (number)

Balance of pending deposits.

The Financial Account Balances Object

				
					{
  "USD": {
    "accountBalance": "1000.00",
    "availableBalance": "800.00",
    "pendingWithdrawals": "200.00",
    "pendingDeposits": "250.00"
  },
  "CAD": {
    "accountBalance": "700.00",
    "availableBalance": "600.00",
    "pendingWithdrawals": "100.00",
    "pendingDeposits": "300.00"
  }
}