AccStatus Property

The status of the current account.

Syntax

 account.getAccStatus(index, [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 getAccStatus([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 setAccStatus([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 status of the current account. Possible values are: AVAIL, PEND, ACTIVE.

For bank or credit card accounts (i.e., when AccServiceType is BANK or CREDITCARD), the meaning of AccStatus is as follows:

For investment accounts (i.e., when AccServiceType is INVESTMENT), the AccStatus indicates the activation status for investment statement download for the account. Possible values are the same, but the meaning is slightly different:

The index parameter specifies the index of the item in the array. The size of the array is controlled by the AccCount property.

This property is read-only and not available at design time.

Data Type

String