Class Client

An abstract class for communicating with a fints server. For a common implementation look at PinTanClient.

Hierarchy

Client
- PinTanClient

Index

Methods

Methods

accounts

accounts(): Promise<SEPAAccount[]>

- Defined in packages/fints/src/client.ts:30
Fetch a list of all SEPA accounts accessible by the user.

Returns Promise<SEPAAccount[]>

An array of all SEPA accounts.

balance

balance(account: SEPAAccount): Promise<Balance>

- Defined in packages/fints/src/client.ts:62
Fetch the balance for a SEPA account.

Parameters
- account: SEPAAccount
  
  The SEPA account to fetch the balance for.
Returns Promise<Balance>

The balance of the given SEPA account.

completeStatements

completeStatements(savedDialog: DialogConfig, transactionReference: string, tan: string): Promise<Statement[]>

- Defined in packages/fints/src/client.ts:146
Fetch a list of bank statements deserialized from the MT940 transmitted by the fints server.

Parameters
- savedDialog: DialogConfig
- transactionReference: string
- tan: string
Returns Promise<Statement[]>

A list of all statements in the specified range.

Protected Abstract createDialog

createDialog(dialogConfig?: DialogConfig): Dialog

- Defined in packages/fints/src/client.ts:19
Create a new dialog.

Parameters
- Optional dialogConfig: DialogConfig
Returns Dialog

Protected Abstract createRequest

createRequest(dialog: Dialog, segments: Segment<any>[], tan?: string): Request

- Defined in packages/fints/src/client.ts:23
Create a request.

Parameters
- dialog: Dialog
- segments: Segment<any>[]
- Optional tan: string
Returns Request

Private sendStatementRequest

sendStatementRequest(dialog: Dialog, segments: Segment<any>[], tan?: string): Promise<Statement[]>

- Defined in packages/fints/src/client.ts:167
Parameters
- dialog: Dialog
- segments: Segment<any>[]
- Optional tan: string
Returns Promise<Statement[]>

standingOrders

standingOrders(account: SEPAAccount): Promise<StandingOrder[]>

- Defined in packages/fints/src/client.ts:201
Fetch a list of standing orders for the given account.

Parameters
- account: SEPAAccount
  
  The account to fetch standing orders for.
Returns Promise<StandingOrder[]>

A list of all standing orders for the given account.

statements

statements(account: SEPAAccount, startDate?: Date, endDate?: Date): Promise<Statement[]>

- Defined in packages/fints/src/client.ts:110
Fetch a list of bank statements deserialized from the MT940 transmitted by the fints server.

Parameters
- account: SEPAAccount
- Optional startDate: Date
  
  The start of the range for which the statements should be fetched.
- Optional endDate: Date
  
  The end of the range for which the statements should be fetched.
Returns Promise<Statement[]>

A list of all statements in the specified range.

Generated using TypeDoc