Function AccountsApiAxiosParamCreator

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

• addAccountCapability: ((tilled_account, AccountCapabilityCreateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, AccountCapabilityCreateParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• createConnectedAccount: ((tilled_account, CreateConnectedAccountRequest, options?) => Promise<RequestArgs>)

  • • (tilled_account, CreateConnectedAccountRequest, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• deleteAccountCapability: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• deleteConnectedAccount: ((tilled_account, options?) => Promise<RequestArgs>)

  • • (tilled_account, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getAccount: ((tilled_account, options?) => Promise<RequestArgs>)

  • • (tilled_account, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• listConnectedAccounts: ((tilled_account, metadata?, q?, sort?, type?, offset?, limit?, options?) => Promise<RequestArgs>)

  • • (tilled_account, metadata?, q?, sort?, type?, offset?, limit?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• updateAccount: ((tilled_account, AccountUpdateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, AccountUpdateParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• updateAccountCapability: ((tilled_account, id, AccountCapabilityUpdateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, AccountCapabilityUpdateParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>