Options
All
  • Public
  • Public/Protected
  • All
Menu

nordigen-cf-workers

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

AccountDetailData

AccountDetailData: { account: BankAccount }

Data returned by the account detail endpoint You will most likely get all information available in the "BankAccount" type here

Type declaration

AmountValue

AmountValue: { amount: string; currency: string }

Type declaration

  • amount: string
  • currency: string

Balance

Balance: { balanceAmount: AmountValue; balanceType: "closingBooked" | "expected"; referenceDate: string }

A single account balance

Type declaration

  • balanceAmount: AmountValue
  • balanceType: "closingBooked" | "expected"
  • referenceDate: string

BalanceData

BalanceData: { balances: Balance[] }

Balance data from the Nordigen API

Type declaration

BankAccount

BankAccount: { cashAccountType: string; currency: string; iban?: undefined | string; name?: undefined | string; ownerName: string; product?: undefined | string; resourceId: string }

A bank account in any bank Please note that you might only get the account IBAN without any further information

Type declaration

  • cashAccountType: string
  • currency: string
  • Optional iban?: undefined | string
  • Optional name?: undefined | string
  • ownerName: string
  • Optional product?: undefined | string
  • resourceId: string

BookedTransaction

BookedTransaction: { additionalInformation?: undefined | string; additionalInformationStructured?: undefined | string; balanceAfterTransaction?: Balance; bankTransactionCode?: undefined | string; bookingDate: string; bookingDateTime?: undefined | string; checkId?: undefined | string; creditorAccount?: AccountReference; creditorAgent?: undefined | string; creditorId?: undefined | string; creditorName?: undefined | string; currencyExchange?: ReportExchangeRate[]; debtorAccount?: AccountReference; debtorAgent?: undefined | string; debtorName?: undefined | string; endToEndId?: undefined | string; entryReference?: undefined | string; internalTransactionId: string; mandateId?: undefined | string; merchantCategoryCode?: undefined | string; proprietaryBankTransactionCode?: undefined | string; purposeCode?: PurposeCode; remittanceInformationStructured?: undefined | string; remittanceInformationStructuredArray?: Remittance[]; remittanceInformationUnstructured?: undefined | string; remittanceInformationUnstructuredArray?: string[]; transactionAmount: Amount; transactionId?: undefined | string; ultimateCreditor?: undefined | string; ultimateDebtor?: undefined | string; valueDate?: undefined | string; valueDateTime?: undefined | string }

A financial transaction.

Type declaration

  • Optional additionalInformation?: undefined | string

    Might be used by the financial institution to transport additional transaction related information.

  • Optional additionalInformationStructured?: undefined | string

    Is used if and only if the bookingStatus entry equals "information".

  • Optional balanceAfterTransaction?: Balance

    This is the balance after this transaction. Recommended balance type is interimBooked.

  • Optional bankTransactionCode?: undefined | string

    cSpell:disable Bank transaction code as used by the financial institution and using the sub elements of this structured code defined by ISO20022. For standing order reports the following codes are applicable: "PMNT-ICDT-STDO" for credit transfers, "PMNT-IRCT-STDO" for instant credit transfers, "PMNT-ICDT-XBST" for cross-border credit transfers, "PMNT-IRCT-XBST" for cross-border real time credit transfers, "PMNT-MCOP-OTHR" for specific standing orders which have a dynamical amount to move left funds e.g. on month end to a saving account. cSpell:enable

  • bookingDate: string

    The date when an entry is posted to an account on the financial institutions books.

  • Optional bookingDateTime?: undefined | string

    The date and time when an entry is posted to an account on the financial institutions books.

  • Optional checkId?: undefined | string

    Identification of a Cheque.

  • Optional creditorAccount?: AccountReference

    The account reference of the creditor. Required if the transaction is a credit.

  • Optional creditorAgent?: undefined | string

    BICFI code of the creditor agent.

  • Optional creditorId?: undefined | string

    Identification of Creditors, e.g. a SEPA Creditor ID.

  • Optional creditorName?: undefined | string

    Name of the creditor if a "Debited" transaction.

  • Optional currencyExchange?: ReportExchangeRate[]

    An array of exchange rates used in currency exchange.

  • Optional debtorAccount?: AccountReference

    The account reference of the debtor. Required if the transaction is a debit.

  • Optional debtorAgent?: undefined | string

    BICFI code of the debtor agent.

  • Optional debtorName?: undefined | string

    Name of the debtor if a "Credited" transaction.

  • Optional endToEndId?: undefined | string

    Unique end to end ID.

  • Optional entryReference?: undefined | string

    Is the identification of the transaction as used for reference given by financial institution.

  • internalTransactionId: string

    Transaction identifier given by Nordigen.

  • Optional mandateId?: undefined | string

    Identification of Mandates, e.g. a SEPA Mandate ID.

  • Optional merchantCategoryCode?: undefined | string

    Merchant category code as defined by card issuer.

  • Optional proprietaryBankTransactionCode?: undefined | string

    Proprietary bank transaction code as used within a community or within an financial institution.

  • Optional purposeCode?: PurposeCode

    The purpose code of the transaction. Required if the transaction is a credit.

  • Optional remittanceInformationStructured?: undefined | string

    Reference as contained in the structured remittance reference structure.

  • Optional remittanceInformationStructuredArray?: Remittance[]

    An array of structured remittance reference structures.

  • Optional remittanceInformationUnstructured?: undefined | string

    Reference as contained in the unstructured remittance reference structure.

  • Optional remittanceInformationUnstructuredArray?: string[]

    Reference as contained in the unstructured remittance reference structure.

  • transactionAmount: Amount

    The amount of the transaction as billed to the account.

  • Optional transactionId?: undefined | string

    Unique transaction identifier given by financial institution.

  • Optional ultimateCreditor?: undefined | string

    Identification of the ultimate creditor.

  • Optional ultimateDebtor?: undefined | string

    Identification of the ultimate debtor.

  • Optional valueDate?: undefined | string

    The Date at which assets become available to the account owner in case of a credit.

  • Optional valueDateTime?: undefined | string

    The date and time at which assets become available to the account owner in case of a credit.

