Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QuickStartApi

QuickStartApi - object-oriented interface

export
class

QuickStartApi

extends

{BaseAPI}

Hierarchy

Index

Constructors

constructor

Methods

getProvider

  • getProvider(providerId: string, options?: any): Promise<Provider>
  • Retrieve a single provider identified by providerId

    summary

    Get provider

    throws

    {RequiredError}

    memberof

    QuickStartApi

    Parameters

    • providerId: string

      The providerId to retrieve

    • Optional options: any

    Returns Promise<Provider>

getProviders

  • getProviders(bankCode?: string, supported?: boolean, query?: string, options?: any): Promise<Provider[]>
  • Retrieve a list of bank providers. A providerid is required to create an access. To retrieve the necessary access fields, you need to query the specific provider/{providerId}. For performance reasons they are kept separate.

    summary

    List bank providers

    throws

    {RequiredError}

    memberof

    QuickStartApi

    Parameters

    • Optional bankCode: string
    • Optional supported: boolean
    • Optional query: string
    • Optional options: any

    Returns Promise<Provider[]>

postAccess

  • postAccess(accessDto: Access, options?: any): Promise<Access>
  • Create a new access and setup all associated accounts and transactions. This will also trigger the creation of monthly transaction summaries, the analysis of all accounts for recurring transactions, and the calculation of the balance forecast. If the credentials were invalid, the validation state is set accordingly. It is possible to have multiple accesses for one user.

    summary

    Create a new access

    throws

    {RequiredError}

    memberof

    QuickStartApi

    Parameters

    • accessDto: Access

      A valid BankAccess object containing the required accessFields as indicated by the provider object and the providerId.

    • Optional options: any

    Returns Promise<Access>

register

  • Registers a user with AHOI

    summary

    User registration

    throws

    {RequiredError}

    memberof

    QuickStartApi

    Parameters

    • Optional options: any

    Returns Promise<RegistrationResponse>