Balance

Balance

A Balance represents the financial status of an Account at a given time.

Constructor

new Balance()

Source:

Extends

Methods

(async) delete(id) → {boolean}

Delete specific record.

Inherited From:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.
Returns:
Type:
boolean

When the record is successfuly deleted returns true, otherwise false.

(async) detail(id) → {object}

Get specific record details.

Inherited From:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.
Throws:
RequestError
Returns:
Type:
object

(async) list(params) → {array}

Get a list of resources.

Inherited From:
Source:
Parameters:
Name Type Description
params Object

Receives two parameters.

Name Type Attributes Default Description
limit number <optional>
 100

Maximum number of results.
filters Object <optional>
 {}

Filters to get custom results.
Throws:
RequestError
Returns:
Type:
array

List of results.

(async) resume(session, token, link) → {object}

Resume a "pending" session that requires an OTP token. Use this function to resume sessions that returned HTTP 428 status code.

Inherited From:
Source:
Parameters:
Name Type Description
session string

UUID4 representation of a "pending" session.
token string

OTP token.
link string

UUID4 representation of the link being used.
Throws:
RequestError
Returns:
Type:
object

Response.

(async) retrieve(link, dateFrom, options) → {object}

Retrieve balances from a specific account or all accounts from a specific link.

Source:
Parameters:
Name Type Description
link string

UUID4 representation of a link Id.
dateFrom string

Required date from, format is YYYY-MM-DD
options object

Optional parameters (account, dateTo, token, saveData)
Throws:
RequestError
Returns:
Type:
object

Response