Options
All
  • Public
  • Public/Protected
  • All
Menu

Module BankAccount

export
namespace

BankAccount

Index

Properties

automaticRefreshInterval

automaticRefreshInterval: number

Interval that indicates the freguency at which the account is updated. This interval is read-only and is determined by the server depending on the last use of the API. The range is between every hour, daily and monthly.

type

{number}

memberof

Account

balance

balance: Balance

Current balance. This value is set whenever the account is refreshed.

type

{Balance}

memberof

BankAccount

bankCodeNumber

bankCodeNumber: string

Bank code (i.e., routing number) (BLZ, national, 8 digits)

type

{string}

memberof

BankAccount

bic

bic: string

Business Identifier Code (BIC; ISO 9362)

type

{string}

memberof

BankAccount

currency

currency: string

Account currency (ISO 4217) (e.g., "EUR")

type

{string}

memberof

BankAccount

iban

iban: string

International Bank Account Number (IBAN; ISO 13616-1)

type

{string}

memberof

BankAccount

id

id: string

Internal ID of this account (generated value)

type

{string}

memberof

Account

kind

kind: KindEnum

An account kind is a classification of its structure and its possibilities. This is typically defined by the bank provider.

type

{string}

memberof

Account

name

name: string

Account name returned by bank provider (e.g., "Giro Account")

type

{string}

memberof

Account

number

number: string

Account number (national)

type

{string}

memberof

BankAccount

owner

owner: string

Account owner returned by bank provider (e.g., "Max Mustermann")

type

{string}

memberof

Account

providerId

providerId: string

Identifier of the provider to which this account belongs

type

{string}

memberof

Account

type

type: string

Discriminator for subtypes. At the moment only BankAccount is supported.

type

{string}

memberof

Account

Optional userDefinedName

userDefinedName: string

Account userDefinedName. This value can be set to define a custom name used in AHOI (e.g., "My Giro Account"). Can be changed by using the account resource.

type

{string}

memberof

Account