Basiq.io Node.js bindings
Basiq.io API bindings for Node.js
Configuration
The API key can be found on the API Keys tab in the Basiq.io dashboard.
Require
var BasiqAPI = BasiqAPI; var apiOptions = baseURL: 'https://au-api.basiq.io' // optional auth: apiKey: 'abc123' var basiq = apiOptions;
Importing
; const apiOptions: BasiqAPIOptions = baseURL: 'https://au-api.basiq.io' // optional auth: apiKey: 'abc123' const basiq: BasiqAPI = apiOptions;
API Overview
Every resource is accessed via your basiq
instance:
// basiq.{ RESOURCE_NAME }.{ METHOD_NAME }
Every resource method returns a promise, which can be chained or used with async/await.
basiqaccounts ; // where supported { var resp: BasiqResponse = await basiqaccounts; return respbody;}
Available resources and methods
- connections
create(options: ConnectionCreateOptions)
refresh(connectionId: string)
retrieve(connectionId: string)
update(connectionId: string, options: ConnectionUpdateOptions)
delete(connectionId: string)
- accounts
retrieve(connectionId: string, accountId: string)
list(connectionId:string)
- transactions
retrieve(connectionId: string, transactionId: string)
list(connectionId: string)
- institutions
retrieve(institutionId: string)
list()
Interfaces