Balance Property

The balance of this account, including sub-accounts.

Syntax

 account.getBalance([callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getBalance([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setBalance([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The balance of this account, which may be positive or negative. The interpretation of the sign is dependent on AccountType.

The NonInclusiveBalance special field provides the balance with sub-accounts excluded.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String