Class AccountsApi

AccountsApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • AccountsApi

Constructors

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns AccountsApi

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Adds an Account capability. Account capabilities can only be managed before the onboarding application is submitted.

    Summary

    Add an Account Capability

    Throws

    Memberof

    AccountsApi

    Parameters

    Returns Promise<AxiosResponse<void, any>>

  • Creates a connected Account associated with your partner/parent Account.

    Summary

    Create a Connected Account

    Throws

    Memberof

    AccountsApi

    Parameters

    Returns Promise<AxiosResponse<Account, any>>

  • Deletes an Account capability. Account capabilities can only be managed before the onboarding application is submitted.

    Summary

    Delete an Account Capability

    Throws

    Memberof

    AccountsApi

    Parameters

    Returns Promise<AxiosResponse<void, any>>

  • Deletes a merchant Account. This cannot be undone.

    Summary

    Delete a Connected Account

    Throws

    Memberof

    AccountsApi

    Parameters

    Returns Promise<AxiosResponse<void, any>>

  • Retrieves the details of an existing Account.

    Summary

    Get an Account

    Throws

    Memberof

    AccountsApi

    Parameters

    • requestParameters: AccountsApiGetAccountRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Account, any>>

  • Updates an Account by setting the values of the provided parameters. Any parameters not provided remain unchanged.

    Summary

    Update an Account

    Throws

    Memberof

    AccountsApi

    Parameters

    Returns Promise<AxiosResponse<Account, any>>

  • Updates an Account capability. Account capabilities can only be managed before the onboarding application is submitted.

    Summary

    Update an Account Capability

    Throws

    Memberof

    AccountsApi

    Parameters

    Returns Promise<AxiosResponse<void, any>>

Generated using TypeDoc