Class AccountService

Hierarchy

Base
- AccountService
  - JengaApiSdk

Index

Constructors

Methods

accountBalance accountFullStatement accountInquiry accountMiniStatement generateToken getConfig openingClosingAccountBalance updateConfig

Constructors

constructor

new AccountService(config: Config): AccountService
Parameters
- config: Config
Returns AccountService

Inherited from Base.constructor

Methods

accountBalance

accountBalance<T>(options: Options): Promise<T>
Account Balance

https://developer.jengaapi.io/reference/get-account-balance

This web service enables an application or service retrieve the current and available balance of an account\
Type Parameters
- T
Parameters
- options: Options
Returns Promise<T>

accountFullStatement

accountFullStatement<T>(options: Options): Promise<T>
Account Full Statement

https://developer.jengaapi.io/reference/get-account-statement-full

This web service enables the Jengi to retrieve the full set of transactions on a particular account based on a specified date range.
Type Parameters
- T
Parameters
- options: Options
Returns Promise<T>

accountInquiry

accountInquiry<T>(options: Options): Promise<T>
Account Inquiry - Bank Accounts

https://developer.jengaapi.io/reference/account-inquiry

Get account details
Type Parameters
- T
Parameters
- options: Options
Returns Promise<T>

accountMiniStatement

accountMiniStatement<T>(options: Options): Promise<T>
Account MINI Statement

https://developer.jengaapi.io/reference/get-account-statement-mini

This service will return the last (10) ten transactions of a given account number.
Type Parameters
- T
Parameters
- options: Options
Returns Promise<T>

generateToken

generateToken<AuthResponse>(): Promise<AuthResponse>
Type Parameters
- AuthResponse
Returns Promise<AuthResponse>

Inherited from Base.generateToken

getConfig

getConfig(): {
    apiKey: string;
    consumerSecret: string;
    enableAuthorization: boolean;
    enableLogging: boolean;
    env: string;
    merchantCode: string;
    privateKeyPath: string;
    verbose: boolean;
}
Gets the current configuration of the SDK

Returns {
    apiKey: string;
    consumerSecret: string;
    enableAuthorization: boolean;
    enableLogging: boolean;
    env: string;
    merchantCode: string;
    privateKeyPath: string;
    verbose: boolean;
}
- apiKey: string
- consumerSecret: string
- enableAuthorization: boolean
- enableLogging: boolean
- env: string
- merchantCode: string
- privateKeyPath: string
- verbose: boolean
Inherited from Base.getConfig

openingClosingAccountBalance

openingClosingAccountBalance<T>(options: Options): Promise<T>
Opening and Closing Account Balance

https://developer.jengaapi.io/reference/opening-and-closing-balance

This web service enables an application or service retrieve the opening and closing balance of an account for a given date
Type Parameters
- T
Parameters
- options: Options
Returns Promise<T>

updateConfig

updateConfig(config: UpdateConfig, callback?: Function): {
    apiKey: string;
    consumerSecret: string;
    enableAuthorization: boolean;
    enableLogging: boolean;
    env: string;
    merchantCode: string;
    privateKeyPath: string;
    verbose: boolean;
}
Updates the current configuration of the SDK
Parameters
- config: UpdateConfig
- callback: Function = null
Returns {
    apiKey: string;
    consumerSecret: string;
    enableAuthorization: boolean;
    enableLogging: boolean;
    env: string;
    merchantCode: string;
    privateKeyPath: string;
    verbose: boolean;
}
- apiKey: string
- consumerSecret: string
- enableAuthorization: boolean
- enableLogging: boolean
- env: string
- merchantCode: string
- privateKeyPath: string
- verbose: boolean
Inherited from Base.updateConfig

Class AccountService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: Config

Returns AccountService

Methods

accountBalance

Type Parameters

T

Parameters

options: Options

Returns Promise<T>

accountFullStatement

Type Parameters

T

Parameters

options: Options

Returns Promise<T>

accountInquiry

Type Parameters

T

Parameters

options: Options

Returns Promise<T>

accountMiniStatement

Type Parameters

T

Parameters

options: Options

Returns Promise<T>

generateToken

Type Parameters

AuthResponse

Returns Promise<AuthResponse>

getConfig

Returns { apiKey: string; consumerSecret: string; enableAuthorization: boolean; enableLogging: boolean; env: string; merchantCode: string; privateKeyPath: string; verbose: boolean; }

apiKey: string

consumerSecret: string

enableAuthorization: boolean

enableLogging: boolean

env: string

merchantCode: string

privateKeyPath: string

verbose: boolean

openingClosingAccountBalance

Type Parameters

T

Parameters

options: Options

Returns Promise<T>

updateConfig

Parameters

config: UpdateConfig

callback: Function = null

Returns { apiKey: string; consumerSecret: string; enableAuthorization: boolean; enableLogging: boolean; env: string; merchantCode: string; privateKeyPath: string; verbose: boolean; }

apiKey: string

consumerSecret: string

enableAuthorization: boolean

enableLogging: boolean

env: string

merchantCode: string

privateKeyPath: string

verbose: boolean

Settings

Member Visibility

Theme

Returns {
apiKey: string;
consumerSecret: string;
enableAuthorization: boolean;
enableLogging: boolean;
env: string;
merchantCode: string;
privateKeyPath: string;
verbose: boolean;
}

Returns {
apiKey: string;
consumerSecret: string;
enableAuthorization: boolean;
enableLogging: boolean;
env: string;
merchantCode: string;
privateKeyPath: string;
verbose: boolean;
}