Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TransferApi

TransferApi - object-oriented interface

export
class

TransferApi

extends

{BaseAPI}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

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

Methods

postTransfer

  • postTransfer(accessId: string, accountId: string, transfer: Transfer, options?: any): Promise<TransferTask>

  • **Please note:**

    • The IBAN of the receiving account needs to exist, even if it is located in Sandbank. Otherwise the transfer will fail.
    • The returned JSON document represents the task that covers the transfer process as a result of a subsequent TAN request.
    summary

    Create a new transfer

    throws

    {RequiredError}

    memberof

    TransferApi

    Parameters

    • accessId: string

      The id of the access corresponding to accounts to be used

    • accountId: string

      The id for the account

    • transfer: Transfer

      Transfer to create

    • Optional options: any

    Returns Promise<TransferTask>