Function AccountsApiFactory

Returns {
    addAccountCapability(requestParameters, options?) => AxiosPromise<void>;
    createConnectedAccount(requestParameters, options?) => AxiosPromise<Account>;
    deleteAccountCapability(requestParameters, options?) => AxiosPromise<void>;
    deleteConnectedAccount(requestParameters, options?) => AxiosPromise<void>;
    getAccount(requestParameters, options?) => AxiosPromise<Account>;
    listConnectedAccounts(requestParameters, options?) => AxiosPromise<ListConnectedAccounts200Response>;
    updateAccount(requestParameters, options?) => AxiosPromise<Account>;
    updateAccountCapability(requestParameters, options?) => AxiosPromise<void>;
}

• addAccountCapability:function

  • addAccountCapability(requestParameters, options?): AxiosPromise<void>

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

    Summary

    Add an Account Capability

    Throws

    Parameters

    • requestParameters: AccountsApiAddAccountCapabilityRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• createConnectedAccount:function

  • createConnectedAccount(requestParameters, options?): AxiosPromise<Account>

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

    Summary

    Create a Connected Account

    Throws

    Parameters

    • requestParameters: AccountsApiCreateConnectedAccountRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Account>

• deleteAccountCapability:function

  • deleteAccountCapability(requestParameters, options?): AxiosPromise<void>

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

    Summary

    Delete an Account Capability

    Throws

    Parameters

    • requestParameters: AccountsApiDeleteAccountCapabilityRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• deleteConnectedAccount:function

  • deleteConnectedAccount(requestParameters, options?): AxiosPromise<void>

  • Deletes a merchant Account. This cannot be undone.

    Summary

    Delete a Connected Account

    Throws

    Parameters

    • requestParameters: AccountsApiDeleteConnectedAccountRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

• getAccount:function

  • getAccount(requestParameters, options?): AxiosPromise<Account>

  • Retrieves the details of an existing Account.

    Summary

    Get an Account

    Throws

    Parameters

    • requestParameters: AccountsApiGetAccountRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Account>

• listConnectedAccounts:function

  • listConnectedAccounts(requestParameters, options?): AxiosPromise<ListConnectedAccounts200Response>

  • Returns a list of merchant Accounts. The Accounts are sorted with the most recently created appearing first. If the provided account type is merchant, the list is empty.

    Summary

    List all Connected Accounts

    Throws

    Parameters

    • requestParameters: AccountsApiListConnectedAccountsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListConnectedAccounts200Response>

• updateAccount:function

  • updateAccount(requestParameters, options?): AxiosPromise<Account>

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

    Summary

    Update an Account

    Throws

    Parameters

    • requestParameters: AccountsApiUpdateAccountRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Account>

• updateAccountCapability:function

  • updateAccountCapability(requestParameters, options?): AxiosPromise<void>

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

    Summary

    Update an Account Capability

    Throws

    Parameters

    • requestParameters: AccountsApiUpdateAccountCapabilityRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>