Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProviderApi

ProviderApi - object-oriented interface

export
class

ProviderApi

extends

{BaseAPI}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

  • new ProviderApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): ProviderApi

Methods

getProvider

  • getProvider(providerId: string, options?: any): Promise<Provider>

  • Retrieve a single provider identified by providerId

    summary

    Get provider

    throws

    {RequiredError}

    memberof

    ProviderApi

    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

    ProviderApi

    Parameters

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

    Returns Promise<Provider[]>