EndUserAgreement

EndUserAgreement: { accepted: string | null; access_scope: string[]; access_valid_for_days: number; created: string; id: string; institution_id: string; max_historical_days: number }

An End User Agreement

Type declaration

  • accepted: string | null
  • access_scope: string[]
  • access_valid_for_days: number
  • created: string
  • id: string
  • institution_id: string
  • max_historical_days: number

GenerateTokenResponse

GenerateTokenResponse: { access: string; access_expires: number; refresh: string; refresh_expires: number }

Type declaration

  • access: string
  • access_expires: number
  • refresh: string
  • refresh_expires: number

Institution

Institution: { bic: string; countries: string[]; id: string; logo: string; name: string; transaction_total_days: string }

A Nordigen Institution (Bank)

Type declaration

  • bic: string
  • countries: string[]
  • id: string
  • logo: string
  • name: string
  • transaction_total_days: string

PendingTransaction

PendingTransaction: Omit<BookedTransaction, "bookingDate" | "bookingDateTime">

Requisition

Requisition: { account_selection: boolean; accounts: string[]; agreement: string; created: string; id: string; institution_id: string; link: string; redirect: string; redirect_immediate: boolean; reference: string; ssn: string; status: string; user_language: string }

Nordigen Requisition

Type declaration

  • account_selection: boolean
  • accounts: string[]
  • agreement: string
  • created: string
  • id: string
  • institution_id: string
  • link: string
  • redirect: string
  • redirect_immediate: boolean
  • reference: string
  • ssn: string
  • status: string
  • user_language: string

TransactionData

TransactionData: { transactions: { booked: BookedTransaction[]; pending: PendingTransaction[] } }

Data returned by the transaction endpoint

Type declaration

Functions

Const double

  • double(value: number): number

  • Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)

    Example (es module)

     
    import { double } from 'typescript-starter'
console.log(double(4))
// => 8

    Example (commonjs)

     
    var double = require('typescript-starter').double;
console.log(double(4))
// => 8
    anothernote

    Some other value.

    Parameters

    • value: number

      Comment describing the value parameter.

    Returns number

    Comment describing the return type.

Const power

  • power(base: number, exponent: number): number

  • Raise the value of the first parameter to the power of the second using the es7 exponentiation operator (**).

    Example (es module)

     
    import { power } from 'typescript-starter'
console.log(power(2,3))
// => 8

    Example (commonjs)

     
    var power = require('typescript-starter').power;
console.log(power(2,3))
// => 8

    Parameters

    • base: number

      the base to exponentiate

    • exponent: number

      the power to which to raise the base

    Returns number

Generated using TypeDoc