Function AccountsApiFp

Returns {
    addAccountCapability(tilled_account, AccountCapabilityCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    createConnectedAccount(tilled_account, CreateConnectedAccountRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<Account>)>;
    deleteAccountCapability(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    deleteConnectedAccount(tilled_account, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    getAccount(tilled_account, options?) => Promise<((axios?, basePath?) => AxiosPromise<Account>)>;
    listConnectedAccounts(tilled_account, metadata?, q?, sort?, type?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListConnectedAccounts200Response>)>;
    updateAccount(tilled_account, AccountUpdateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<Account>)>;
    updateAccountCapability(tilled_account, id, AccountCapabilityUpdateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• addAccountCapability:function

  • addAccountCapability(tilled_account, AccountCapabilityCreateParams, options?): Promise<((axios?, basePath?) => 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

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • AccountCapabilityCreateParams: AccountCapabilityCreateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

• createConnectedAccount:function

  • createConnectedAccount(tilled_account, CreateConnectedAccountRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<Account>)>

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

    Summary

    Create a Connected Account

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • CreateConnectedAccountRequest: CreateConnectedAccountRequest

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Account>)>

• deleteAccountCapability:function

  • deleteAccountCapability(tilled_account, id, options?): Promise<((axios?, basePath?) => 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

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

• deleteConnectedAccount:function

  • deleteConnectedAccount(tilled_account, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Deletes a merchant Account. This cannot be undone.

    Summary

    Delete a Connected Account

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

• getAccount:function

  • getAccount(tilled_account, options?): Promise<((axios?, basePath?) => AxiosPromise<Account>)>

  • Retrieves the details of an existing Account.

    Summary

    Get an Account

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Account>)>

• listConnectedAccounts:function

  • listConnectedAccounts(tilled_account, metadata?, q?, sort?, type?, offset?, limit?, options?): Promise<((axios?, basePath?) => 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

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional metadata: {
          [key: string]: string;
      }

      `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

      • [key: string]: string

    • Optional q: string

      The partial search of text fields. Supports searching by `account.name`, `account.business_profile.legal_name`, `account.id`, `account.email`, `user.name`, `user.email`

    • Optional sort: string

      The sort parameters, value:direction. Possible values: `name`, `created_at`. Possible directions: `asc`, `desc` For example `name:asc`. Default: `created_at:desc`

    • Optional type: ListConnectedAccountsType

      Only return Connected Accounts where the type matches the specified value.

    • Optional offset: number

      The (zero-based) offset of the first item in the collection to return.

    • Optional limit: number

      The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ListConnectedAccounts200Response>)>

• updateAccount:function

  • updateAccount(tilled_account, AccountUpdateParams, options?): Promise<((axios?, basePath?) => 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

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • AccountUpdateParams: AccountUpdateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Account>)>

• updateAccountCapability:function

  • updateAccountCapability(tilled_account, id, AccountCapabilityUpdateParams, options?): Promise<((axios?, basePath?) => 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

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • AccountCapabilityUpdateParams: AccountCapabilityUpdateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>