Money

The API endpoint provides real time snapshot of Cash Balances of an account

Results Explained

Attribute

Type

Definition

cash

object

an object containing the details of an account cash summary

cash.cashAvailableForTrade

number

an accounts buying power, this figure dictates the total amount of money that can be used for purchases. Will be reduced by pending orders

cash.cashAvailableForWithdrawal

number

an accounts withdrawal balance, this property only contains settled funds, and money that has already seasoned

cash.cashBalance

number

an accounts total cash balance, including both settled and un-settled money

cash.noBuyingPowerReason

array

cash.cashSettlement

an array of objects containing the time of when money settles as a result of a sale

cash.cashSettlement.utcTime

string

timestamp of when the pending cash amount is released due to settlement

cash.cashSettlement.cash

number

the total amount of money that is settling on the provided utcTime

cash.pendingPaymentsAmount

number

the total amount of money that is pending due to a recent deposit(s)

payments

object

an object containing account payments summary

payments.buyingPower

object

an object containing the details behind the buying power calculation based on recent deposits

payments.buyingPower.pendingDepositsAmountAvailable

number

the current buying power of an account based on recent deposit requests

payments.buyingPower.pendingDepositsAmountNotAvailable

number

recent deposits that are not included in buying power

payments.redemptions

object

an object containing

payments.redemptions.amountWithheldFromRedemptions

number

total dollar amount not included in cashAvailableForWithdrawal due to seasoning period on deposit

payments.seasoningDeposits

array

an array containing seasoning deposit objects

payments.seasoningDeposits.paymentID

string

deposit identifier

payments.seasoningDeposits.created

string

timestamp of when the deposit was created

payments.seasoningDeposits.updated

string

timestamp of the last time the deposit was updated

payments.seasoningDeposits.status

string

current status of the deposit, if in SEASONING, deposit amount will not be included in cashAvailableForWithdrawal

payments.seasoningDeposits.amount

string

amount of the deposit

payments.seasoningDeposits.currencyCode

string

currency identifier

Language
Authentication