Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TaskApi

TaskApi - object-oriented interface

export
class

TaskApi

extends

{BaseAPI}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

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

  • Parameters

    • Optional configuration: Configuration
    • Default value basePath: string = BASE_PATH
    • Default value fetch: FetchAPI = portableFetch

    Returns TaskApi

Methods

getChallenge

  • getChallenge(taskId: string, options?: any): Promise<Challenge>

  • This is the third required step when executing a TAN-aware banking task (e.g., a SEPA transfer).

    summary

    Fetch task challenges

    throws

    {RequiredError}

    memberof

    TaskApi

    Parameters

    • taskId: string

      The id of the task

    • Optional options: any

    Returns Promise<Challenge>

getTask

  • getTask(taskId: string, options?: any): Promise<Task>

  • Use this to poll for status changes (e.g., steps two and five of the SEPA transfer process) or to query the state after receiving a callback from AHOI.

    summary

    Fetch state of task

    throws

    {RequiredError}

    memberof

    TaskApi

    Parameters

    • taskId: string

      The id of the task for which to retrieve the status.

    • Optional options: any

    Returns Promise<Task>

postChallengeResponse

  • postChallengeResponse(taskId: string, challengeResponse: ChallengeResponse, options?: any): Promise<Task>

  • The SEPA transfer initiated using the Transfer resource requires this starting with step four.

    summary

    Authorize a task

    throws

    {RequiredError}

    memberof

    TaskApi

    Parameters

    • taskId: string

      The id of the task

    • challengeResponse: ChallengeResponse

      The response to process

    • Optional options: any

    Returns Promise<Task>